API Docs

If you're new to EasyPost, our Getting Started guide will help you get up and shipping quickly.

The samples on this page are available for cURL and all of our client libraries.

If you have any questions please email support@easypost.com.

Authentication

Authentication and identification to the EasyPost API is done by providing an API Key on every request as your Basic Auth username (no password is required). EasyPost also requires that all communication with the API is secured using TLS. Requests made over HTTP or without a proper API Key will fail.

EasyPost provides two types of API Key: Test and Production. You can test all EasyPost functionality using your Test key, for free, immediately after signing up.

You can manage your API Keys from your account.

Remember to treat your API Keys as passwords and keep them secret - they should not be included in public repositories, client side code, etc.

EasyPost Objects

The EasyPost API consists of many object types. There are several attributes that are consistent across all objects:

  • id: Every EasyPost Object that can be created through the API has an id field that is used to refer to the object in other API calls. An id consists of a prefix based on the object type (e.g. Shipments have the prefix "shp_") followed by 32 hex characters. These id values may be used in many API endpoints to refer to an existing object rather than specifying the full object definition; for instance in Shipment creation, you may specify the to_address either with all fields (street1, city, zip, etc.) filled, or you may reuse an existing Address by specifying only the id field value as the matching Address's id, omitting all other fields.
  • object: Every first-class EasyPost object includes an object value. This can be useful for identifying the types of nested objects, or for cases like webhook Events which can contain many different types of result. For objects where there are many variant types, such as Fees, the object value represents the supertype, and the type represents the subtype for that object.
  • reference: Many API objects also have an optional reference field that may be assigned during creation. The reference values you assign may be used in place of id values in many API endpoints, but we recommend using the EasyPost-assigned id instead because ids are guaranteed to be unique within the system, while reference uniqueness is not enforced. If your system does not enforce uniqueness on the references you submit, this may result in the wrong one of many objects with the same reference being picked in EasyPost's handling of your API request.
  • created_at/updated_at: Most API objects also include values for created_at and updated_at. These two fields respectively specify the time the object in question was created and most recently updated. These datetime fields are formatted according to ISO 8601.

Errors

In the event of a client or server error, the response will contain the standard 4xx or 5xx respectively, accompanied by a well-formed JSON body describing the issue, e.g., a required field was omitted, a purchase failed, etc.

Each client library will encapsulate these errors and raise an exception, in addition to other exceptional cases, such as network failures. It is recommended to handle exceptions gracefully and to report any issues to support@easypost.com.

Full List of Error Codes

Error Object

attributetypespecification
codestringMachine readable description of the problem
messagestringHuman readable description of the problem
errorsFieldError arrayBreakdown of errors for specific fields in the request

FieldError Object

attributetypespecification
fieldstringField of the request that the error describes
messagestringHuman readable description of the problem

Common HTTP Status Codes

codereason-phrasedescription
200OKThe request was successful
201CreatedThe request was successful and one or more resources was created
400Bad RequestRequest not processed due to client error
401UnauthorizedAuthentication is required and has failed
402Payment RequiredLack of billing information or insufficient funds
404Not FoundThe requested resource could not be found
422Unprocessable EntityThe request was well-formed but unable to process the contained instructions

Addresses

Address objects are used to represent people, places, and organizations in a number of contexts. For example, a Shipment requires a to_address and from_address to accurately calculate rates and generate postage.

Additionally, EasyPost offers several verification tools that can be used to detect deliverability issues, correct minor errors in spelling/formatting, and determine if an Address is residential or not (which has a significant effect on Shipment rating for many carriers).

Address Object

attributetypespecification
idstringUnique identifier, begins with "adr_"
objectstring"Address"
modestringSet based on which api-key you used, either "test" or "production"
street1stringFirst line of the address
street2stringSecond line of the address
citystringCity the address is located in
statestringState or province the address is located in
zipstringZIP or postal code the address is located in
countrystringISO 3166 country code for the country the address is located in
residentialbooleanWhether or not this address would be considered residential
carrier_facilitystringThe specific designation for the address (only relevant if the address is a carrier facility)
namestringName of the person. Both name and company can be included
companystringName of the organization. Both name and company can be included
phonestringPhone number to reach the person or organization
emailstringEmail to reach the person or organization
federal_tax_idstringFederal tax identifier of the person or organization
state_tax_idstringState tax identifier of the person or organization
verificationsVerificationsThe result of any verifications requested

Verifications Object

attributetypespecification
zip4VerificationOnly applicable to US addresses - checks and sets the ZIP+4
deliveryVerification Checks that the address is deliverable and makes minor corrections to spelling/format. US addresses will also have their "residential" status checked and set.

Verification Object

attributetypespecification
successbooleanThe success of the verification
errorsFieldError arrayAll errors that caused the verification to fail
detailsVerificationDetailsExtra data related to the verification

VerificationDetails Object

attributetypespecification
latitudenumberThe latitude
longitudenumberThe longitude

Address Verification by Country

Our address verification service supports 240+ countries. See our full listing to see which verification level is available for each country. We are constantly working to expand our coverage of addresses worldwide.

Full List of Countries & Levels

POST /addresses

Create and Verify Addresses

Depending on your use case an Address can be used in many different ways. Certain carriers allow rating between two zip codes, but full addresses are required to purchase postage. It is recommended to provide as much information as possible during creation and to reuse these objects whenever possible.

Address objects can also be created inline while creating another object, for example during Shipment Creation.

Verify an Address

Verifying an Address before you ship is a great way to reduce issues with delivery.

Creating a verified Address is as simple as including an enumerated list of the verifications you'd like EasyPost to perform in the verify or verify_strict url parameters. If any of the verification checks included in the verify_strict list fail an error will be returned from the API. The example below demonstrates the most common verification: "delivery", which checks that the address is deliverable and sets its residential delivery indicator.

The most effective time to perform address verification is when your customer, or the person entering the delivery address, is present. When designing a shopping cart it is recommended to ask the shopper for their address and verify it on the spot. If verification fails, ask them to double check their input; if they confirm that their data is correct, assume they know their address more correctly than the verification process.

Create Address Request Parameters
paramexampleinfo
street1417 Montgomery StFirst line of the address
street2Floor 5Second line of the address
citySan FranciscoFull city name
stateCAState or province
zip94104ZIP or postal code
countryUSISO 3166 country code for the country the address is located in
nameHiro ProtagonistName of attention, if person. Both name and company can be included
companyEasyPostName of attention, if organization. Both name and company can be included
phone415-123-4567Phone number to reach the person or organization
emailexample@example.comEmail to reach the person or organization
residentialfalseResidential delivery indicator
carrier_facilityONDCThe specific designation for the address (only relevant if the address is a carrier facility)
federal_tax_id1234567890Federal tax identifier of the person or organization
state_tax_id9876543210State tax identifier of the person or organization
verify[delivery, zip4]The verifications to perform when creating. verify_strict takes precedence
verify_strict[delivery, zip4]The verifications to perform when creating. The failure of any of these verifications causes the whole request to fail

Create Address Example

curl -X POST https://api.easypost.com/v2/addresses \
  -u <YOUR_TEST/PRODUCTION_API_KEY>: \
  -d "address[street1]=417 MONTGOMERY ST" \
  -d "address[street2]=FLOOR 5" \
  -d "address[city]=SAN FRANCISCO" \
  -d "address[state]=CA" \
  -d "address[zip]=94104" \
  -d "address[country]=US" \
  -d "address[company]=EasyPost" \
  -d "address[phone]=415-123-4567"

        
{
  "id": "adr_a6fd5dd822c94bdfa1e3f2d28a4dbf9c",
  "object": "Address",
  "mode": "test",
  "created_at": "2015-12-21T21:33:51Z",
  "updated_at": "2015-12-21T21:33:51Z",
  "street1": "417 MONTGOMERY ST",
  "street2": "FLOOR 5",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "residential": null,
  "carrier_facility": null,
  "name": null,
  "company": "EasyPost",
  "phone": "4151234567",
  "email": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {}
}

      
curl -X POST https://api.easypost.com/v2/addresses \
  -u <YOUR_TEST/PRODUCTION_API_KEY>: \
  -d "verify[]=delivery" \
  -d "address[street1]=417 Montgomery Street" \
  -d "address[street2]=5" \
  -d "address[city]=SF" \
  -d "address[state]=CA" \
  -d "address[zip]=94104" \
  -d "address[country]=US" \
  -d "address[company]=EasyPost" \
  -d "address[phone]=415-123-4567"

        
{
  "id": "adr_3dc0df9695654f1f8a788e1c872a0769",
  "object": "Address",
  "created_at": "2015-12-22T19:28:06Z",
  "updated_at": "2015-12-22T19:28:06Z",
  "name": null,
  "company": "EasyPost",
  "street1": "417 MONTGOMERY ST",
  "street2": "FL 5",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104-110",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "delivery": {
      "success": true,
      "errors": []
    }
  }
}

      
curl -X POST https://api.easypost.com/v2/addresses \
  -u <YOUR_TEST/PRODUCTION_API_KEY>: \
  -d "verify[]=delivery" \
  -d "address[street1]=UNDELIVERABLE ST" \
  -d "address[city]=SAN FRANCISCO" \
  -d "address[state]=CA" \
  -d "address[zip]=94104" \
  -d "address[country]=US" \
  -d "address[company]=EasyPost" \
  -d "address[phone]=415-123-4567"

        
{
  "id": "adr_3618edae14874ff88d54ddfe94f21a41",
  "object": "Address",
  "created_at": "2015-12-22T19:37:23Z",
  "updated_at": "2015-12-22T19:37:23Z",
  "name": null,
  "company": "EasyPost",
  "street1": "UNDELIVERABLE ST",
  "street2": null,
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "delivery": {
      "success": false,
      "errors": [
        {"field": "address", "message": "Address not found"},
        {"field": "address", "message": "Insufficient/incorrect address data"}
      ]
    }
  }
}

      
curl -X POST https://api.easypost.com/v2/addresses \
  -u <YOUR_TEST/PRODUCTION_API_KEY>: \
  -d "verify_strict[]=delivery" \
  -d "address[street1]=UNDELIVERABLE ST" \
  -d "address[city]=SAN FRANCISCO" \
  -d "address[state]=CA" \
  -d "address[zip]=94104" \
  -d "address[country]=US" \
  -d "address[company]=EasyPost" \
  -d "address[phone]=415-123-4567"

        
{
  "error": {
    "code": "ADDRESS.VERIFY.FAILURE",
    "message": "Address Not Found.  ",
    "errors": []
  }
}

      
GET /addresses/:id

Retrieve a Address

An Address can be retrieved by its id.

Retrieve Address Example

curl -X GET https://api.easypost.com/v2/addresses/adr_... \
  -u <YOUR_TEST/PRODUCTION_API_KEY>:

        
{
  "id": "adr_a6fd5dd822c94bdfa1e3f2d28a4dbf9b",
  "object": "Address",
  "mode": "test",
  "created_at": "2015-12-21T21:33:51Z",
  "updated_at": "2015-12-21T21:33:51Z",
  "street1": "417 MONTGOMERY ST",
  "street2": "FLOOR 5",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "residential": null,
  "carrier_facility": null,
  "name": null,
  "company": "EasyPost",
  "phone": "4151234567",
  "email": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {},
}

      

Parcels

Parcel objects represent the physical container being shipped. Dimensions can be supplied either as length, width, and height dimensions, or a predefined_package string. Only weight is required, but since many carriers charge different rates for packages with large dimensions, we strongly recommend including all dimensions if available.

Weights are in OUNCES (OZ) and go to one decimal point.

Dimensions are in INCHES (IN) and go to one decimal point.

Parcel Object

attributetypespecification
idstringUnique, begins with "prcl_"
objectstring"Parcel"
modestring"test" or "production"
lengthfloat (inches)Required if width and/or height are present
widthfloat (inches)Required if length and/or height are present
heightfloat (inches)Required if length and/or width are present
predefined_packagestringOptional, one of our predefined_packages
weightfloat (oz)Always required
created_atdatetime
updated_atdatetime

Predefined Packages

If you provide a predefined_package the associated Shipment will fetch rates from carriers for which that is a valid predefined_package. Some carriers share predefined_package names. If you wish to restrict your rating to a specific carrier, we recommend passing the carrier_accounts field when creating a Shipment.

Use Predefined Packages with weight only. Dimensions are already defined so they're unnecessary.

APC

No predefined packages for APC.

    Aramex

    No predefined packages for Aramex.

      Asendia

      No predefined packages for Asendia.

        Australia Post

        No predefined packages for Australia Post.

          Bluedart

          No predefined packages for Bluedart.

            Boxberry

            No predefined packages for Boxberry.

              Cainiao

              No predefined packages for Cainiao.

                Canada Post

                No predefined packages for Canada Post.

                  Canpar

                  No predefined packages for Canpar.

                    China Post

                    No predefined packages for China Post.

                      Chronopost

                      No predefined packages for Chronopost.

                        Colis Privé

                        No predefined packages for Colis Privé.

                          Colissimo

                          No predefined packages for Colissimo.

                            Correios

                            No predefined packages for Correios.

                              Correos Costa Rica

                              No predefined packages for Correos Costa Rica.

                                Delhivery

                                No predefined packages for Delhivery.

                                  Deliv

                                  No predefined packages for Deliv.

                                    Deutsche Post

                                    No predefined packages for Deutsche Post.

                                      DHL Express
                                      • JumboDocument
                                      • JumboParcel
                                      • Document
                                      • DHLFlyer
                                      • Domestic
                                      • ExpressDocument
                                      • DHLExpressEnvelope
                                      • JumboBox
                                      • JumboJuniorDocument
                                      • JuniorJumboBox
                                      • JumboJuniorParcel
                                      • OtherDHLPackaging
                                      • Parcel
                                      • YourPackaging
                                      DHL Freight

                                      No predefined packages for DHL Freight.

                                        DHL Germany

                                        No predefined packages for DHL Germany.

                                          DHL Global Mail
                                          • Letter
                                          • Flat
                                          • BPM
                                          • Parcel
                                          DHL GM International
                                            Dicom

                                            No predefined packages for Dicom.

                                              Dominos

                                              No predefined packages for Dominos.

                                                DPD

                                                No predefined packages for DPD.

                                                  DPD UK
                                                  • Parcel
                                                  • Pallet
                                                  • ExpressPak
                                                  • FreightParcel
                                                  • Freight
                                                  EC Firstclass

                                                  No predefined packages for EC Firstclass.

                                                    Ecom Express

                                                    No predefined packages for Ecom Express.

                                                      EMS

                                                      No predefined packages for EMS.

                                                        Fastway
                                                        • Parcel
                                                        • Satchel
                                                        FedEx
                                                        • FedExEnvelope
                                                        • FedExBox
                                                        • FedExPak
                                                        • FedExTube
                                                        • FedEx10kgBox
                                                        • FedEx25kgBox
                                                        • FedExSmallBox
                                                        • FedExMediumBox
                                                        • FedExLargeBox
                                                        • FedExExtraLargeBox
                                                        FedEx Mailview

                                                        No predefined packages for FedEx Mailview.

                                                          FedEx UK

                                                          No predefined packages for FedEx UK.

                                                            FedEx SmartPost

                                                            No predefined packages for FedEx SmartPost.

                                                              Flyt Express

                                                              No predefined packages for Flyt Express.

                                                                Globegistics

                                                                No predefined packages for Globegistics.

                                                                  GLS

                                                                  No predefined packages for GLS.

                                                                    GSO

                                                                    No predefined packages for GSO.

                                                                      Hong Kong Post

                                                                      No predefined packages for Hong Kong Post.

                                                                        IMEX
                                                                        • Pak
                                                                        • Box
                                                                        • Tube
                                                                        • CustomerSuppliedPackaging
                                                                        • Envelope
                                                                        • NonStandardContainer
                                                                        • LargePackage
                                                                        • Barrel
                                                                        • Bottle
                                                                        • Case
                                                                        • Carton
                                                                        • Other
                                                                        India Post

                                                                        No predefined packages for India Post.

                                                                          Interlink Express
                                                                          • Parcel
                                                                          • Pallet
                                                                          • ExpressPak
                                                                          • FreightParcel
                                                                          • Freight
                                                                          Israel Post

                                                                          No predefined packages for Israel Post.

                                                                            JP Post

                                                                            No predefined packages for JP Post.

                                                                              La Poste

                                                                              No predefined packages for La Poste.

                                                                                LaserShip
                                                                                • Box
                                                                                • Tube
                                                                                • Pak
                                                                                • Envelope
                                                                                • Custom
                                                                                Latvijas Pasts

                                                                                No predefined packages for Latvijas Pasts.

                                                                                  Liefery
                                                                                  • SmallParcel
                                                                                  • MediumParcel
                                                                                  • LargeParcel
                                                                                  • ExtraLargeParcel
                                                                                  LSO

                                                                                  No predefined packages for LSO.

                                                                                    Nanjing Woyuan

                                                                                    No predefined packages for Nanjing Woyuan.

                                                                                      Network4

                                                                                      No predefined packages for Network4.

                                                                                        NZ Courier Post
                                                                                        • A4BUBBLETRACKPAK
                                                                                        • A4TRACKPAK
                                                                                        • A5BUBBLETRACKPAK
                                                                                        • A5TRACKPAK
                                                                                        • DLETRACKPAK
                                                                                        • ECOA5TRACKPAK
                                                                                        • ECODLETRACKPAK
                                                                                        • ECOFOOLSCAPTRACKPAK
                                                                                        • FOOLSCAPTRACKPAK
                                                                                        • LINEFLOWTRACKPAK
                                                                                        • XTRALARGETRACKPAK
                                                                                        New Zealand Post

                                                                                        No predefined packages for New Zealand Post.

                                                                                          Norco

                                                                                          No predefined packages for Norco.

                                                                                            Nova Poshta

                                                                                            No predefined packages for Nova Poshta.

                                                                                              OnTrac
                                                                                              • Letter
                                                                                              OnTrac DirectPost

                                                                                              No predefined packages for OnTrac DirectPost.

                                                                                                Orange DS

                                                                                                No predefined packages for Orange DS.

                                                                                                  Parcelforce

                                                                                                  No predefined packages for Parcelforce.

                                                                                                    POS Malaysia

                                                                                                    No predefined packages for POS Malaysia.

                                                                                                      Postmates

                                                                                                      No predefined packages for Postmates.

                                                                                                        PostNL
                                                                                                        • Parcel
                                                                                                        • Letter
                                                                                                        PostNord

                                                                                                        No predefined packages for PostNord.

                                                                                                          Purolator
                                                                                                          • CustomerPackaging
                                                                                                          • ExpressPack
                                                                                                          • ExpressBox
                                                                                                          • ExpressEnvelope
                                                                                                          R+L Carriers

                                                                                                          No predefined packages for R+L Carriers.

                                                                                                            Royal Mail
                                                                                                            • Letter
                                                                                                            • LargeLetter
                                                                                                            • SmallParcel
                                                                                                            • MediumParcel
                                                                                                            RR Donnelley

                                                                                                            No predefined packages for RR Donnelley.

                                                                                                              Singapore Post

                                                                                                              No predefined packages for Singapore Post.

                                                                                                                SMSA Express

                                                                                                                No predefined packages for SMSA Express.

                                                                                                                  Spee-Dee

                                                                                                                  No predefined packages for Spee-Dee.

                                                                                                                    TNT Express
                                                                                                                    • Letter
                                                                                                                    • Parcel
                                                                                                                    Uber RUSH

                                                                                                                    No predefined packages for Uber RUSH.

                                                                                                                      UPS
                                                                                                                      • UPSLetter
                                                                                                                      • UPSExpressBox
                                                                                                                      • UPS25kgBox
                                                                                                                      • UPS10kgBox
                                                                                                                      • Tube
                                                                                                                      • Pak
                                                                                                                      • Pallet
                                                                                                                      • SmallExpressBox
                                                                                                                      • MediumExpressBox
                                                                                                                      • LargeExpressBox
                                                                                                                      UPS Mail Innovations

                                                                                                                      No predefined packages for UPS Mail Innovations.

                                                                                                                        • Card
                                                                                                                        • Letter
                                                                                                                        • Flat
                                                                                                                        • Parcel
                                                                                                                        • LargeParcel
                                                                                                                        • IrregularParcel
                                                                                                                        • FlatRateEnvelope
                                                                                                                        • FlatRateLegalEnvelope
                                                                                                                        • FlatRatePaddedEnvelope
                                                                                                                        • FlatRateGiftCardEnvelope
                                                                                                                        • FlatRateWindowEnvelope
                                                                                                                        • FlatRateCardboardEnvelope
                                                                                                                        • SmallFlatRateEnvelope
                                                                                                                        • SmallFlatRateBox
                                                                                                                        • MediumFlatRateBox
                                                                                                                        • LargeFlatRateBox
                                                                                                                        • RegionalRateBoxA
                                                                                                                        • RegionalRateBoxB
                                                                                                                        • LargeFlatRateBoardGameBox
                                                                                                                        Yanwen

                                                                                                                        No predefined packages for Yanwen.

                                                                                                                          Yodel

                                                                                                                          No predefined packages for Yodel.

                                                                                                                            Yun Express

                                                                                                                            No predefined packages for Yun Express.

                                                                                                                              POST /parcels

                                                                                                                              Create a Parcel

                                                                                                                              Include the weight, and either a predefined_package or length, width and height if applicable.

                                                                                                                              Create Parcel Request Parameters
                                                                                                                              paramexample
                                                                                                                              length20.2
                                                                                                                              width10.9
                                                                                                                              height5
                                                                                                                              weight65.9

                                                                                                                              Create Parcel Example

                                                                                                                              curl -X POST https://api.easypost.com/v2/parcels \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'parcel[length]=20.2' \
                                                                                                                                -d 'parcel[width]=10.9' \
                                                                                                                                -d 'parcel[height]=5' \
                                                                                                                                -d 'parcel[weight]=65.9'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "prcl_WDv2VzHp",
                                                                                                                                "object": "Parcel",
                                                                                                                                "length": 20.2,
                                                                                                                                "width": 10.9,
                                                                                                                                "height": 5.0,
                                                                                                                                "predefined_package": null,
                                                                                                                                "weight": 65.9,
                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    
                                                                                                                              GET /parcels/:id

                                                                                                                              Retrieve a Parcel

                                                                                                                              Get a Parcel by its id. In general you should not need to use this in your automated solution. A Parcel's id can be inlined into the creation call to other objects. This allows you to only create one Parcel for each package you will be using.

                                                                                                                              Retrieve Parcel Example

                                                                                                                              curl -X GET https://api.easypost.com/v2/parcels/prcl_... \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "prcl_WDv2VzHp",
                                                                                                                                "object": "Parcel",
                                                                                                                                "length": 20.2,
                                                                                                                                "width": 10.9,
                                                                                                                                "height": 5.0,
                                                                                                                                "predefined_package": null,
                                                                                                                                "weight": 65.9,
                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    

                                                                                                                              Insurances

                                                                                                                              An Insurance object represents insurance for packages purchased both va the EasyPost API as well as shipments purchased through third parties and later registered with EasyPost. An Insurance is created automatically whenever you buy a Shipment through EasyPost and pass insurance options during the Buy call or in a later call to Insure a Shipment.

                                                                                                                              Insurance purchased through the Shipment Buy or Insure endpoints is immediately insured - there is no possibility of rejection based on tracking information, as the package was just created. On the other hand, Insurance purchased on shipments purchased outside of EasyPost requires creation with a tracking code so that EasyPost may confirm the package existence and current shipping status at the time of purchase.

                                                                                                                              Standalone insurance is created in a pending state to help distinguish it from insurance purchased for an EasyPost Shipment. Both kinds of Insurance use the Tracking system to receive periodic updates, and will report those updates to any appropriate Webhooks on file. Standalone insurance will cancel itself if the tracking information for the given tracking code shows evidence of having been shipped anytime before the insurance was purchased.

                                                                                                                              Unlike Shipments within EasyPost, Insurance objects register To and From Address objects according to the destination and ship-from locations of the package. This means that a Shipment with "is_return: true" actually ships to the listed From Address. Insurance does not have a concept of "is_return", so all insurance records refer to their true package destination as "to_address", regardless of whether or not the shipment is a return.

                                                                                                                              Insurance Object

                                                                                                                              attributetypespecification
                                                                                                                              idstringUnique identifier, begins with "ins_"
                                                                                                                              objectstring"Insurance"
                                                                                                                              modestring"test" or "production"
                                                                                                                              referencestringThe unique reference for this Insurance, if any
                                                                                                                              amountstringUSD value of insured goods with sub-cent precision
                                                                                                                              providerstringThe insurance provider used by EasyPost
                                                                                                                              provider_idstringAn identifying number for some insurance providers used by EasyPost
                                                                                                                              shipment_idstringThe ID of the Shipment in EasyPost, if postage was purchased via EasyPost
                                                                                                                              tracking_codestringThe tracking code of either the shipment within EasyPost, or provided by you during creation
                                                                                                                              statusstringThe current status of the insurance, possible values are "new", "pending", "purchased", "failed", or "cancelled"
                                                                                                                              trackerTrackerThe associated Tracker object
                                                                                                                              to_addressAddressThe associated Address object for destination
                                                                                                                              from_addressAddressThe associated Address object for origin
                                                                                                                              feeFeeThe associated InsuranceFee object if any
                                                                                                                              messagesArray of stringsThe list of errors encountered during attempted purchase of the insurance
                                                                                                                              created_atdatetime
                                                                                                                              updated_atdatetime
                                                                                                                              POST /insurances

                                                                                                                              Create an Insurance

                                                                                                                              An Insurance created via this endpoint must belong to a shipment purchased outside of EasyPost. Insurance for Shipments created within EasyPost must be created via the Shipment Buy or Insure endpoints. When creating Insurance for a non-EasyPost shipment, you must provide to_address, from_address, tracking_code, and amount information. Optionally, you can provide the carrier parameter, which will help EasyPost identify the carrier the package was shipped with. If no carrier is provided, EasyPost will attempt to determine the carrier based on the tracking_code provided. Providing a carrier parameter is recommended, since some tracking_codes are ambiguous and may match with more than one carrier. In addition, not having to auto-match the carrier will significantly speed up the response time.

                                                                                                                              Create Insurance Request Parameters
                                                                                                                              paramexampleinfo
                                                                                                                              to_addressAddressThe actual destination of the package to be insured
                                                                                                                              from_addressAddressThe actual origin of the package to be insured
                                                                                                                              tracking_code9400110898825022579493The tracking code associated with the non-EasyPost-purchased package you'd like to insure
                                                                                                                              referenceexternal-order-493Optional. A unique value that may be used in place of ID when doing Retrieve calls for this insurance
                                                                                                                              amount"$100.00"The USD value of contents you would like to insure. Currently the maximum is between $5000 and $10000 depending on insurer
                                                                                                                              carrierUSPSThe carrier associated with the tracking_code you provided. The carrier will get auto-detected if none is provided

                                                                                                                              Create Insurance Example

                                                                                                                              curl -X POST https://api.easypost.com/v2/insurances \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'insurance[to_address][id]=adr_...' \
                                                                                                                                -d 'insurance[from_address][id]=adr_...' \
                                                                                                                                -d 'insurance[tracking_code]=9400110898825022579493' \
                                                                                                                                -d 'insurance[carrier]=USPS' \
                                                                                                                                -d 'insurance[reference]=insuranceRef1' \
                                                                                                                                -d 'insurance[amount]=100.00'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "ins_...",
                                                                                                                                "object": "Insurance",
                                                                                                                                "mode": "test",
                                                                                                                                "reference": null,
                                                                                                                                "status": "pending",
                                                                                                                                "amount": "101.00000",
                                                                                                                                "provider": "pip",
                                                                                                                                "provider_id": 1,
                                                                                                                                "to_address": {
                                                                                                                                  "id": "adr_...",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "updated_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "name": "DR. STEVE BRULE",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N HARBOR DR",
                                                                                                                                  "street2": "",
                                                                                                                                  "city": "REDONDO BEACH",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "90277-2506",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "3108085555",
                                                                                                                                  "email": null,
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": false,
                                                                                                                                  "federal_tax_id": null,
                                                                                                                                  "state_tax_id": null,
                                                                                                                                  "verifications": {
                                                                                                                                    "delivery": {
                                                                                                                                      "success": true,
                                                                                                                                      "errors": [],
                                                                                                                                      "details": { "latitude": 33.84446, "longitude": -118.39275 }
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "id": "adr_...",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "updated_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "name": null,
                                                                                                                                  "company": "EASYPOST",
                                                                                                                                  "street1": "417 MONTGOMERY ST FL 5",
                                                                                                                                  "street2": "",
                                                                                                                                  "city": "SAN FRANCISCO",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "94104",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4155555555",
                                                                                                                                  "email": null,
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": false,
                                                                                                                                  "federal_tax_id": null,
                                                                                                                                  "state_tax_id": null,
                                                                                                                                  "verifications": {
                                                                                                                                    "delivery": {
                                                                                                                                      "success": true,
                                                                                                                                      "errors": [],
                                                                                                                                      "details": { "longitude": -122.0, "latitude": 37.0 }
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                "shipment_id": null,
                                                                                                                                "tracker": {
                                                                                                                                  "id": "trk_...",
                                                                                                                                  "object": "Tracker",
                                                                                                                                  "mode": "test",
                                                                                                                                  "tracking_code": "EZ2000000002",
                                                                                                                                  "status": "in_transit",
                                                                                                                                  "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "updated_at": "2016-07-22T03:09:34Z",
                                                                                                                                  "signed_by": null,
                                                                                                                                  "weight": null,
                                                                                                                                  "est_delivery_date": "2014-08-27T00:00:00Z",
                                                                                                                                  "shipment_id": "",
                                                                                                                                  "carrier": "USPS",
                                                                                                                                  "tracking_details": [],
                                                                                                                                  "carrier_detail": {
                                                                                                                                    "object": "CarrierDetail",
                                                                                                                                    "service": "First-Class Package Service",
                                                                                                                                    "container_type": null,
                                                                                                                                    "est_delivery_date_local": null,
                                                                                                                                    "est_delivery_time_local": null,
                                                                                                                                    "origin_location": "HOUSTON TX, 77001",
                                                                                                                                    "destination_location": "CHARLESTON SC, 29401"
                                                                                                                                  },
                                                                                                                                  "public_url": "https://track.easypost.com/djE...",
                                                                                                                                  "fees": []
                                                                                                                                },
                                                                                                                                "tracking_code": "EZ2000000002",
                                                                                                                                "fee": {
                                                                                                                                  "object": "Fee",
                                                                                                                                  "type": "InsuranceFee",
                                                                                                                                  "amount": "1.01000",
                                                                                                                                  "charged": true,
                                                                                                                                  "refunded": false
                                                                                                                                },
                                                                                                                                "messages": [],
                                                                                                                                "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                "updated_at": "2016-07-22T00:10:35Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    
                                                                                                                              GET /insurances

                                                                                                                              Retrieve a list of Insurances

                                                                                                                              The Insurance List is a paginated list of all Insurance objects associated with the given API Key. It accepts a variety of parameters which can be used to modify the scope. The has_more attribute indicates whether or not additional pages can be requested. The recommended way of paginating is to use either the before_id or after_id parameter to specify where the next page begins.

                                                                                                                              Retrieve a list of Insurances Request Parameters
                                                                                                                              paramexampleinfo
                                                                                                                              before_idins_c777edb5bb284cOptional pagination parameter. Only records created before the given ID will be included. May not be used with after_id
                                                                                                                              after_idins_c999edb5bb284cOptional pagination parameter. Only records created after the given ID will be included. May not be used with before_id
                                                                                                                              start_datetime2016-01-02T00:00:00ZOnly return records created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
                                                                                                                              end_datetime2016-01-02T00:00:00ZOnly return records created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
                                                                                                                              page_size30The number of records to return on each page. The maximum value is 100, and default is 20.

                                                                                                                              Retrieve a list of Insurance Example

                                                                                                                              curl -X GET https://api.easypost.com/v2/insurances \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'page_size=2' \
                                                                                                                                -d 'start_datetime=2016-01-02T08:50:00Z'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "insurances": [
                                                                                                                                  {
                                                                                                                                    "id": "ins_...",
                                                                                                                                    "object": "Insurance",
                                                                                                                                    "mode": "test",
                                                                                                                                    "reference": null,
                                                                                                                                    "status": "pending",
                                                                                                                                    "amount": "101.00000",
                                                                                                                                    "provider": "pip",
                                                                                                                                    "provider_id": 1,
                                                                                                                                    "to_address": {
                                                                                                                                      "id": "adr_...",
                                                                                                                                      "object": "Address",
                                                                                                                                      "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                      "updated_at": "2016-07-22T00:09:34Z",
                                                                                                                                      "name": "DR. STEVE BRULE",
                                                                                                                                      "company": null,
                                                                                                                                      "street1": "179 N HARBOR DR",
                                                                                                                                      "street2": "",
                                                                                                                                      "city": "REDONDO BEACH",
                                                                                                                                      "state": "CA",
                                                                                                                                      "zip": "90277-2506",
                                                                                                                                      "country": "US",
                                                                                                                                      "phone": "3108085555",
                                                                                                                                      "email": null,
                                                                                                                                      "mode": "test",
                                                                                                                                      "carrier_facility": null,
                                                                                                                                      "residential": false,
                                                                                                                                      "federal_tax_id": null,
                                                                                                                                      "state_tax_id": null,
                                                                                                                                      "verifications": {
                                                                                                                                        "delivery": {
                                                                                                                                          "success": true,
                                                                                                                                          "errors": [],
                                                                                                                                          "details": { "latitude": 33.84446, "longitude": -118.39275 }
                                                                                                                                        }
                                                                                                                                      }
                                                                                                                                    },
                                                                                                                                    "from_address": {
                                                                                                                                      "id": "adr_...",
                                                                                                                                      "object": "Address",
                                                                                                                                      "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                      "updated_at": "2016-07-22T00:09:34Z",
                                                                                                                                      "name": null,
                                                                                                                                      "company": "EASYPOST",
                                                                                                                                      "street1": "417 MONTGOMERY ST FL 5",
                                                                                                                                      "street2": "",
                                                                                                                                      "city": "SAN FRANCISCO",
                                                                                                                                      "state": "CA",
                                                                                                                                      "zip": "94104",
                                                                                                                                      "country": "US",
                                                                                                                                      "phone": "4155555555",
                                                                                                                                      "email": null,
                                                                                                                                      "mode": "test",
                                                                                                                                      "carrier_facility": null,
                                                                                                                                      "residential": false,
                                                                                                                                      "federal_tax_id": null,
                                                                                                                                      "state_tax_id": null,
                                                                                                                                      "verifications": {
                                                                                                                                        "delivery": {
                                                                                                                                          "success": true,
                                                                                                                                          "errors": [],
                                                                                                                                          "details": { "longitude": -122.0, "latitude": 37.0 }
                                                                                                                                        }
                                                                                                                                      }
                                                                                                                                    },
                                                                                                                                    "shipment_id": null,
                                                                                                                                    "tracker": {
                                                                                                                                      "id": "trk_...",
                                                                                                                                      "object": "Tracker",
                                                                                                                                      "mode": "test",
                                                                                                                                      "tracking_code": "EZ2000000002",
                                                                                                                                      "status": "in_transit",
                                                                                                                                      "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                      "updated_at": "2016-07-22T03:09:34Z",
                                                                                                                                      "signed_by": null,
                                                                                                                                      "weight": null,
                                                                                                                                      "est_delivery_date": "2014-08-27T00:00:00Z",
                                                                                                                                      "shipment_id": "",
                                                                                                                                      "carrier": "USPS",
                                                                                                                                      "tracking_details": [],
                                                                                                                                      "carrier_detail": {
                                                                                                                                        "object": "CarrierDetail",
                                                                                                                                        "service": "First-Class Package Service",
                                                                                                                                        "container_type": null,
                                                                                                                                        "est_delivery_date_local": null,
                                                                                                                                        "est_delivery_time_local": null,
                                                                                                                                        "origin_location": "HOUSTON TX, 77001",
                                                                                                                                        "destination_location": "CHARLESTON SC, 29401"
                                                                                                                                      },
                                                                                                                                      "public_url": "https://track.easypost.com/djE...",
                                                                                                                                      "fees": []
                                                                                                                                    },
                                                                                                                                    "tracking_code": "EZ2000000002",
                                                                                                                                    "fee": {
                                                                                                                                      "object": "Fee",
                                                                                                                                      "type": "InsuranceFee",
                                                                                                                                      "amount": "1.01000",
                                                                                                                                      "charged": true,
                                                                                                                                      "refunded": true
                                                                                                                                    },
                                                                                                                                    "messages": [
                                                                                                                                      "The tracker entered the mailstream before insurance was purchased."
                                                                                                                                    ],
                                                                                                                                    "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                    "updated_at": "2016-07-22T00:10:35Z"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "has_more": true
                                                                                                                              }
                                                                                                                              
                                                                                                                              
                                                                                                                              
                                                                                                                                    
                                                                                                                              GET /insurances/:id

                                                                                                                              Retrieve an Insurance

                                                                                                                              Retrieve an Insurance by id.

                                                                                                                              Retrieve Insurance Request Parameters
                                                                                                                              paramexampleinfo
                                                                                                                              idins_ddd0ae35aa283cab1Unique, starts with "ins_"

                                                                                                                              Retrieve Insurance Example

                                                                                                                              curl -X GET https://easypost.com/api/v2/insurance/ins_... \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "ins_...",
                                                                                                                                "object": "Insurance",
                                                                                                                                "mode": "test",
                                                                                                                                "reference": null,
                                                                                                                                "status": "pending",
                                                                                                                                "amount": "101.00000",
                                                                                                                                "provider": "pip",
                                                                                                                                "provider_id": 1,
                                                                                                                                "to_address": {
                                                                                                                                  "id": "adr_...",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "updated_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "name": "DR. STEVE BRULE",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N HARBOR DR",
                                                                                                                                  "street2": "",
                                                                                                                                  "city": "REDONDO BEACH",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "90277-2506",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "3108085555",
                                                                                                                                  "email": null,
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": false,
                                                                                                                                  "federal_tax_id": null,
                                                                                                                                  "state_tax_id": null,
                                                                                                                                  "verifications": {
                                                                                                                                    "delivery": {
                                                                                                                                      "success": true,
                                                                                                                                      "errors": [],
                                                                                                                                      "details": { "latitude": 33.84446, "longitude": -118.39275 }
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "id": "adr_...",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "updated_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "name": null,
                                                                                                                                  "company": "EASYPOST",
                                                                                                                                  "street1": "417 MONTGOMERY ST FL 5",
                                                                                                                                  "street2": "",
                                                                                                                                  "city": "SAN FRANCISCO",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "94104",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4155555555",
                                                                                                                                  "email": null,
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": false,
                                                                                                                                  "federal_tax_id": null,
                                                                                                                                  "state_tax_id": null,
                                                                                                                                  "verifications": {
                                                                                                                                    "delivery": {
                                                                                                                                      "success": true,
                                                                                                                                      "errors": [],
                                                                                                                                      "details": { "longitude": -122.0, "latitude": 37.0 }
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                "shipment_id": null,
                                                                                                                                "tracker": {
                                                                                                                                  "id": "trk_...",
                                                                                                                                  "object": "Tracker",
                                                                                                                                  "mode": "test",
                                                                                                                                  "tracking_code": "EZ2000000002",
                                                                                                                                  "status": "in_transit",
                                                                                                                                  "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                  "updated_at": "2016-07-22T03:09:34Z",
                                                                                                                                  "signed_by": null,
                                                                                                                                  "weight": null,
                                                                                                                                  "est_delivery_date": "2014-08-27T00:00:00Z",
                                                                                                                                  "shipment_id": "",
                                                                                                                                  "carrier": "USPS",
                                                                                                                                  "tracking_details": [],
                                                                                                                                  "carrier_detail": {
                                                                                                                                    "object": "CarrierDetail",
                                                                                                                                    "service": "First-Class Package Service",
                                                                                                                                    "container_type": null,
                                                                                                                                    "est_delivery_date_local": null,
                                                                                                                                    "est_delivery_time_local": null,
                                                                                                                                    "origin_location": "HOUSTON TX, 77001",
                                                                                                                                    "destination_location": "CHARLESTON SC, 29401"
                                                                                                                                  },
                                                                                                                                  "public_url": "https://track.easypost.com/djE...",
                                                                                                                                  "fees": []
                                                                                                                                },
                                                                                                                                "tracking_code": "EZ2000000002",
                                                                                                                                "fee": {
                                                                                                                                  "object": "Fee",
                                                                                                                                  "type": "InsuranceFee",
                                                                                                                                  "amount": "1.01000",
                                                                                                                                  "charged": true,
                                                                                                                                  "refunded": true
                                                                                                                                },
                                                                                                                                "messages": [],
                                                                                                                                "created_at": "2016-07-22T00:09:34Z",
                                                                                                                                "updated_at": "2016-07-22T00:10:35Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    

                                                                                                                              Shipments

                                                                                                                              The workhorse of the EasyPost API, a Shipment is made up of a "to" and "from" Address, the Parcel being shipped, and any customs forms required for international deliveries. Once created a Shipment object is used to retrieve shipping Rates and purchase a label.

                                                                                                                              A Shipment created with a valid to_address, from_address, and parcel will automatically populate its rates attribute.

                                                                                                                              Note: USPS Commercial Plus Prices show up in the Production API only, not in Test mode.

                                                                                                                              Shipment Object

                                                                                                                              attributetypespecification
                                                                                                                              idstringUnique, begins with "shp_"
                                                                                                                              objectstring"Shipment"
                                                                                                                              referencestringAn optional field that may be used in place of id in other API endpoints
                                                                                                                              modestring"test" or "production"
                                                                                                                              to_addressAddressThe destination address
                                                                                                                              from_addressAddressThe origin address
                                                                                                                              return_addressAddressThe shipper's address, defaults to from_address
                                                                                                                              buyer_addressAddressThe buyer's address, defaults to to_address
                                                                                                                              parcelParcelThe dimensions and weight of the package
                                                                                                                              customs_infoCustomsInfoInformation for the processing of customs
                                                                                                                              scan_formScanFormDocument created to manifest and scan multiple shipments
                                                                                                                              formsForm arrayAll associated Form objects
                                                                                                                              insuranceInsuranceThe associated Insurance object
                                                                                                                              ratesRate arrayAll associated Rate objects
                                                                                                                              selected_rateRateThe specific rate purchased for the shipment, or null if unpurchased or purchased through another mechanism
                                                                                                                              postage_labelPostageLabelThe associated PostageLabel object
                                                                                                                              messagesMessage arrayAny carrier errors encountered during rating, discussed in more depth below
                                                                                                                              optionsOptionsAll of the options passed to the shipment, discussed in more depth below
                                                                                                                              is_returnbooleanSet true to create as a return, discussed in more depth below
                                                                                                                              tracking_codestringIf purchased, the tracking code will appear here as well as within the Tracker object
                                                                                                                              usps_zonestringThe USPS zone of the shipment, if purchased with USPS
                                                                                                                              statusstringThe current tracking status of the shipment
                                                                                                                              trackerTrackerThe associated Tracker object
                                                                                                                              feesFee arrayThe associated Fee objects charged to the billing user account
                                                                                                                              refund_statusstringThe current status of the shipment refund process. Possible values are "submitted", "refunded", "rejected".
                                                                                                                              batch_idstringThe ID of the batch that contains this shipment, if any
                                                                                                                              batch_statusstringThe current state of the associated BatchShipment
                                                                                                                              batch_messagestringThe current message of the associated BatchShipment
                                                                                                                              created_atdatetime
                                                                                                                              updated_atdatetime
                                                                                                                              POST /shipments

                                                                                                                              Create a Shipment

                                                                                                                              A Shipment is almost exclusively a container for other objects, and thus a Shipment may reuse many of these objects. Additionally, all the objects contained within a Shipment may be created at the same time.

                                                                                                                              The origin/destination Address and Parcel are required for rating. CustomsInfo is required to rate an international Shipment, this includes when the destination is a US Territory. The associated Tracker, Fees, and Rates are generated by EasyPost and cannot be modified by the user.

                                                                                                                              You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter.

                                                                                                                              Create Shipment Request Parameters
                                                                                                                              paramexample
                                                                                                                              reference"my-reference"
                                                                                                                              to_address<Address>
                                                                                                                              from_address<Address>
                                                                                                                              parcel<Parcel>
                                                                                                                              carrier_accounts["ca_f02596dcabbb46a8ba823280efc277bb", ...]

                                                                                                                              Create Shipment Example

                                                                                                                              curl -X POST https://api.easypost.com/v2/shipments \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'shipment[to_address][id]=adr_...' \
                                                                                                                                -d 'shipment[from_address][id]=adr_...' \
                                                                                                                                -d 'shipment[parcel][id]=prcl_...' \
                                                                                                                                -d 'shipment[customs_info][id]=cstinfo_...'
                                                                                                                              
                                                                                                                              #OR Create A Shipment With One Call
                                                                                                                              
                                                                                                                              curl -X POST https://api.easypost.com/v2/shipments \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'shipment[to_address][name]=Dr. Steve Brule' \
                                                                                                                                -d 'shipment[to_address][street1]=179 N Harbor Dr' \
                                                                                                                                -d 'shipment[to_address][city]=Redondo Beach' \
                                                                                                                                -d 'shipment[to_address][state]=CA' \
                                                                                                                                -d 'shipment[to_address][zip]=90277' \
                                                                                                                                -d 'shipment[to_address][country]=US' \
                                                                                                                                -d 'shipment[to_address][phone]=8573875756' \
                                                                                                                                -d 'shipment[to_address][email]=dr_steve_brule@gmail.com' \
                                                                                                                                -d 'shipment[from_address][name]=EasyPost' \
                                                                                                                                -d 'shipment[from_address][street1]=417 Montgomery Street' \
                                                                                                                                -d 'shipment[from_address][street2]=5th Floor' \
                                                                                                                                -d 'shipment[from_address][city]=San Francisco' \
                                                                                                                                -d 'shipment[from_address][state]=CA' \
                                                                                                                                -d 'shipment[from_address][zip]=94104' \
                                                                                                                                -d 'shipment[from_address][country]=US' \
                                                                                                                                -d 'shipment[from_address][phone]=4153334445' \
                                                                                                                                -d 'shipment[from_address][email]=support@easypost.com' \
                                                                                                                                -d 'shipment[parcel][length]=20.2' \
                                                                                                                                -d 'shipment[parcel][width]=10.9' \
                                                                                                                                -d 'shipment[parcel][height]=5' \
                                                                                                                                -d 'shipment[parcel][weight]=65.9' \
                                                                                                                                -d 'shipment[customs_info][id]=cstinfo_...'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "shp_vN9h7XLn",
                                                                                                                                "object": "Shipment",
                                                                                                                                "mode": "test",
                                                                                                                                "to_address": {
                                                                                                                                  "id": "adr_zMlCRtmt",
                                                                                                                                  "object": "Address",
                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                  "street2": null,
                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "90277",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4153334444",
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": null,
                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                  "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "id": "adr_VgoLT6Ex",
                                                                                                                                  "object": "Address",
                                                                                                                                  "name": "EasyPost",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                  "street2": "5th Floor",
                                                                                                                                  "city": "San Francisco",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "94104",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4153334444",
                                                                                                                                  "email": "support@easypost.com",
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": null,
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                },
                                                                                                                                "parcel": {
                                                                                                                                  "id": "prcl_SI55pjx8",
                                                                                                                                  "object": "Parcel",
                                                                                                                                  "length": 20.2,
                                                                                                                                  "width": 10.9,
                                                                                                                                  "height": 5.0,
                                                                                                                                  "predefined_package": null,
                                                                                                                                  "weight": 140.8,
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                },
                                                                                                                                "customs_info": {
                                                                                                                                  "id": "cstinfo_iNAizey5",
                                                                                                                                  "object": "CustomsInfo",
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "contents_explanation": null,
                                                                                                                                  "contents_type": "merchandise",
                                                                                                                                  "customs_certify": false,
                                                                                                                                  "customs_signer": null,
                                                                                                                                  "eel_pfc": null,
                                                                                                                                  "non_delivery_option": "return",
                                                                                                                                  "restriction_comments": null,
                                                                                                                                  "restriction_type": "none",
                                                                                                                                  "customs_items": [
                                                                                                                                    {
                                                                                                                                      "id": "cstitem_9eDIbaDR",
                                                                                                                                      "object": "CustomsItem",
                                                                                                                                      "description": "Many, many EasyPost stickers.",
                                                                                                                                      "hs_tariff_number": "123456",
                                                                                                                                      "origin_country": "US",
                                                                                                                                      "quantity": 1,
                                                                                                                                      "value": 879,
                                                                                                                                      "weight": 140,
                                                                                                                                      "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                      "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                    }
                                                                                                                                  ]
                                                                                                                                },
                                                                                                                                "rates": [
                                                                                                                                  {
                                                                                                                                    "id": "rate_nyCb6ubX",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "carrier_account_id": "ca_12345678",
                                                                                                                                    "service": "FirstClassPackageInternationalService",
                                                                                                                                    "rate": "9.50",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 4,
                                                                                                                                    "delivery_date": "2013-04-26T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "rate_uJh8iO2n",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "carrier_account_id": "ca_12345678",
                                                                                                                                    "service": "PriorityMailInternational",
                                                                                                                                    "rate": "27.40",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 2,
                                                                                                                                    "delivery_date": "2013-04-24T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "rate_oZqapNpE",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "carrier_account_id": "ca_12345678",
                                                                                                                                    "service": "ExpressMailInternational",
                                                                                                                                    "rate": "35.48",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 1,
                                                                                                                                    "delivery_date": "2013-04-23T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "scan_form": null,
                                                                                                                                "selected_rate": null,
                                                                                                                                "postage_label": null,
                                                                                                                                "tracking_code": null,
                                                                                                                                "refund_status": null,
                                                                                                                                "insurance": null,
                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    
                                                                                                                              GET /shipments

                                                                                                                              Retrieve a list of a Shipments

                                                                                                                              The Shipment List is a paginated list of all Shipment objects associated with the given API Key. It accepts a variety of parameters which can be used to modify the scope. The has_more attribute indicates whether or not additional pages can be requested. The recommended way of paginating is to use either the before_id or after_id parameter to specify where the next page begins.

                                                                                                                              Retrieve a list of Shipment Request Parameters
                                                                                                                              paramexampleinfo
                                                                                                                              before_idshp_c8e0adb5cb293eOptional pagination parameter. Only shipments created before the given ID will be included. May not be used with after_id
                                                                                                                              after_idshp_d9e0edb5ab184dOptional pagination parameter. Only shipments created after the given ID will be included. May not be used with before_id
                                                                                                                              start_datetime2016-01-02T00:00:00ZOnly return Shipments created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
                                                                                                                              end_datetime2016-01-02T00:00:00ZOnly return Shipments created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
                                                                                                                              page_size20The number of Shipments to return on each page. The maximum value is 100
                                                                                                                              purchasedtrueOnly include Shipments that have been purchased. Default is true
                                                                                                                              include_childrenfalseAlso include Shipments created by Child Users. Defaults to false

                                                                                                                              Retrieve a list of Shipment Example

                                                                                                                              curl -X GET https://api.easypost.com/v2/shipments \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'page_size=2' \
                                                                                                                                -d 'start_datetime=2016-01-02T08:50:00Z'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "has_more": true,
                                                                                                                                "shipments": [
                                                                                                                                  {
                                                                                                                                    "batch_id": null,
                                                                                                                                    "batch_message": null,
                                                                                                                                    "batch_status": null,
                                                                                                                                    "buyer_address": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "created_at": "2016-11-28T20:03:25Z",
                                                                                                                                    "customs_info": null,
                                                                                                                                    "fees": [
                                                                                                                                      {
                                                                                                                                        "amount": "0.00000",
                                                                                                                                        "charged": true,
                                                                                                                                        "object": "Fee",
                                                                                                                                        "refunded": false,
                                                                                                                                        "type": "LabelFee"
                                                                                                                                      },
                                                                                                                                      {
                                                                                                                                        "amount": "2.60000",
                                                                                                                                        "charged": true,
                                                                                                                                        "object": "Fee",
                                                                                                                                        "refunded": false,
                                                                                                                                        "type": "PostageFee"
                                                                                                                                      }
                                                                                                                                    ],
                                                                                                                                    "forms": [],
                                                                                                                                    "from_address": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "id": "shp_c0d6305d502b4532b8c507f2a8b3d5ae",
                                                                                                                                    "insurance": null,
                                                                                                                                    "is_return": false,
                                                                                                                                    "messages": [],
                                                                                                                                    "mode": "production",
                                                                                                                                    "object": "Shipment",
                                                                                                                                    "options": {
                                                                                                                                      "currency": "USD",
                                                                                                                                      "date_advance": 0,
                                                                                                                                      "label_date": null,
                                                                                                                                      "label_format": "ZPL",
                                                                                                                                      "special_rates_eligibility": "USPS.MEDIAMAIL"
                                                                                                                                    },
                                                                                                                                    "parcel": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "postage_label": {
                                                                                                                                      "created_at": "2016-11-28T20:04:42Z",
                                                                                                                                      "date_advance": 0,
                                                                                                                                      "id": "pl_ec1a85e012364ad9844f55e173zd4a09",
                                                                                                                                      "integrated_form": "none",
                                                                                                                                      "label_date": "2016-11-28T20:04:42Z",
                                                                                                                                      "label_epl2_url": null,
                                                                                                                                      "label_file": null,
                                                                                                                                      "label_file_type": "application/zpl",
                                                                                                                                      "label_pdf_url": null,
                                                                                                                                      "label_resolution": 203,
                                                                                                                                      "label_size": "4x6",
                                                                                                                                      "label_type": "default",
                                                                                                                                      "label_url": "https://easypost-files.s3-us-west-2.amazonaws.com/files/postage_label/20161128/9zdb0ccd6009418fa12f93794f8177df.zpl",
                                                                                                                                      "label_zpl_url": "https://easypost-files.s3-us-west-2.amazonaws.com/files/postage_label/20161128/9bdb0ccd6909418fa12f93794f8177df.zpl",
                                                                                                                                      "object": "PostageLabel",
                                                                                                                                      "updated_at": "2016-11-28T20:04:42Z"
                                                                                                                                    },
                                                                                                                                    "rates": [
                                                                                                                                      { ... },
                                                                                                                                      { ... }
                                                                                                                                    ],
                                                                                                                                    "reference": null,
                                                                                                                                    "refund_status": null,
                                                                                                                                    "return_address": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "scan_form": null,
                                                                                                                                    "selected_rate": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "status": "pre_transit",
                                                                                                                                    "to_address": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "tracker": {
                                                                                                                                      ...
                                                                                                                                    },
                                                                                                                                    "tracking_code": "9400110896700986051652",
                                                                                                                                    "updated_at": "2016-11-29T03:25:18Z",
                                                                                                                                    "usps_zone": 8
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "shp_c0d6306d502b4532b8c507f2a8b3d5fb"
                                                                                                                                  }
                                                                                                                                ]
                                                                                                                              }
                                                                                                                              
                                                                                                                                    
                                                                                                                              GET /shipments/:id

                                                                                                                              Retrieve a Shipment

                                                                                                                              A Shipment can be retrieved by either its id or reference. However it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced.

                                                                                                                              Retrieve Shipment Example

                                                                                                                              curl -X GET https://api.easypost.com/v2/shipments/shp_... \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "shp_vN9h7XLn",
                                                                                                                                "object": "Shipment",
                                                                                                                                "mode": "test",
                                                                                                                                "to_address": {
                                                                                                                                  "id": "adr_zMlCRtmt",
                                                                                                                                  "object": "Address",
                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                  "street2": null,
                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "90277",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4153334444",
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": null,
                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                  "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "id": "adr_VgoLT6Ex",
                                                                                                                                  "object": "Address",
                                                                                                                                  "name": "EasyPost",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                  "street2": "5th Floor",
                                                                                                                                  "city": "San Francisco",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "94104",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4153334444",
                                                                                                                                  "email": "support@easypost.com",
                                                                                                                                  "mode": "test",
                                                                                                                                  "carrier_facility": null,
                                                                                                                                  "residential": null,
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                },
                                                                                                                                "parcel": {
                                                                                                                                  "id": "prcl_SI55pjx8",
                                                                                                                                  "object": "Parcel",
                                                                                                                                  "length": 20.2,
                                                                                                                                  "width": 10.9,
                                                                                                                                  "height": 5.0,
                                                                                                                                  "predefined_package": null,
                                                                                                                                  "weight": 140.8,
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                },
                                                                                                                                "customs_info": {
                                                                                                                                  "id": "cstinfo_iNAizey5",
                                                                                                                                  "object": "CustomsInfo",
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "contents_explanation": null,
                                                                                                                                  "contents_type": "merchandise",
                                                                                                                                  "customs_certify": false,
                                                                                                                                  "customs_signer": null,
                                                                                                                                  "eel_pfc": null,
                                                                                                                                  "non_delivery_option": "return",
                                                                                                                                  "restriction_comments": null,
                                                                                                                                  "restriction_type": "none",
                                                                                                                                  "customs_items": [
                                                                                                                                    {
                                                                                                                                      "id": "cstitem_9eDIbaDR",
                                                                                                                                      "object": "CustomsItem",
                                                                                                                                      "description": "Many, many EasyPost stickers.",
                                                                                                                                      "hs_tariff_number": "123456",
                                                                                                                                      "origin_country": "US",
                                                                                                                                      "quantity": 1,
                                                                                                                                      "value": 879,
                                                                                                                                      "weight": 140,
                                                                                                                                      "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                      "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                    }
                                                                                                                                  ]
                                                                                                                                },
                                                                                                                                "rates": [
                                                                                                                                  {
                                                                                                                                    "id": "rate_nyCb6ubX",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "carrier_account_id": "ca_12345678",
                                                                                                                                    "service": "FirstClassPackageInternationalService",
                                                                                                                                    "rate": "9.50",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 4,
                                                                                                                                    "delivery_date": "2013-04-26T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }, {
                                                                                                                                    "id": "rate_uJh8iO2n",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "carrier_account_id": "ca_12345678",
                                                                                                                                    "service": "PriorityMailInternational",
                                                                                                                                    "rate": "27.40",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 2,
                                                                                                                                    "delivery_date": "2013-04-24T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }, {
                                                                                                                                    "id": "rate_oZqapNpE",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "carrier_account_id": "ca_12345678",
                                                                                                                                    "service": "ExpressMailInternational",
                                                                                                                                    "rate": "35.48",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 1,
                                                                                                                                    "delivery_date": "2013-04-23T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "scan_form": null,
                                                                                                                                "selected_rate": null,
                                                                                                                                "postage_label": null,
                                                                                                                                "tracking_code": null,
                                                                                                                                "refund_status": null,
                                                                                                                                "insurance": null,
                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    
                                                                                                                              POST /shipments/:id/buy

                                                                                                                              Buy a Shipment

                                                                                                                              To purchase a Shipment you only need to specify the Rate to purchase. This operation populates the tracking_code and postage_label attributes. The default image format of the associated PostageLabel is PNG. To change this default see the label_format option.

                                                                                                                              Additionally, insurance may be added during the purchase. To specify an amount to insure, pass the insurance attribute as a string. The currency of all insurance is USD.

                                                                                                                              Note: USPS Commercial Plus Prices show up in the Production API only, not in Test mode.

                                                                                                                              Buy Shipment Request Parameters
                                                                                                                              paramexample
                                                                                                                              rate<Rate>
                                                                                                                              insurance"100.00"

                                                                                                                              Buy Shipment Example

                                                                                                                              curl -X POST https://api.easypost.com/v2/shipments/shp_.../buy \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'rate[id]=rate_...' \
                                                                                                                                -d 'insurance=249.99'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "batch_message": null,
                                                                                                                                "batch_status": null,
                                                                                                                                "created_at": "2013-11-08T15:50:00Z",
                                                                                                                                "customs_info": null,
                                                                                                                                "from_address": {
                                                                                                                                  "city": "San Francisco",
                                                                                                                                  "company": null,
                                                                                                                                  "country": "US",
                                                                                                                                  "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "email": null,
                                                                                                                                  "id": "adr_faGeob9S",
                                                                                                                                  "mode": "test",
                                                                                                                                  "name": "EasyPost",
                                                                                                                                  "object": "Address",
                                                                                                                                  "phone": "415-379-7678",
                                                                                                                                  "state": "CA",
                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                  "street2": "5th Floor",
                                                                                                                                  "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "zip": "94104"
                                                                                                                                },
                                                                                                                                "id": "shp_vN9h7XLn",
                                                                                                                                "insurance": 249.99,
                                                                                                                                "is_return": false,
                                                                                                                                "mode": "test",
                                                                                                                                "object": "Shipment",
                                                                                                                                "parcel": {
                                                                                                                                  "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "height": null,
                                                                                                                                  "id": "prcl_TXCreKJp",
                                                                                                                                  "length": null,
                                                                                                                                  "mode": "test",
                                                                                                                                  "object": "Parcel",
                                                                                                                                  "predefined_package": "UPSLetter",
                                                                                                                                  "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "weight": 3.0,
                                                                                                                                  "width": null
                                                                                                                                },
                                                                                                                                "postage_label": {
                                                                                                                                  "created_at": "2013-11-08T20:57:32Z",
                                                                                                                                  "id": "pl_2Np7asmw",
                                                                                                                                  "integrated_form": "none",
                                                                                                                                  "label_date": "2013-11-08T20:57:32Z",
                                                                                                                                  "label_epl2_url": null,
                                                                                                                                  "label_file_type": "image/png",
                                                                                                                                  "label_pdf_url": "http://assets.geteasypost.com/postage_labels/label_pdfs/Z7t7o2.pdf",
                                                                                                                                  "label_resolution": 200,
                                                                                                                                  "label_size": "4x7",
                                                                                                                                  "label_type": "default",
                                                                                                                                  "label_url": "http://assets.geteasypost.com/postage_labels/labels/lUoagDx.png",
                                                                                                                                  "label_zpl_url": null,
                                                                                                                                  "object": "PostageLabel",
                                                                                                                                  "updated_at": "2013-11-08T21:11:14Z"
                                                                                                                                },
                                                                                                                                "rates": [
                                                                                                                                  {
                                                                                                                                    "carrier": "UPS",
                                                                                                                                    "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "id": "rate_vWwNuK8z",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "rate": "30.44",
                                                                                                                                    "service": "NextDayAir",
                                                                                                                                    "shipment_id": "shp_w1xi76n4",
                                                                                                                                    "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                  }, {
                                                                                                                                    "carrier": "UPS",
                                                                                                                                    "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "id": "rate_kqsS35Cx",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "rate": "60.28",
                                                                                                                                    "service": "NextDayAirEarlyAM",
                                                                                                                                    "shipment_id": "shp_w1xi76n4",
                                                                                                                                    "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "reference": null,
                                                                                                                                "refund_status": null,
                                                                                                                                "scan_form": null,
                                                                                                                                "selected_rate": {
                                                                                                                                  "carrier": "UPS",
                                                                                                                                  "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                  "currency": "USD",
                                                                                                                                  "id": "rate_vWwNuK8z",
                                                                                                                                  "object": "Rate",
                                                                                                                                  "rate": "30.44",
                                                                                                                                  "service": "NextDayAir",
                                                                                                                                  "shipment_id": "shp_w1xi76n4",
                                                                                                                                  "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                },
                                                                                                                                "status": "unknown",
                                                                                                                                "to_address": {
                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                  "company": null,
                                                                                                                                  "country": "US",
                                                                                                                                  "created_at": "2013-11-08T15:49:58Z",
                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                  "id": "adr_EyDCpoii",
                                                                                                                                  "mode": "test",
                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                  "object": "Address",
                                                                                                                                  "phone": null,
                                                                                                                                  "state": "CA",
                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                  "street2": null,
                                                                                                                                  "updated_at": "2013-11-08T15:49:58Z",
                                                                                                                                  "zip": "90277"
                                                                                                                                },
                                                                                                                                "tracker": {
                                                                                                                                  "created_at": "2013-11-08T20:57:32Z",
                                                                                                                                  "id": "trk_k7oNSa1Q",
                                                                                                                                  "mode": "test",
                                                                                                                                  "object": "Tracker",
                                                                                                                                  "shipment_id": "shp_w1xi76n4",
                                                                                                                                  "status": "unknown",
                                                                                                                                  "tracking_code": "1ZE6A4850190733810",
                                                                                                                                  "tracking_details": [ ],
                                                                                                                                  "updated_at": "2013-11-08T20:58:26Z"
                                                                                                                                  "public_url": "https://track.easypost.com/djE7...",
                                                                                                                                },
                                                                                                                                "tracking_code": "1ZE6A4850190733810",
                                                                                                                                "updated_at": "2013-11-08T20:58:26Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    
                                                                                                                              GET /shipments/:id/label

                                                                                                                              Convert the Label format of a Shipment

                                                                                                                              A Shipment's PostageLabel can be converted from PNG to other formats. If the PostageLabel was originally generated in a format other than PNG it cannot be converted.

                                                                                                                              Label Shipment Example

                                                                                                                              curl -X GET https://api.easypost.com/v2/shipments/shp_.../label \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'file_format=ZPL'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "batch_message": null,
                                                                                                                                "batch_status": null,
                                                                                                                                "created_at": "2013-11-08T15:50:00Z",
                                                                                                                                "customs_info": null,
                                                                                                                                "from_address": {
                                                                                                                                  "city": "San Francisco",
                                                                                                                                  "company": null,
                                                                                                                                  "country": "US",
                                                                                                                                  "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "email": null,
                                                                                                                                  "id": "adr_faGeob9S",
                                                                                                                                  "mode": "test",
                                                                                                                                  "name": "EasyPost",
                                                                                                                                  "object": "Address",
                                                                                                                                  "phone": "415-379-7678",
                                                                                                                                  "state": "CA",
                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                  "street2": "5th Floor",
                                                                                                                                  "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "zip": "94104"
                                                                                                                                },
                                                                                                                                "id": "shp_vN9h7XLn",
                                                                                                                                "insurance": null,
                                                                                                                                "is_return": false,
                                                                                                                                "mode": "test",
                                                                                                                                "object": "Shipment",
                                                                                                                                "parcel": {
                                                                                                                                  "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "height": null,
                                                                                                                                  "id": "prcl_TXCreKJp",
                                                                                                                                  "length": null,
                                                                                                                                  "mode": "test",
                                                                                                                                  "object": "Parcel",
                                                                                                                                  "predefined_package": "UPSLetter",
                                                                                                                                  "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "weight": 3.0,
                                                                                                                                  "width": null
                                                                                                                                },
                                                                                                                                "postage_label": {
                                                                                                                                  "created_at": "2013-11-08T20:57:32Z",
                                                                                                                                  "id": "pl_2Np7asmw",
                                                                                                                                  "integrated_form": "none",
                                                                                                                                  "label_date": "2013-11-08T20:57:32Z",
                                                                                                                                  "label_epl2_url": null,
                                                                                                                                  "label_file_type": "image/png",
                                                                                                                                  "label_pdf_url": "http://assets.geteasypost.com/postage_labels/label_pdfs/Z7t7o2.pdf",
                                                                                                                                  "label_resolution": 200,
                                                                                                                                  "label_size": "4x7",
                                                                                                                                  "label_type": "default",
                                                                                                                                  "label_url": "http://assets.geteasypost.com/postage_labels/labels/lUoagDx.png",
                                                                                                                                  "label_zpl_url": "http://assets.geteasypost.com/postage_labels/label_zpls/GG0F5F.zpl",
                                                                                                                                  "object": "PostageLabel",
                                                                                                                                  "updated_at": "2013-11-08T21:11:14Z"
                                                                                                                                },
                                                                                                                                "rates": [
                                                                                                                                  {
                                                                                                                                    "carrier": "UPS",
                                                                                                                                    "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "id": "rate_vWwNuK8z",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "rate": "30.44",
                                                                                                                                    "service": "NextDayAir",
                                                                                                                                    "shipment_id": "shp_w1xi76n4",
                                                                                                                                    "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                  }, {
                                                                                                                                    "carrier": "UPS",
                                                                                                                                    "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "id": "rate_kqsS35Cx",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "rate": "60.28",
                                                                                                                                    "service": "NextDayAirEarlyAM",
                                                                                                                                    "shipment_id": "shp_w1xi76n4",
                                                                                                                                    "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "reference": null,
                                                                                                                                "refund_status": null,
                                                                                                                                "scan_form": null,
                                                                                                                                "selected_rate": {
                                                                                                                                  "carrier": "UPS",
                                                                                                                                  "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                  "currency": "USD",
                                                                                                                                  "id": "rate_vWwNuK8z",
                                                                                                                                  "object": "Rate",
                                                                                                                                  "rate": "30.44",
                                                                                                                                  "service": "NextDayAir",
                                                                                                                                  "shipment_id": "shp_w1xi76n4",
                                                                                                                                  "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                },
                                                                                                                                "status": "unknown",
                                                                                                                                "to_address": {
                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                  "company": null,
                                                                                                                                  "country": "US",
                                                                                                                                  "created_at": "2013-11-08T15:49:58Z",
                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                  "id": "adr_EyDCpoii",
                                                                                                                                  "mode": "test",
                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                  "object": "Address",
                                                                                                                                  "phone": null,
                                                                                                                                  "state": "CA",
                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                  "street2": null,
                                                                                                                                  "updated_at": "2013-11-08T15:49:58Z",
                                                                                                                                  "zip": "90277"
                                                                                                                                },
                                                                                                                                "tracker": {
                                                                                                                                  "created_at": "2013-11-08T20:57:32Z",
                                                                                                                                  "id": "trk_k7oNSa1Q",
                                                                                                                                  "mode": "test",
                                                                                                                                  "object": "Tracker",
                                                                                                                                  "shipment_id": "shp_w1xi76n4",
                                                                                                                                  "status": "unknown",
                                                                                                                                  "tracking_code": "1ZE6A4850190733810",
                                                                                                                                  "tracking_details": [ ],
                                                                                                                                  "updated_at": "2013-11-08T20:58:26Z"
                                                                                                                                  "public_url": "https://track.easypost.com/djE7...",
                                                                                                                                },
                                                                                                                                "tracking_code": "1ZE6A4850190733810",
                                                                                                                                "updated_at": "2013-11-08T20:58:26Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    

                                                                                                                              Options

                                                                                                                              Shipments can have a variety of additional options which you can specify when creating a shipment. The Options object can be populated with the keys below.

                                                                                                                              Carrier specific support for each option is added as needed. To request support for a specific carrier option please email us at support@easypost.com.

                                                                                                                              Options Object

                                                                                                                              attributetypespecification
                                                                                                                              additional_handlingboolean Setting this option to true, will add an additional handling charge. An Additional Handling charge may be applied to the following:
                                                                                                                              • Any article that is encased in an outside shipping container made of metal or wood.
                                                                                                                              • Any item, such as a barrel, drum, pail or tire, that is not fully encased in a corrugated cardboard shipping container.
                                                                                                                              • Any package with the longest side exceeding 60 inches or its second longest side exceeding 30 inches.
                                                                                                                              • Any package with an actual weight greater than 70 pounds.
                                                                                                                              address_validation_levelstringSetting this option to "0", will allow the minimum amount of address information to pass the validation check. Only for USPS postage.
                                                                                                                              alcoholboolean Set this option to true if your shipment contains alcohol.
                                                                                                                              • UPS - only supported for US Domestic shipments
                                                                                                                              • FedEx - only supported for US Domestic shipments
                                                                                                                              • Canada Post - Requires adult signature 19 years or older. If you want adult signature 18 years or older, instead use delivery_confirmation: ADULT_SIGNATURE
                                                                                                                              bill_receiver_accountstring Setting an account number of the receiver who is to receive and buy the postage.
                                                                                                                              • UPS - bill_receiver_postal_code is also required
                                                                                                                              bill_receiver_postal_codestring Setting a postal code of the receiver account you want to buy postage.
                                                                                                                              • UPS - bill_receiver_account also required
                                                                                                                              bill_third_party_accountstring Setting an account number of the third party account you want to buy postage.
                                                                                                                              • UPS - bill_third_party_country and bill_third_party_postal_code also required
                                                                                                                              bill_third_party_countrystring Setting a country of the third party account you want to buy postage.
                                                                                                                              • UPS - bill_third_party_account and bill_third_party_postal_code also required
                                                                                                                              bill_third_party_postal_codestring Setting a postal code of the third party account you want to buy postage.
                                                                                                                              • UPS - bill_third_party_country and bill_third_party_account also required
                                                                                                                              by_droneboolean Setting this option to true will indicate to the carrier to prefer delivery by drone, if the carrier supports drone delivery.
                                                                                                                              carbon_neutralbooleanSetting this to true will add a charge to reduce carbon emissions.
                                                                                                                              cod_amountstringAdding an amount will have the carrier collect the specified amount from the recipient.
                                                                                                                              cod_methodstringMethod for payment. "CASH", "CHECK", "MONEY_ORDER"
                                                                                                                              currencystringWhich currency this shipment will show for rates if carrier allows.
                                                                                                                              delivery_confirmationstring If you want to request a signature, you can pass "ADULT_SIGNATURE" or "SIGNATURE". You may also request "NO_SIGNATURE" to leave the package at the door.
                                                                                                                              • All - some options may be limited for international shipments
                                                                                                                              • FedEx - "INDIRECT_SIGNATURE" is also an option
                                                                                                                              dry_iceboolean Package contents contain dry ice.
                                                                                                                              • UPS - Need dry_ice_weight to be set
                                                                                                                              • UPS MailInnovations - Need dry_ice_weight to be set
                                                                                                                              • FedEx - Need dry_ice_weight to be set
                                                                                                                              dry_ice_medicalstring If the dry ice is for medical use, set this option to true.
                                                                                                                              • UPS - Need dry_ice_weight to be set
                                                                                                                              • UPS MailInnovations - Need dry_ice_weight to be set
                                                                                                                              dry_ice_weightstring Weight of the dry ice in ounces.
                                                                                                                              • UPS - Need dry_ice to be set
                                                                                                                              • UPS MailInnovations - Need dry_ice to be set
                                                                                                                              • FedEx - Need dry_ice to be set
                                                                                                                              endorsementstring Possible values "ADDRESS_SERVICE_REQUESTED", "FORWARDING_SERVICE_REQUESTED", "CHANGE_SERVICE_REQUESTED", "RETURN_SERVICE_REQUESTED", "LEAVE_IF_NO_RESPONSE"
                                                                                                                              freight_chargedoubleAdditional cost to be added to the invoice of this shipment. Only applies to UPS currently.
                                                                                                                              handling_instructionsstringThis is to designate special instructions for the carrier like "Do not drop!".
                                                                                                                              hazmatstringDangerous goods indicator. Possible values are "ORMD" and "LIMITED_QUANTITY". Applies to USPS, FedEx and DHL eCommerce.
                                                                                                                              hold_for_pickupbooleanPackage will wait at carrier facility for pickup.
                                                                                                                              incotermstringIncoterm negotiated for shipment. Supported values are "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP", "FAS", "FOB", "CFR", and "CIF". Setting this value to anything other than "DDP" will pass the cost and responsibility of duties on to the recipient of the package(s), as specified by Incoterms rules
                                                                                                                              invoice_numberstringThis will print an invoice number on the postage label.
                                                                                                                              label_datestring Set the date that will appear on the postage label. Accepts ISO 8601 formatted string including time zone offset. EasyPost stores all dates as UTC time.
                                                                                                                              label_formatstring Supported label formats include "PNG", "PDF", "ZPL", and "EPL2". "PNG" is the only format that allows for conversion.
                                                                                                                              machinablebooleanWhether or not the parcel can be processed by the carriers equipment.
                                                                                                                              print_custom_1string You can optionally print custom messages on labels. The locations of these fields show up on different spots on the carrier's labels.
                                                                                                                              print_custom_2stringAn additional message on the label. Same restrictions as print_custom_1
                                                                                                                              print_custom_3stringAn additional message on the label. Same restrictions as print_custom_1
                                                                                                                              print_custom_1_barcodebooleanCreate a barcode for this custom reference if supported by carrier.
                                                                                                                              print_custom_2_barcodebooleanCreate a barcode for this custom reference if supported by carrier.
                                                                                                                              print_custom_3_barcodebooleanCreate a barcode for this custom reference if supported by carrier.
                                                                                                                              print_custom_1_codestring Specify the type of print_custom_1.
                                                                                                                              FedEx
                                                                                                                              • (null) - If print_custom_1_code is not provided it defaults to Customer Reference
                                                                                                                              • PO - Purchase Order Number
                                                                                                                              • DP - Department Number
                                                                                                                              • RMA - Return Merchandise Authorization
                                                                                                                              UPS
                                                                                                                              • AJ - Accounts Receivable Customer Account
                                                                                                                              • AT - Appropriation Number
                                                                                                                              • BM - Bill of Lading Number
                                                                                                                              • 9V - Collect on Delivery (COD) Number
                                                                                                                              • ON - Dealer Order Number
                                                                                                                              • DP - Department Number
                                                                                                                              • 3Q - Food and Drug Administration (FDA) Product Code
                                                                                                                              • IK - Invoice Number
                                                                                                                              • MK - Manifest Key Number
                                                                                                                              • MJ - Model Number
                                                                                                                              • PM - Part Number
                                                                                                                              • PC - Production Code
                                                                                                                              • PO - Purchase Order Number
                                                                                                                              • RQ - Purchase Request Number
                                                                                                                              • RZ - Return Authorization Number
                                                                                                                              • SA - Salesperson Number
                                                                                                                              • SE - Serial Number
                                                                                                                              • ST - Store Number
                                                                                                                              • TN - Transaction Reference Number
                                                                                                                              • EI - Employer’s ID Number
                                                                                                                              • TJ - Federal Taxpayer ID No.
                                                                                                                              • SY - Social Security Number
                                                                                                                              print_custom_2_codestringSee print_custom_1_code.
                                                                                                                              print_custom_3_codestringSee print_custom_1_code.
                                                                                                                              saturday_deliveryboolean Set this value to true for delivery on Saturday. When setting the saturday_delivery option, you will only get rates for services that are eligible for saturday delivery. If no services are available for saturday delivery, then you will not be returned any rates. You may need to create 2 shipments, one with the saturday_delivery option set on one without to get all your eligible rates.
                                                                                                                              special_rates_eligibilitystringThis option allows you to request restrictive rates from USPS. Can set to 'USPS.MEDIAMAIL' or 'USPS.LIBRARYMAIL'.
                                                                                                                              smartpost_hubstringYou can use this to override the hub ID you have on your account.
                                                                                                                              smartpost_manifeststringThe manifest ID is used to group SmartPost packages onto a manifest for each trailer.
                                                                                                                              POST /shipments

                                                                                                                              Create a Shipment with Options

                                                                                                                              Any number of options can be specified during Shipment creation.

                                                                                                                              Create Shipment Example

                                                                                                                              curl -X POST https://api.easypost.com/v2/shipments \
                                                                                                                                -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                -d 'shipment[to_address][id]=adr_...' \
                                                                                                                                -d 'shipment[from_address][id]=adr_...' \
                                                                                                                                -d 'shipment[parcel][id]=prcl_...' \
                                                                                                                                -d 'shipment[options][address_validation_level]=0'
                                                                                                                              
                                                                                                                                      
                                                                                                                              {
                                                                                                                                "id": "shp_vN9h7XLn",
                                                                                                                                "object": "Shipment",
                                                                                                                                "mode": "test",
                                                                                                                                "options": {"address_validation_level": "0"},
                                                                                                                                "to_address": {
                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                  "company": null,
                                                                                                                                  "country": "US",
                                                                                                                                  "created_at": "2013-11-08T15:49:58Z",
                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                  "id": "adr_EyDCpoii",
                                                                                                                                  "mode": "test",
                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                  "object": "Address",
                                                                                                                                  "phone": null,
                                                                                                                                  "state": "CA",
                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                  "street2": null,
                                                                                                                                  "updated_at": "2013-11-08T15:49:58Z",
                                                                                                                                  "zip": "90277"
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "city": "San Francisco",
                                                                                                                                  "company": null,
                                                                                                                                  "country": "US",
                                                                                                                                  "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "email": null,
                                                                                                                                  "id": "adr_faGeob9S",
                                                                                                                                  "mode": "test",
                                                                                                                                  "name": "EasyPost",
                                                                                                                                  "object": "Address",
                                                                                                                                  "phone": "415-379-7678",
                                                                                                                                  "state": "CA",
                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                  "street2": "5th Floor",
                                                                                                                                  "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                  "zip": "94104"
                                                                                                                                },
                                                                                                                                "parcel": {
                                                                                                                                  "id": "prcl_SI55pjx8",
                                                                                                                                  "object": "Parcel",
                                                                                                                                  "length": 20.2,
                                                                                                                                  "width": 10.9,
                                                                                                                                  "height": 5.0,
                                                                                                                                  "predefined_package": null,
                                                                                                                                  "weight": 140.8,
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                },
                                                                                                                                "customs_info": {
                                                                                                                                  "id": "cstinfo_iNAizey5",
                                                                                                                                  "object": "CustomsInfo",
                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z",
                                                                                                                                  "contents_explanation": null,
                                                                                                                                  "contents_type": "merchandise",
                                                                                                                                  "customs_certify": false,
                                                                                                                                  "customs_signer": null,
                                                                                                                                  "eel_pfc": null,
                                                                                                                                  "non_delivery_option": "return",
                                                                                                                                  "restriction_comments": null,
                                                                                                                                  "restriction_type": "none",
                                                                                                                                  "customs_items": [
                                                                                                                                    {
                                                                                                                                      "id": "cstitem_9eDIbaDR",
                                                                                                                                      "object": "CustomsItem",
                                                                                                                                      "description": "Many, many EasyPost stickers.",
                                                                                                                                      "hs_tariff_number": "123456",
                                                                                                                                      "origin_country": "US",
                                                                                                                                      "quantity": 1,
                                                                                                                                      "value": 879,
                                                                                                                                      "weight": 140,
                                                                                                                                      "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                      "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                    }
                                                                                                                                  ]
                                                                                                                                },
                                                                                                                                "rates": [
                                                                                                                                  {
                                                                                                                                    "id": "rate_nyCb6ubX",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "service": "FirstClassPackageInternationalService",
                                                                                                                                    "rate": "9.50",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 4,
                                                                                                                                    "delivery_date": "2013-04-26T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }, {
                                                                                                                                    "id": "rate_uJh8iO2n",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "service": "PriorityMailInternational",
                                                                                                                                    "rate": "27.40",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 2,
                                                                                                                                    "delivery_date": "2013-04-24T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }, {
                                                                                                                                    "id": "rate_oZqapNpE",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "service": "ExpressMailInternational",
                                                                                                                                    "rate": "35.48",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "shipment_id": "shp_vN9h7XLn",
                                                                                                                                    "delivery_days": 1,
                                                                                                                                    "delivery_date": "2013-04-23T05:40:57Z",
                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                    "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                    "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "scan_form": null,
                                                                                                                                "selected_rate": null,
                                                                                                                                "postage_label": null,
                                                                                                                                "tracking_code": null,
                                                                                                                                "refund_status": null,
                                                                                                                                "insurance": null,
                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                              }
                                                                                                                              
                                                                                                                                    

                                                                                                                              Rates

                                                                                                                              After a Shipment is successfully created, it will automatically fetch Rates. You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter upon Shipment creation.

                                                                                                                              There are three rate types: the actual rate that will be purchased, rate and currency, the published non-discounted rate, list_rate and list_currency, and the rate if purchased from the post office, retail_rate and retail_currency.

                                                                                                                              Rate Object

                                                                                                                              attributetypespecification
                                                                                                                              idstringunique, begins with 'rate_'
                                                                                                                              objectstring"Rate"
                                                                                                                              modestring"test" or "production"
                                                                                                                              servicestringservice level/name
                                                                                                                              carrierstringname of carrier
                                                                                                                              carrier_account_idstringID of the CarrierAccount record used to generate this rate
                                                                                                                              shipment_idstringID of the Shipment this rate belongs to
                                                                                                                              ratestringthe actual rate quote for this service
                                                                                                                              currencystringcurrency for the rate
                                                                                                                              retail_ratestringthe retail rate is the in-store rate given with no account
                                                                                                                              retail_currencystringcurrency for the retail rate
                                                                                                                              list_ratestringthe list rate is the non-negotiated rate given for having an account with the carrier
                                                                                                                              list_currencystringcurrency for the list rate
                                                                                                                              delivery_daysintdelivery days for this service
                                                                                                                              delivery_datestringdate for delivery
                                                                                                                              delivery_date_guaranteedbooleanindicates if delivery window is guaranteed (true) or not (false)
                                                                                                                              est_delivery_days*integer*This field is deprecated and should be ignored.
                                                                                                                              created_atdatetime
                                                                                                                              updated_atdatetime

                                                                                                                              Service Levels

                                                                                                                              APC
                                                                                                                              • parcelConnectBookService
                                                                                                                              • parcelConnectExpeditedDDP
                                                                                                                              • parcelConnectExpeditedDDU
                                                                                                                              • parcelConnectPriorityDDP
                                                                                                                              • parcelConnectPriorityDDPDelcon
                                                                                                                              • parcelConnectPriorityDDU
                                                                                                                              • parcelConnectPriorityDDUDelcon
                                                                                                                              • parcelConnectPriorityDDUPQW
                                                                                                                              • parcelConnectStandardDDU
                                                                                                                              • parcelConnectStandardDDUPQW
                                                                                                                              • parcelConnectPacketDDU
                                                                                                                              Aramex

                                                                                                                              No service levels for Aramex.

                                                                                                                                Asendia
                                                                                                                                • PMI
                                                                                                                                • ePacket
                                                                                                                                • IPA
                                                                                                                                • ISAL
                                                                                                                                Australia Post
                                                                                                                                • ExpressPost
                                                                                                                                • ExpressPostSignature
                                                                                                                                • ParcelPost
                                                                                                                                • ParcelPostSignature
                                                                                                                                • ParcelPostExtra
                                                                                                                                • ParcelPostWinePlusSignature
                                                                                                                                Bluedart

                                                                                                                                No service levels for Bluedart.

                                                                                                                                  Boxberry
                                                                                                                                  • Boxberry
                                                                                                                                  Cainiao

                                                                                                                                  No service levels for Cainiao.

                                                                                                                                    Canada Post
                                                                                                                                    • RegularParcel
                                                                                                                                    • ExpeditedParcel
                                                                                                                                    • Xpresspost
                                                                                                                                    • XpresspostCertified
                                                                                                                                    • Priority
                                                                                                                                    • LibraryBooks
                                                                                                                                    • ExpeditedParcelUSA
                                                                                                                                    • PriorityWorldwideEnvelopeUSA
                                                                                                                                    • PriorityWorldwidePakUSA
                                                                                                                                    • PriorityWorldwideParcelUSA
                                                                                                                                    • SmallPacketUSAAir
                                                                                                                                    • TrackedPacketUSA
                                                                                                                                    • TrackedPacketUSALVM
                                                                                                                                    • XpresspostUSA
                                                                                                                                    • XpresspostInternational
                                                                                                                                    • InternationalParcelAir
                                                                                                                                    • InternationalParcelSurface
                                                                                                                                    • PriorityWorldwideEnvelopeIntl
                                                                                                                                    • PriorityWorldwidePakIntl
                                                                                                                                    • PriorityWorldwideParcelIntl
                                                                                                                                    • SmallPacketInternationalAir
                                                                                                                                    • SmallPacketInternationalSurface
                                                                                                                                    • TrackedPacketInternational
                                                                                                                                    Canpar
                                                                                                                                    • Ground
                                                                                                                                    • SelectLetter
                                                                                                                                    • SelectPak
                                                                                                                                    • Select
                                                                                                                                    • OvernightLetter
                                                                                                                                    • OvernightPak
                                                                                                                                    • Overnight
                                                                                                                                    • SelectUSA
                                                                                                                                    • USAPak
                                                                                                                                    • USALetter
                                                                                                                                    • USA
                                                                                                                                    • International
                                                                                                                                    China Post

                                                                                                                                    No service levels for China Post.

                                                                                                                                      Chronopost

                                                                                                                                      No service levels for Chronopost.

                                                                                                                                        Colis Privé
                                                                                                                                        • Parcel
                                                                                                                                        Colissimo
                                                                                                                                        • InterMonBureauDePoste
                                                                                                                                        • InterMonCommercant
                                                                                                                                        • InterMonDomicileAvecSignature
                                                                                                                                        • InterMonDomicileSansSignature
                                                                                                                                        • MaConsigneCityssimo
                                                                                                                                        • MonBureauDePoste
                                                                                                                                        • MonCommercant
                                                                                                                                        • MonDomicileAvecSignature
                                                                                                                                        • MonDomicileSansSignature
                                                                                                                                        • MonDomicileSurRDV
                                                                                                                                        Correios

                                                                                                                                        No service levels for Correios.

                                                                                                                                          Correos Costa Rica

                                                                                                                                          No service levels for Correos Costa Rica.

                                                                                                                                            Delhivery

                                                                                                                                            No service levels for Delhivery.

                                                                                                                                              Deliv
                                                                                                                                              • Scheduled
                                                                                                                                              • OnDemand
                                                                                                                                              Deutsche Post

                                                                                                                                              No service levels for Deutsche Post.

                                                                                                                                                DHL Express
                                                                                                                                                • BreakBulkEconomy
                                                                                                                                                • BreakBulkExpress
                                                                                                                                                • DomesticEconomySelect
                                                                                                                                                • DomesticExpress
                                                                                                                                                • DomesticExpress1030
                                                                                                                                                • DomesticExpress1200
                                                                                                                                                • EconomySelect
                                                                                                                                                • EconomySelectNonDoc
                                                                                                                                                • EuroPack
                                                                                                                                                • EuropackNonDoc
                                                                                                                                                • Express1030
                                                                                                                                                • Express1030NonDoc
                                                                                                                                                • Express1200NonDoc
                                                                                                                                                • Express1200
                                                                                                                                                • Express900
                                                                                                                                                • Express900NonDoc
                                                                                                                                                • ExpressEasy
                                                                                                                                                • ExpressEasyNonDoc
                                                                                                                                                • ExpressEnvelope
                                                                                                                                                • ExpressWorldwide
                                                                                                                                                • ExpressWorldwideB2C
                                                                                                                                                • ExpressWorldwideB2CNonDoc
                                                                                                                                                • ExpressWorldwideECX
                                                                                                                                                • ExpressWorldwideNonDoc
                                                                                                                                                • FreightWorldwide
                                                                                                                                                • GlobalmailBusiness
                                                                                                                                                • JetLine
                                                                                                                                                • JumboBox
                                                                                                                                                • LogisticsServices
                                                                                                                                                • SameDay
                                                                                                                                                • SecureLine
                                                                                                                                                • SprintLine
                                                                                                                                                DHL Freight

                                                                                                                                                No service levels for DHL Freight.

                                                                                                                                                  DHL Germany

                                                                                                                                                  No service levels for DHL Germany.

                                                                                                                                                    DHL Global Mail
                                                                                                                                                    • BPMExpeditedDomestic
                                                                                                                                                    • BPMGroundDomestic
                                                                                                                                                    • FlatsExpeditedDomestic
                                                                                                                                                    • FlatsGroundDomestic
                                                                                                                                                    • MediaMailGroundDomestic
                                                                                                                                                    • ParcelPlusExpeditedDomestic
                                                                                                                                                    • ParcelPlusGroundDomestic
                                                                                                                                                    • ParcelsExpeditedDomestic
                                                                                                                                                    • ParcelsGroundDomestic
                                                                                                                                                    • MarketingParcelExpeditedDomestic
                                                                                                                                                    • MarketingParcelGroundDomestic
                                                                                                                                                    DHL GM International
                                                                                                                                                    • DHLPacketInternationalPriority
                                                                                                                                                    • DHLPacketInternationalStandard
                                                                                                                                                    • DHLPacketPlusInternational
                                                                                                                                                    • DHLPacketIPA
                                                                                                                                                    • DHLPacketISAL
                                                                                                                                                    • DHLParcelInternationalPriority
                                                                                                                                                    • DHLParcelInternationalStandard
                                                                                                                                                    • DHLParcelDirectInternationalPriority
                                                                                                                                                    • DHLParcelDirectInternationalExpedited
                                                                                                                                                    Dicom
                                                                                                                                                    • Ground
                                                                                                                                                    Dominos

                                                                                                                                                    No service levels for Dominos.

                                                                                                                                                      DPD
                                                                                                                                                      • DPDCLASSIC
                                                                                                                                                      • DPD8:30
                                                                                                                                                      • DPD10:00
                                                                                                                                                      • DPD12:00
                                                                                                                                                      • DPD18:00
                                                                                                                                                      • DPDEXPRESS
                                                                                                                                                      • DPDPARCELLETTER
                                                                                                                                                      • DPDPARCELLETTERPLUS
                                                                                                                                                      • DPDINTERNATIONALMAIL
                                                                                                                                                      DPD UK
                                                                                                                                                      • AirExpressInternationalAir
                                                                                                                                                      • AirClassicInternationalAir
                                                                                                                                                      • ParcelSunday
                                                                                                                                                      • FreightParcelSunday
                                                                                                                                                      • PalletSunday
                                                                                                                                                      • PalletDpdClassic
                                                                                                                                                      • ExpresspakDpdClassic
                                                                                                                                                      • ExpresspakSunday
                                                                                                                                                      • ParcelDpdClassic
                                                                                                                                                      • ParcelDpdTwoDay
                                                                                                                                                      • ParcelDpdNextDay
                                                                                                                                                      • ParcelDpd12
                                                                                                                                                      • ParcelDpd10
                                                                                                                                                      • ParcelDpd10
                                                                                                                                                      • ParcelReturnToShop
                                                                                                                                                      • ParcelSaturday
                                                                                                                                                      • ParcelSaturday12
                                                                                                                                                      • ParcelSaturday10
                                                                                                                                                      • ParcelSaturday10
                                                                                                                                                      • ParcelSunday12
                                                                                                                                                      • FreightParcelDpdClassic
                                                                                                                                                      • FreightParcelSunday12
                                                                                                                                                      • ExpresspakDpdNextDay
                                                                                                                                                      • ExpresspakDpd12
                                                                                                                                                      • ExpresspakDpd10
                                                                                                                                                      • ExpresspakDpd10
                                                                                                                                                      • ExpresspakSaturday
                                                                                                                                                      • ExpresspakSaturday12
                                                                                                                                                      • ExpresspakSaturday10
                                                                                                                                                      • ExpresspakSaturday10
                                                                                                                                                      • ExpresspakSunday12
                                                                                                                                                      • PalletSunday12
                                                                                                                                                      • PalletDpdTwoDay
                                                                                                                                                      • PalletDpdNextDay
                                                                                                                                                      • PalletDpd12
                                                                                                                                                      • PalletDpd10
                                                                                                                                                      • PalletSaturday
                                                                                                                                                      • PalletSaturday12
                                                                                                                                                      • PalletSaturday10
                                                                                                                                                      • FreightParcelDpdTwoDay
                                                                                                                                                      • FreightParcelDpdNextDay
                                                                                                                                                      • FreightParcelDpd12
                                                                                                                                                      • FreightParcelDpd10
                                                                                                                                                      • FreightParcelSaturday
                                                                                                                                                      • FreightParcelSaturday12
                                                                                                                                                      • FreightParcelSaturday10
                                                                                                                                                      • ParcelShipToShop
                                                                                                                                                      EC Firstclass

                                                                                                                                                      No service levels for EC Firstclass.

                                                                                                                                                        Ecom Express

                                                                                                                                                        No service levels for Ecom Express.

                                                                                                                                                          EMS

                                                                                                                                                          No service levels for EMS.

                                                                                                                                                            Fastway
                                                                                                                                                            • Parcel
                                                                                                                                                            • Satchel
                                                                                                                                                            FedEx
                                                                                                                                                            • FEDEX_GROUND
                                                                                                                                                            • FEDEX_2_DAY
                                                                                                                                                            • FEDEX_2_DAY_AM
                                                                                                                                                            • FEDEX_EXPRESS_SAVER
                                                                                                                                                            • STANDARD_OVERNIGHT
                                                                                                                                                            • FIRST_OVERNIGHT
                                                                                                                                                            • PRIORITY_OVERNIGHT
                                                                                                                                                            • INTERNATIONAL_ECONOMY
                                                                                                                                                            • INTERNATIONAL_FIRST
                                                                                                                                                            • INTERNATIONAL_PRIORITY
                                                                                                                                                            • GROUND_HOME_DELIVERY
                                                                                                                                                            • SMART_POST
                                                                                                                                                            FedEx Mailview

                                                                                                                                                            No service levels for FedEx Mailview.

                                                                                                                                                              FedEx UK

                                                                                                                                                              No service levels for FedEx UK.

                                                                                                                                                                FedEx SmartPost
                                                                                                                                                                • SMART_POST
                                                                                                                                                                Flyt Express

                                                                                                                                                                No service levels for Flyt Express.

                                                                                                                                                                  Globegistics
                                                                                                                                                                  • PMEI
                                                                                                                                                                  • PMI
                                                                                                                                                                  • eComDomestic
                                                                                                                                                                  • eComDomesticBPM
                                                                                                                                                                  • eComDomesticFlats
                                                                                                                                                                  • eComEurope
                                                                                                                                                                  • eComExpress
                                                                                                                                                                  • eComExtra
                                                                                                                                                                  • eComIPA
                                                                                                                                                                  • eComISAL
                                                                                                                                                                  • eComPacket
                                                                                                                                                                  • eComPriority
                                                                                                                                                                  • eComStandard
                                                                                                                                                                  • eComTrackedDDP
                                                                                                                                                                  • eComTrackedDDU
                                                                                                                                                                  GLS

                                                                                                                                                                  No service levels for GLS.

                                                                                                                                                                    GSO
                                                                                                                                                                    • EarlyPriorityOvernight
                                                                                                                                                                    • PriorityOvernight
                                                                                                                                                                    • CaliforniaParcelService
                                                                                                                                                                    • SaturdayDeliveryService
                                                                                                                                                                    • EarlySaturdayService
                                                                                                                                                                    • Ground
                                                                                                                                                                    • Overnight
                                                                                                                                                                    Hong Kong Post

                                                                                                                                                                    No service levels for Hong Kong Post.

                                                                                                                                                                      IMEX

                                                                                                                                                                      No service levels for IMEX.

                                                                                                                                                                        India Post

                                                                                                                                                                        No service levels for India Post.

                                                                                                                                                                          Interlink Express
                                                                                                                                                                          • InterlinkAirClassicInternationalAir
                                                                                                                                                                          • InterlinkAirExpressInternationalAir
                                                                                                                                                                          • InterlinkExpresspak1By10:30
                                                                                                                                                                          • InterlinkExpresspak1By12
                                                                                                                                                                          • InterlinkExpresspak1NextDay
                                                                                                                                                                          • InterlinkExpresspak1Saturday
                                                                                                                                                                          • InterlinkExpresspak1SaturdayBy10:30
                                                                                                                                                                          • InterlinkExpresspak1SaturdayBy12
                                                                                                                                                                          • InterlinkExpresspak1Sunday
                                                                                                                                                                          • InterlinkExpresspak1SundayBy12
                                                                                                                                                                          • InterlinkExpresspak5By10
                                                                                                                                                                          • InterlinkExpresspak5By10:30
                                                                                                                                                                          • InterlinkExpresspak5By12
                                                                                                                                                                          • InterlinkExpresspak5NextDay
                                                                                                                                                                          • InterlinkExpresspak5Saturday
                                                                                                                                                                          • InterlinkExpresspak5SaturdayBy10
                                                                                                                                                                          • InterlinkExpresspak5SaturdayBy10:30
                                                                                                                                                                          • InterlinkExpresspak5SaturdayBy12
                                                                                                                                                                          • InterlinkExpresspak5Sunday
                                                                                                                                                                          • InterlinkExpresspak5SundayBy12
                                                                                                                                                                          • InterlinkFreightBy10
                                                                                                                                                                          • InterlinkFreightBy12
                                                                                                                                                                          • InterlinkFreightNextDay
                                                                                                                                                                          • InterlinkFreightSaturday
                                                                                                                                                                          • InterlinkFreightSaturdayBy10
                                                                                                                                                                          • InterlinkFreightSaturdayBy12
                                                                                                                                                                          • InterlinkFreightSunday
                                                                                                                                                                          • InterlinkFreightSundayBy12
                                                                                                                                                                          • InterlinkParcelBy10
                                                                                                                                                                          • InterlinkParcelBy10:30
                                                                                                                                                                          • InterlinkParcelBy12
                                                                                                                                                                          • InterlinkParcelDpdEuropeByRoad
                                                                                                                                                                          • InterlinkParcelNextDay
                                                                                                                                                                          • InterlinkParcelReturn
                                                                                                                                                                          • InterlinkParcelReturnToShop
                                                                                                                                                                          • InterlinkParcelSaturday
                                                                                                                                                                          • InterlinkParcelSaturdayBy10
                                                                                                                                                                          • InterlinkParcelSaturdayBy10:30
                                                                                                                                                                          • InterlinkParcelSaturdayBy12
                                                                                                                                                                          • InterlinkParcelShipToShop
                                                                                                                                                                          • InterlinkParcelSunday
                                                                                                                                                                          • InterlinkParcelSundayBy12
                                                                                                                                                                          • InterlinkParcelTwoDay
                                                                                                                                                                          • InterlinkPickupParcelDpdEuropeByRoad
                                                                                                                                                                          Israel Post

                                                                                                                                                                          No service levels for Israel Post.

                                                                                                                                                                            JP Post

                                                                                                                                                                            No service levels for JP Post.

                                                                                                                                                                              La Poste

                                                                                                                                                                              No service levels for La Poste.

                                                                                                                                                                                LaserShip
                                                                                                                                                                                • SameDay
                                                                                                                                                                                • NextDay
                                                                                                                                                                                Latvijas Pasts

                                                                                                                                                                                No service levels for Latvijas Pasts.

                                                                                                                                                                                  Liefery
                                                                                                                                                                                  • TourAppointment20161124From1600To1900
                                                                                                                                                                                  LSO
                                                                                                                                                                                  • GroundEarly
                                                                                                                                                                                  • GroundBasic
                                                                                                                                                                                  • PriorityBasic
                                                                                                                                                                                  • PriorityEarly
                                                                                                                                                                                  • PrioritySaturday
                                                                                                                                                                                  • Priority2ndDay
                                                                                                                                                                                  • SameDay
                                                                                                                                                                                  Nanjing Woyuan

                                                                                                                                                                                  No service levels for Nanjing Woyuan.

                                                                                                                                                                                    Network4
                                                                                                                                                                                    • BronzeDelivery
                                                                                                                                                                                    • BronzeDeliveryAndCollection
                                                                                                                                                                                    • SilverDelivery
                                                                                                                                                                                    • SilverDeliveryAndCollection
                                                                                                                                                                                    • GoldDelivery
                                                                                                                                                                                    • GoldDeliveryAndCollection
                                                                                                                                                                                    • PlatinumDelivery
                                                                                                                                                                                    • PlatinumDeliveryAndCollection
                                                                                                                                                                                    NZ Courier Post
                                                                                                                                                                                    • CPOnlineParcel
                                                                                                                                                                                    • CPOnlineParcelSaturdayDelivery
                                                                                                                                                                                    • CPOnlineParcelSigRq
                                                                                                                                                                                    • CPOnlineWIslandContract
                                                                                                                                                                                    • CPOnlineWIslandContractSaturdayDelivery
                                                                                                                                                                                    • CPOnlineWIslandContractSigRq
                                                                                                                                                                                    New Zealand Post

                                                                                                                                                                                    No service levels for New Zealand Post.

                                                                                                                                                                                      Norco
                                                                                                                                                                                      • EarlyOvernite
                                                                                                                                                                                      • MorningOvernite
                                                                                                                                                                                      • OneOvernite
                                                                                                                                                                                      • NextDayOvernite
                                                                                                                                                                                      • SaturdayOvernite
                                                                                                                                                                                      • 2DayMetro
                                                                                                                                                                                      • Ground
                                                                                                                                                                                      • Overnight
                                                                                                                                                                                      Nova Poshta

                                                                                                                                                                                      No service levels for Nova Poshta.

                                                                                                                                                                                        OnTrac
                                                                                                                                                                                        • Sunrise
                                                                                                                                                                                        • Gold
                                                                                                                                                                                        • OnTrac Gold
                                                                                                                                                                                        • Ground
                                                                                                                                                                                        • Overnight
                                                                                                                                                                                        OnTrac DirectPost
                                                                                                                                                                                        • FirstClassMail
                                                                                                                                                                                        • PriorityMail
                                                                                                                                                                                        • BoundPrintedMatter
                                                                                                                                                                                        • MediaMail
                                                                                                                                                                                        • ParcelSelect
                                                                                                                                                                                        • ParcelSelectLightweight
                                                                                                                                                                                        Orange DS
                                                                                                                                                                                        • OrangeDSInternational
                                                                                                                                                                                        • OrangeDSDomestic
                                                                                                                                                                                        • OrangeDSTracking
                                                                                                                                                                                        • OrangeDSSecureShip
                                                                                                                                                                                        Parcelforce

                                                                                                                                                                                        No service levels for Parcelforce.

                                                                                                                                                                                          POS Malaysia

                                                                                                                                                                                          No service levels for POS Malaysia.

                                                                                                                                                                                            Postmates
                                                                                                                                                                                            • OnDemand
                                                                                                                                                                                            PostNL
                                                                                                                                                                                            • EUPackSpecialCOD
                                                                                                                                                                                            • EUPackStandard
                                                                                                                                                                                            • BelgiumStatedAddressOnlyReturnNotHome
                                                                                                                                                                                            • BelgiumReturnNotHome
                                                                                                                                                                                            • BelgiumSignatureStatedAddressOnlyReturnNotHome
                                                                                                                                                                                            • BelgiumSignatureReturnNotHome
                                                                                                                                                                                            • BelgiumCODReturnNotHome
                                                                                                                                                                                            • BelgiumExtraCoverStatedAddressOnlyReturnNotHome
                                                                                                                                                                                            • BelgiumCODExtraCoverReturnNotHome
                                                                                                                                                                                            • LetterIDAgeCheck
                                                                                                                                                                                            • LetterAgeCheck
                                                                                                                                                                                            • LetterIDCheck
                                                                                                                                                                                            • StandardShipment
                                                                                                                                                                                            • COD
                                                                                                                                                                                            • ExtraCover
                                                                                                                                                                                            • SignatureStatedAddressOnly
                                                                                                                                                                                            • DeliveryToNeighbourReturnNotHome
                                                                                                                                                                                            • CODExtraCover
                                                                                                                                                                                            • CODReturnNotHome
                                                                                                                                                                                            • ExtraCoverReturnNotHome
                                                                                                                                                                                            • SignatureStatedAddressOnlyReturnNotHome
                                                                                                                                                                                            • CODExtraCoverReturnNotHome
                                                                                                                                                                                            • Signature
                                                                                                                                                                                            • StatedAddressOnly
                                                                                                                                                                                            • SignatureReturnNotHome
                                                                                                                                                                                            • StatedAddressOnlyReturnNotHome
                                                                                                                                                                                            • ParcelAgeCheck
                                                                                                                                                                                            • ParcelIDAgeCheck
                                                                                                                                                                                            • ParcelIDCheck
                                                                                                                                                                                            PostNord

                                                                                                                                                                                            No service levels for PostNord.

                                                                                                                                                                                              Purolator
                                                                                                                                                                                              • PurolatorExpress
                                                                                                                                                                                              • PurolatorExpress1030AM
                                                                                                                                                                                              • PurolatorExpress9AM
                                                                                                                                                                                              • PurolatorExpressBox
                                                                                                                                                                                              • PurolatorExpressBox1030AM
                                                                                                                                                                                              • PurolatorExpressBox9AM
                                                                                                                                                                                              • PurolatorExpressBoxEvening
                                                                                                                                                                                              • PurolatorExpressBoxInternational
                                                                                                                                                                                              • PurolatorExpressBoxUS
                                                                                                                                                                                              • PurolatorExpressEnvelope
                                                                                                                                                                                              • PurolatorExpressEnvelope1030AM
                                                                                                                                                                                              • PurolatorExpressEnvelope9AM
                                                                                                                                                                                              • PurolatorExpressEnvelopeEvening
                                                                                                                                                                                              • PurolatorExpressEnvelopeInternational
                                                                                                                                                                                              • PurolatorExpressEnvelopeUS
                                                                                                                                                                                              • PurolatorExpressEvening
                                                                                                                                                                                              • PurolatorExpressInternational
                                                                                                                                                                                              • PurolatorExpressInternational1030AM
                                                                                                                                                                                              • PurolatorExpressInternational1200
                                                                                                                                                                                              • PurolatorExpressInternational9AM
                                                                                                                                                                                              • PurolatorExpressInternationalBox1030AM
                                                                                                                                                                                              • PurolatorExpressInternationalBox1200
                                                                                                                                                                                              • PurolatorExpressInternationalBox9AM
                                                                                                                                                                                              • PurolatorExpressInternationalEnvelope1030AM
                                                                                                                                                                                              • PurolatorExpressInternationalEnvelope1200
                                                                                                                                                                                              • PurolatorExpressInternationalEnvelope9AM
                                                                                                                                                                                              • PurolatorExpressInternationalPack1030AM
                                                                                                                                                                                              • PurolatorExpressInternationalPack1200
                                                                                                                                                                                              • PurolatorExpressInternationalPack9AM
                                                                                                                                                                                              • PurolatorExpressPack
                                                                                                                                                                                              • PurolatorExpressPack1030AM
                                                                                                                                                                                              • PurolatorExpressPack9AM
                                                                                                                                                                                              • PurolatorExpressPackEvening
                                                                                                                                                                                              • PurolatorExpressPackInternational
                                                                                                                                                                                              • PurolatorExpressPackUS
                                                                                                                                                                                              • PurolatorExpressUS
                                                                                                                                                                                              • PurolatorExpressUS1030AM
                                                                                                                                                                                              • PurolatorExpressUS1200
                                                                                                                                                                                              • PurolatorExpressUS9AM
                                                                                                                                                                                              • PurolatorExpressUSBox1030AM
                                                                                                                                                                                              • PurolatorExpressUSBox1200
                                                                                                                                                                                              • PurolatorExpressUSBox9AM
                                                                                                                                                                                              • PurolatorExpressUSEnvelope1030AM
                                                                                                                                                                                              • PurolatorExpressUSEnvelope1200
                                                                                                                                                                                              • PurolatorExpressUSEnvelope9AM
                                                                                                                                                                                              • PurolatorExpressUSPack1030AM
                                                                                                                                                                                              • PurolatorExpressUSPack1200
                                                                                                                                                                                              • PurolatorExpressUSPack9AM
                                                                                                                                                                                              • PurolatorGround
                                                                                                                                                                                              • PurolatorGround1030AM
                                                                                                                                                                                              • PurolatorGround9AM
                                                                                                                                                                                              • PurolatorGroundDistribution
                                                                                                                                                                                              • PurolatorGroundEvening
                                                                                                                                                                                              • PurolatorGroundRegional
                                                                                                                                                                                              • PurolatorGroundUS
                                                                                                                                                                                              R+L Carriers

                                                                                                                                                                                              No service levels for R+L Carriers.

                                                                                                                                                                                                Royal Mail
                                                                                                                                                                                                • InternationalSigned
                                                                                                                                                                                                • InternationalStandard
                                                                                                                                                                                                • InternationalTracked
                                                                                                                                                                                                • InternationalTrackedAndSigned
                                                                                                                                                                                                • 1stClass
                                                                                                                                                                                                • 1stClassSignedFor
                                                                                                                                                                                                • 2ndClass
                                                                                                                                                                                                • 2ndClassSignedFor
                                                                                                                                                                                                • RoyalMail24
                                                                                                                                                                                                • RoyalMail24SignedFor
                                                                                                                                                                                                • RoyalMail48
                                                                                                                                                                                                • RoyalMail48SignedFor
                                                                                                                                                                                                • SpecialDeliveryGuaranteed1pm
                                                                                                                                                                                                • SpecialDeliveryGuaranteed9am
                                                                                                                                                                                                • StandardLetter1stClass
                                                                                                                                                                                                • StandardLetter1stClassSignedFor
                                                                                                                                                                                                • StandardLetter2ndClass
                                                                                                                                                                                                • StandardLetter2ndClassSignedFor
                                                                                                                                                                                                • Tracked24
                                                                                                                                                                                                • Tracked24HighVolume
                                                                                                                                                                                                • Tracked24HighVolumeSignature
                                                                                                                                                                                                • Tracked24Signature
                                                                                                                                                                                                • Tracked48
                                                                                                                                                                                                • Tracked48HighVolume
                                                                                                                                                                                                • Tracked48HighVolumeSignature
                                                                                                                                                                                                • Tracked48Signature
                                                                                                                                                                                                RR Donnelley
                                                                                                                                                                                                • CourierServiceDDP
                                                                                                                                                                                                • CourierServiceDDU
                                                                                                                                                                                                • DomesticEconomyParcel
                                                                                                                                                                                                • DomesticParcelBPM
                                                                                                                                                                                                • DomesticPriorityParcel
                                                                                                                                                                                                • DomesticPriorityParcelBPM
                                                                                                                                                                                                • EMIService
                                                                                                                                                                                                • EconomyParcelService
                                                                                                                                                                                                • IPAService
                                                                                                                                                                                                • ISALService
                                                                                                                                                                                                • PMIService
                                                                                                                                                                                                • PriorityParcelDDP
                                                                                                                                                                                                • PriorityParcelDDU
                                                                                                                                                                                                • PriorityParcelDeliveryConfirmationDDP
                                                                                                                                                                                                • PriorityParcelDeliveryConfirmationDDU
                                                                                                                                                                                                • ePacketService
                                                                                                                                                                                                Singapore Post

                                                                                                                                                                                                No service levels for Singapore Post.

                                                                                                                                                                                                  SMSA Express

                                                                                                                                                                                                  No service levels for SMSA Express.

                                                                                                                                                                                                    Spee-Dee
                                                                                                                                                                                                    • SpeeDeeDelivery
                                                                                                                                                                                                    TNT Express
                                                                                                                                                                                                    • 0900Express
                                                                                                                                                                                                    • 1000Express
                                                                                                                                                                                                    • 1200Express
                                                                                                                                                                                                    • EconomyExpress
                                                                                                                                                                                                    • GlobalExpress
                                                                                                                                                                                                    • 0900ExpressDocs
                                                                                                                                                                                                    • 1200ExpressDocs
                                                                                                                                                                                                    • GlobalExpressDocs
                                                                                                                                                                                                    Uber RUSH
                                                                                                                                                                                                    • Scheduled
                                                                                                                                                                                                    • OnDemand
                                                                                                                                                                                                    UPS
                                                                                                                                                                                                    • Ground
                                                                                                                                                                                                    • UPSStandard
                                                                                                                                                                                                    • UPSSaver
                                                                                                                                                                                                    • Express
                                                                                                                                                                                                    • ExpressPlus
                                                                                                                                                                                                    • Expedited
                                                                                                                                                                                                    • NextDayAir
                                                                                                                                                                                                    • NextDayAirSaver
                                                                                                                                                                                                    • NextDayAirEarlyAM
                                                                                                                                                                                                    • 2ndDayAir
                                                                                                                                                                                                    • 2ndDayAirAM
                                                                                                                                                                                                    • 3DaySelect
                                                                                                                                                                                                    UPS Mail Innovations
                                                                                                                                                                                                    • First
                                                                                                                                                                                                    • Priority
                                                                                                                                                                                                    • ExpeditedMailInnovations
                                                                                                                                                                                                    • PriorityMailInnovations
                                                                                                                                                                                                    • EconomyMailInnovations
                                                                                                                                                                                                    USPS
                                                                                                                                                                                                    • First
                                                                                                                                                                                                    • Priority
                                                                                                                                                                                                    • Express
                                                                                                                                                                                                    • ParcelSelect
                                                                                                                                                                                                    • LibraryMail
                                                                                                                                                                                                    • MediaMail
                                                                                                                                                                                                    • FirstClassMailInternational
                                                                                                                                                                                                    • FirstClassPackageInternationalService
                                                                                                                                                                                                    • PriorityMailInternational
                                                                                                                                                                                                    • ExpressMailInternational
                                                                                                                                                                                                    Yanwen

                                                                                                                                                                                                    No service levels for Yanwen.

                                                                                                                                                                                                      Yodel

                                                                                                                                                                                                      No service levels for Yodel.

                                                                                                                                                                                                        Yun Express

                                                                                                                                                                                                        No service levels for Yun Express.

                                                                                                                                                                                                          GET /shipments/:id/rates

                                                                                                                                                                                                          Regenerate Rates for a Shipment

                                                                                                                                                                                                          You can update the Rates of a Shipment at any time. This operation respects the carrier_accounts attribute.

                                                                                                                                                                                                          Regenerate Rates for Shipment Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/shipments/shp_.../rates \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "shp_vN9h7XLn",
                                                                                                                                                                                                            "object": "Shipment",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "to_address": {
                                                                                                                                                                                                              "id": "adr_zMlCRtmt",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "Redondo Beach",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "90277",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "from_address": {
                                                                                                                                                                                                              "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "EasyPost",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "417 Montgomery Street",
                                                                                                                                                                                                              "street2": "5th Floor",
                                                                                                                                                                                                              "city": "San Francisco",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "94104",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "email": "support@easypost.com",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "parcel": {
                                                                                                                                                                                                              "id": "prcl_SI55pjx8",
                                                                                                                                                                                                              "object": "Parcel",
                                                                                                                                                                                                              "length": 20.2,
                                                                                                                                                                                                              "width": 10.9,
                                                                                                                                                                                                              "height": 5.0,
                                                                                                                                                                                                              "predefined_package": null,
                                                                                                                                                                                                              "weight": 140.8,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "customs_info": {
                                                                                                                                                                                                              "id": "cstinfo_iNAizey5",
                                                                                                                                                                                                              "object": "CustomsInfo",
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "contents_explanation": null,
                                                                                                                                                                                                              "contents_type": "merchandise",
                                                                                                                                                                                                              "customs_certify": false,
                                                                                                                                                                                                              "customs_signer": null,
                                                                                                                                                                                                              "eel_pfc": null,
                                                                                                                                                                                                              "non_delivery_option": "return",
                                                                                                                                                                                                              "restriction_comments": null,
                                                                                                                                                                                                              "restriction_type": "none",
                                                                                                                                                                                                              "customs_items": [
                                                                                                                                                                                                                {
                                                                                                                                                                                                                  "id": "cstitem_9eDIbaDR",
                                                                                                                                                                                                                  "object": "CustomsItem",
                                                                                                                                                                                                                  "description": "Many, many EasyPost stickers.",
                                                                                                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                                                                                                  "origin_country": "US",
                                                                                                                                                                                                                  "quantity": 1,
                                                                                                                                                                                                                  "value": 879,
                                                                                                                                                                                                                  "weight": 140,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              ]
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_nyCb6ubX",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "carrier_account_id": "ca_12345678",
                                                                                                                                                                                                                "service": "FirstClassPackageInternationalService",
                                                                                                                                                                                                                "rate": "9.50",
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "shipment_id": "shp_vN9h7XLn",
                                                                                                                                                                                                                "delivery_days": 4,
                                                                                                                                                                                                                "delivery_date": "2013-04-26T05:40:57Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                "id": "rate_uJh8iO2n",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "carrier_account_id": "ca_12345678",
                                                                                                                                                                                                                "service": "PriorityMailInternational",
                                                                                                                                                                                                                "rate": "27.40",
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "shipment_id": "shp_vN9h7XLn",
                                                                                                                                                                                                                "delivery_days": 2,
                                                                                                                                                                                                                "delivery_date": "2013-04-24T05:40:57Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                "id": "rate_oZqapNpE",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "carrier_account_id": "ca_12345678",
                                                                                                                                                                                                                "service": "ExpressMailInternational",
                                                                                                                                                                                                                "rate": "35.48",
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "shipment_id": "shp_vN9h7XLn",
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2013-04-23T05:40:57Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "selected_rate": null,
                                                                                                                                                                                                            "postage_label": null,
                                                                                                                                                                                                            "tracking_code": null,
                                                                                                                                                                                                            "refund_status": null,
                                                                                                                                                                                                            "insurance": null,
                                                                                                                                                                                                            "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                            "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Messages

                                                                                                                                                                                                          When rating a Shipment or Pickup, some carriers may fail to generate rates. These failures are returned as part of the Shipment or Pickup as part of their messages attribute, and follow a common object structure.

                                                                                                                                                                                                          It is important to note that the message value for any member of this list comes directly from the carrier, not from EasyPost. This means that if you see an authentication or other non-shipping error here, it is not an issue between you and EasyPost, it is an issue between you and the carrier, or an issue with the given data.

                                                                                                                                                                                                          Message Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          carrierstringthe name of the carrier generating the error, e.g. "UPS"
                                                                                                                                                                                                          typestringthe category of error that occurred. Most frequently "rate_error"
                                                                                                                                                                                                          messagestringthe string from the carrier explaining the problem.

                                                                                                                                                                                                          Shipping Insurance

                                                                                                                                                                                                          Insuring your Shipment is as simple as sending us the value of the contents. We charge 1% of the value, with a $1 minimum, and handle all the claims. All our claims are paid out within 30 days.

                                                                                                                                                                                                          To buy insurance, first purchase the Shipment, then make the insurance call before the package begins being handled by the carrier.

                                                                                                                                                                                                          POST /shipments/:id/insure

                                                                                                                                                                                                          Insure a Shipment

                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          amount200.00

                                                                                                                                                                                                          Insure Shipment Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/shipments/shp_.../insure \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'amount=888.50'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "shp_vN9h7XLn",
                                                                                                                                                                                                            "object": "Shipment",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "insurance": "888.50",
                                                                                                                                                                                                            "to_address": {
                                                                                                                                                                                                              "id": "adr_zMlCRtmt",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "Maggie Simpson",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "742 Evergreen Terrace",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "Springfield",
                                                                                                                                                                                                              "state": "KY",
                                                                                                                                                                                                              "zip": "40069",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4163334444",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "from_address": {
                                                                                                                                                                                                              "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "EasyPost",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "417 Montgomery Street",
                                                                                                                                                                                                              "street2": "5th Floor",
                                                                                                                                                                                                              "city": "San Francisco",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "94104",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "email": "support@easypost.com",
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "parcel": {
                                                                                                                                                                                                              "id": "prcl_SI55pjx8",
                                                                                                                                                                                                              "object": "Parcel",
                                                                                                                                                                                                              "length": 20.2,
                                                                                                                                                                                                              "width": 10.9,
                                                                                                                                                                                                              "height": 5.0,
                                                                                                                                                                                                              "predefined_package": null,
                                                                                                                                                                                                              "weight": 140.8,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "customs_info": {
                                                                                                                                                                                                              "id": "cstinfo_iNAizey5",
                                                                                                                                                                                                              "object": "CustomsInfo",
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "contents_explanation": null,
                                                                                                                                                                                                              "contents_type": "merchandise",
                                                                                                                                                                                                              "customs_certify": false,
                                                                                                                                                                                                              "customs_signer": null,
                                                                                                                                                                                                              "eel_pfc": null,
                                                                                                                                                                                                              "non_delivery_option": "return",
                                                                                                                                                                                                              "restriction_comments": null,
                                                                                                                                                                                                              "restriction_type": "none",
                                                                                                                                                                                                              "customs_items": [
                                                                                                                                                                                                                {
                                                                                                                                                                                                                  "id": "cstitem_9eDIbaDR",
                                                                                                                                                                                                                  "object": "CustomsItem",
                                                                                                                                                                                                                  "description": "Many, many EasyPost stickers.",
                                                                                                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                                                                                                  "origin_country": "US",
                                                                                                                                                                                                                  "quantity": 1,
                                                                                                                                                                                                                  "value": 879,
                                                                                                                                                                                                                  "weight": 140,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              ]
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_oZqapNpE",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "service": "ExpressMailInternational",
                                                                                                                                                                                                                "rate": "35.48",
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "shipment_id": "shp_vN9h7XLn",
                                                                                                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "selected_rate": null,
                                                                                                                                                                                                            "postage_label": null,
                                                                                                                                                                                                            "tracking_code": "",
                                                                                                                                                                                                            "refund_status": null,
                                                                                                                                                                                                            "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                            "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Refunds

                                                                                                                                                                                                          USPS shipping labels can be refunded if requested within 30 days of generation. The processing time is 14 days, after which the funds will return to your EasyPost balance. EasyPost fees will also be refunded. To qualify, a shipment must not have been scanned by the USPS, or included on a Scan Form.

                                                                                                                                                                                                          Refunds can be tracked through your Shipments Dashboard by requesting a CSV Report.

                                                                                                                                                                                                          UPS and FedEx shipping labels may be refunded within 90 days of creation.

                                                                                                                                                                                                          POST /shipments/:id/refund

                                                                                                                                                                                                          Refund a Shipment

                                                                                                                                                                                                          Refunding a Shipment is avaliable for many carriers supported by EasyPost. Once the refund has been submitted, refund_status attribute of the Shipment will be populated with one of the possible values: "submitted", "refunded", "rejected". The most common initial status is "submitted". Many carriers require that the refund be processed before the refund_status will move to "refunded". The length of this process depends on the carrier, but no greater than 30 days.

                                                                                                                                                                                                          Refunds created very shortly after a label is generated may be improperly flagged as invalid, but you may retry a refund with the "rejected" status by submitting the same request again. Carriers that are bill-on-scan tend to have refunds attempts return as "not_applicable", which will not change with multiple retries.

                                                                                                                                                                                                          Refund Shipment Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/shipments/shp_.../refund \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "batch_message": null,
                                                                                                                                                                                                            "batch_status": null,
                                                                                                                                                                                                            "created_at": "2013-11-08T15:50:00Z",
                                                                                                                                                                                                            "customs_info": null,
                                                                                                                                                                                                            "from_address": {
                                                                                                                                                                                                              "city": "San Francisco",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "id": "adr_faGeob9S",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "name": "EasyPost",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "phone": "415-379-7678",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "street1": "417 Montgomery Street",
                                                                                                                                                                                                              "street2": "5th Floor",
                                                                                                                                                                                                              "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                                                                                              "zip": "94104"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "id": "shp_vN9h7XLn",
                                                                                                                                                                                                            "insurance": null,
                                                                                                                                                                                                            "is_return": false,
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "object": "Shipment",
                                                                                                                                                                                                            "parcel": {
                                                                                                                                                                                                              "created_at": "2013-11-08T15:49:59Z",
                                                                                                                                                                                                              "height": null,
                                                                                                                                                                                                              "id": "prcl_TXCreKJp",
                                                                                                                                                                                                              "length": null,
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "object": "Parcel",
                                                                                                                                                                                                              "predefined_package": "UPSLetter",
                                                                                                                                                                                                              "updated_at": "2013-11-08T15:49:59Z",
                                                                                                                                                                                                              "weight": 3.0,
                                                                                                                                                                                                              "width": null
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "postage_label": {
                                                                                                                                                                                                              "created_at": "2013-11-08T20:57:32Z",
                                                                                                                                                                                                              "id": "pl_2Np7asmw",
                                                                                                                                                                                                              "integrated_form": "none",
                                                                                                                                                                                                              "label_date": "2013-11-08T20:57:32Z",
                                                                                                                                                                                                              "label_epl2_url": null,
                                                                                                                                                                                                              "label_file_type": "image/png",
                                                                                                                                                                                                              "label_pdf_url": "http://assets.geteasypost.com/postage_labels/label_pdfs/Z7t7o2.pdf",
                                                                                                                                                                                                              "label_resolution": 200,
                                                                                                                                                                                                              "label_size": "4x7",
                                                                                                                                                                                                              "label_type": "default",
                                                                                                                                                                                                              "label_url": "http://assets.geteasypost.com/postage_labels/labels/lUoagDx.png",
                                                                                                                                                                                                              "label_zpl_url": "http://assets.geteasypost.com/postage_labels/label_zpls/GG0F5F.zpl",
                                                                                                                                                                                                              "object": "PostageLabel",
                                                                                                                                                                                                              "updated_at": "2013-11-08T21:11:14Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "carrier": "UPS",
                                                                                                                                                                                                                "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "id": "rate_vWwNuK8z",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "rate": "30.44",
                                                                                                                                                                                                                "service": "NextDayAir",
                                                                                                                                                                                                                "shipment_id": "shp_w1xi76n4",
                                                                                                                                                                                                                "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                "carrier": "UPS",
                                                                                                                                                                                                                "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "id": "rate_kqsS35Cx",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "rate": "60.28",
                                                                                                                                                                                                                "service": "NextDayAirEarlyAM",
                                                                                                                                                                                                                "shipment_id": "shp_w1xi76n4",
                                                                                                                                                                                                                "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "refund_status": "submitted",
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "selected_rate": {
                                                                                                                                                                                                              "carrier": "UPS",
                                                                                                                                                                                                              "created_at": "2013-11-08T15:50:02Z",
                                                                                                                                                                                                              "currency": "USD",
                                                                                                                                                                                                              "id": "rate_vWwNuK8z",
                                                                                                                                                                                                              "object": "Rate",
                                                                                                                                                                                                              "rate": "30.44",
                                                                                                                                                                                                              "service": "NextDayAir",
                                                                                                                                                                                                              "shipment_id": "shp_w1xi76n4",
                                                                                                                                                                                                              "updated_at": "2013-11-08T15:50:02Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "status": "unknown",
                                                                                                                                                                                                            "to_address": {
                                                                                                                                                                                                              "city": "Redondo Beach",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "created_at": "2013-11-08T15:49:58Z",
                                                                                                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                              "id": "adr_EyDCpoii",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "phone": null,
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "updated_at": "2013-11-08T15:49:58Z",
                                                                                                                                                                                                              "zip": "90277"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "tracker": {
                                                                                                                                                                                                              "created_at": "2013-11-08T20:57:32Z",
                                                                                                                                                                                                              "id": "trk_k7oNSa1Q",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "object": "Tracker",
                                                                                                                                                                                                              "shipment_id": "shp_w1xi76n4",
                                                                                                                                                                                                              "status": "unknown",
                                                                                                                                                                                                              "tracking_code": "1ZE6A4850190733810",
                                                                                                                                                                                                              "tracking_details": [ ],
                                                                                                                                                                                                              "updated_at": "2013-11-08T20:58:26Z"
                                                                                                                                                                                                              "public_url": "https://track.easypost.com/djE7...",
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "tracking_code": "1ZE6A4850190733810",
                                                                                                                                                                                                            "updated_at": "2013-11-08T20:58:26Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Returns

                                                                                                                                                                                                          If you are shipping merchandise or other frequently-returned products, you may wish to generate return labels to include with your shipment, for you customer's convenience. EasyPost offers a simple way to submit the same parameters as your initial shipment, but with an additional flag set, that will generate you a return label to receive any return shipments at your original from address.

                                                                                                                                                                                                          It's important for some carriers, with different return billing, to specify a return label even if it's not a return label for an earlier Shipment.

                                                                                                                                                                                                          If doing more than 10,000 USPS Returns in a year, please contact EasyPost for the USPS scan-based return program, which we also offer.

                                                                                                                                                                                                          POST /shipments

                                                                                                                                                                                                          Create Return for a Shipment

                                                                                                                                                                                                          You can easily create return labels. All you need to do is set the is_return parameter to "true", leave the addresses the same as the initial Shipment's creation request and we switch the To and From Addresses for the return Shipment.

                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          is_returntrue
                                                                                                                                                                                                          to_addressthe original Shipment's to_address
                                                                                                                                                                                                          from_addressthe original Shipment's from_address

                                                                                                                                                                                                          Create Return for Shipment Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/shipments \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'shipment[to_address][id]=adr_...' \
                                                                                                                                                                                                            -d 'shipment[from_address][id]=adr_...' \
                                                                                                                                                                                                            -d 'shipment[parcel][id]=prcl_...' \
                                                                                                                                                                                                            -d 'shipment[is_return]=true'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "shp_vN9h7XLn",
                                                                                                                                                                                                            "object": "Shipment",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "to_address": {
                                                                                                                                                                                                              "id": "adr_zMlCRtmt",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "Maggie Simpson",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "742 Evergreen Terrace",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "Springfield",
                                                                                                                                                                                                              "state": "KY",
                                                                                                                                                                                                              "zip": "40069",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4163334444",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "from_address": {
                                                                                                                                                                                                              "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "EasyPost",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "417 Montgomery Street",
                                                                                                                                                                                                              "street2": "5th Floor",
                                                                                                                                                                                                              "city": "San Francisco",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "94104",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4154567890",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "parcel": {
                                                                                                                                                                                                              "id": "prcl_SI55pjx8",
                                                                                                                                                                                                              "object": "Parcel",
                                                                                                                                                                                                              "length": 20.2,
                                                                                                                                                                                                              "width": 10.9,
                                                                                                                                                                                                              "height": 5.0,
                                                                                                                                                                                                              "predefined_package": null,
                                                                                                                                                                                                              "weight": 140.8,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "customs_info": null,
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_oZqapNpE",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "service": "ExpressMailInternational",
                                                                                                                                                                                                                "rate": "35.48",
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "shipment_id": "shp_vN9h7XLn",
                                                                                                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                "id": "rate_Dc5Q9Zfo",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "service": "GXG",
                                                                                                                                                                                                                "rate": "55.41",
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "shipment_id": "shp_vN9h7XLn",
                                                                                                                                                                                                                "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "selected_rate": null,
                                                                                                                                                                                                            "postage_label": null,
                                                                                                                                                                                                            "is_return": true,
                                                                                                                                                                                                            "tracking_code": null,
                                                                                                                                                                                                            "refund_status": null,
                                                                                                                                                                                                            "insurance": null,
                                                                                                                                                                                                            "created_at": "2013-04-22T05:40:57Z",
                                                                                                                                                                                                            "updated_at": "2013-04-22T05:40:57Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Trackers

                                                                                                                                                                                                          A Tracker object contains all of the tracking information for a package. A Tracker is created automatically whenever you buy a Shipment through EasyPost; if you don’t use EasyPost to purchase your shipping labels, you can still track packages through our API by creating a Tracker object directly. Each Tracker is continually updated in the background as the package moves through its life cycle, regardless of whether or not the label was purchased through EasyPost.

                                                                                                                                                                                                          After creation, a Tracker object will be updated periodically based on when the carrier provides EasyPost with new tracking information. This information can be consumed by using our webhooks infrastructure. Every time a Tracker is updated a webhook Event will be sent.

                                                                                                                                                                                                          The Tracker object contains both the current information about the package as well as previous updates. All of the previous updates are stored in the tracking_details array. Each TrackingDetail object contains the status, the message from the carrier, and a TrackingLocation.

                                                                                                                                                                                                          The TrackingLocation contains city, state, country, and zip information about the location where the package was scanned. The information each carrier provides is different, so some carriers may not make use of all of these fields.

                                                                                                                                                                                                          Some Tracker objects may also contain a CarrierDetail, which stores some additional information about the Tracker that the carrier has made available to EasyPost. The CarrierDetail object contains the service and container_type of the package. Additionally, it also stores the est_delivery_date_local and est_delivery_time_local, which provide information about the local delivery time.

                                                                                                                                                                                                          It's worth noting that tracking_codes are not globally unique. Each carrier promises uniqueness for a given tracking_code for a certain period of time, but the length of time varies greatly based on the specific carrier and service level. The carriers do eventually recycle tracking_codes, and for this reason enforcing uniqueness on the tracking_code field is not recommended. EasyPost does, however, prevent the creation of duplicate Trackers based on tracking_code and carrier; duplicate requests by the same User will simply return the original Tracker.

                                                                                                                                                                                                          Tracker Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique identifier, begins with "trk_"
                                                                                                                                                                                                          objectstring"Tracker"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          tracking_codestringThe tracking code provided by the carrier
                                                                                                                                                                                                          statusstringThe current status of the package, possible values are "unknown", "pre_transit", "in_transit", "out_for_delivery", "delivered", "available_for_pickup", "return_to_sender", "failure", "cancelled" or "error"
                                                                                                                                                                                                          signed_bystringThe name of the person who signed for the package (if available)
                                                                                                                                                                                                          weightfloatThe weight of the package as measured by the carrier in ounces (if available)
                                                                                                                                                                                                          est_delivery_datedatetimeThe estimated delivery date provided by the carrier (if available)
                                                                                                                                                                                                          shipment_idstringThe id of the EasyPost Shipment object associated with the Tracker (if any)
                                                                                                                                                                                                          carrierstringThe name of the carrier handling the shipment
                                                                                                                                                                                                          tracking_detailsTrackingDetail arrayArray of the associated TrackingDetail objects
                                                                                                                                                                                                          carrier_detailCarrierDetailThe associated CarrierDetail object (if available)
                                                                                                                                                                                                          public_urlstringURL to a publicly-accessible html page that shows tracking details for this tracker
                                                                                                                                                                                                          feesFee arrayArray of the associated Fee objects
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime

                                                                                                                                                                                                          TrackingDetail Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"TrackingDetail"
                                                                                                                                                                                                          messagestringDescription of the scan event
                                                                                                                                                                                                          statusstringStatus of the package at the time of the scan event, possible values are "unknown", "pre_transit", "in_transit", "out_for_delivery", "delivered", "available_for_pickup", "return_to_sender", "failure", "cancelled" or "error"
                                                                                                                                                                                                          datetimedatetimeThe timestamp when the tracking scan occurred
                                                                                                                                                                                                          sourcestringThe original source of the information for this scan event, usually the carrier
                                                                                                                                                                                                          tracking_locationTrackingLocationThe location associated with the scan event

                                                                                                                                                                                                          TrackingLocation Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"TrackingLocation"
                                                                                                                                                                                                          citystringThe city where the scan event occurred (if available)
                                                                                                                                                                                                          statestringThe state where the scan event occurred (if available)
                                                                                                                                                                                                          countrystringThe country where the scan event occurred (if available)
                                                                                                                                                                                                          zipstringThe postal code where the scan event occurred (if available)

                                                                                                                                                                                                          CarrierDetail Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"CarrierDetail"
                                                                                                                                                                                                          servicestringThe service level the associated shipment was shipped with (if available)
                                                                                                                                                                                                          container_typestringThe type of container the associated shipment was shipped in (if available)
                                                                                                                                                                                                          est_delivery_date_localdateThe estimated delivery date as provided by the carrier, in the local time zone (if available)
                                                                                                                                                                                                          est_delivery_time_localtimeThe estimated delivery time as provided by the carrier, in the local time zone (if available)

                                                                                                                                                                                                          Testing Specific Tracking States

                                                                                                                                                                                                          Sometimes you may want to simulate specific tracking statuses (e.g. "out_for_delivery") within your application to test how your application responds. EasyPost has a set of test tracking_codes that, when sent to the API, respond with specific tracking statuses and send a webhook Event to your test mode URL. The tracking updates that are sent by these tracking_codes will contain canned information, but it will be similar in form to the information normally provided by the carrier you selected.

                                                                                                                                                                                                          Test Tracking Codes

                                                                                                                                                                                                          tracking_codestatus
                                                                                                                                                                                                          EZ1000000001pre_transit
                                                                                                                                                                                                          EZ2000000002in_transit
                                                                                                                                                                                                          EZ3000000003out_for_delivery
                                                                                                                                                                                                          EZ4000000004delivered
                                                                                                                                                                                                          EZ5000000005return_to_sender
                                                                                                                                                                                                          EZ6000000006failure
                                                                                                                                                                                                          EZ7000000007unknown

                                                                                                                                                                                                          Carrier Tracking Strings

                                                                                                                                                                                                          CarrierString Representation
                                                                                                                                                                                                          APCAPC
                                                                                                                                                                                                          AramexAramex
                                                                                                                                                                                                          AsendiaAsendia
                                                                                                                                                                                                          Australia PostAustraliaPost
                                                                                                                                                                                                          BluedartBlueDart
                                                                                                                                                                                                          BoxberryBoxberry
                                                                                                                                                                                                          CainiaoCainiao
                                                                                                                                                                                                          Canada PostCanadaPost
                                                                                                                                                                                                          CanparCanpar
                                                                                                                                                                                                          China PostChinaPost
                                                                                                                                                                                                          ChronopostChronopost
                                                                                                                                                                                                          Colis PrivéColisPrive
                                                                                                                                                                                                          ColissimoColissimo
                                                                                                                                                                                                          CorreiosCorreios
                                                                                                                                                                                                          Correos Costa RicaCorreosCostaRica
                                                                                                                                                                                                          DelhiveryDelhivery
                                                                                                                                                                                                          DelivDeliv
                                                                                                                                                                                                          Deutsche PostDeutschePost
                                                                                                                                                                                                          DHL ExpressDHLExpress
                                                                                                                                                                                                          DHL FreightDHLFreight
                                                                                                                                                                                                          DHL GermanyDHLGermany
                                                                                                                                                                                                          DHL Global MailDHLGlobalMail
                                                                                                                                                                                                          DHL GM InternationalDHLGlobalmailInternational
                                                                                                                                                                                                          DicomDicom
                                                                                                                                                                                                          Direct LinkDirectLink
                                                                                                                                                                                                          DominosDominos
                                                                                                                                                                                                          DPDDPD
                                                                                                                                                                                                          DPD UKDPDUK
                                                                                                                                                                                                          EC FirstclassECFirstclass
                                                                                                                                                                                                          Ecom ExpressEcomExpress
                                                                                                                                                                                                          EMSChinaEMS
                                                                                                                                                                                                          FastwayFastway
                                                                                                                                                                                                          FedExFedEx
                                                                                                                                                                                                          FedEx MailviewFedExMailview
                                                                                                                                                                                                          FedEx UKFedExUK
                                                                                                                                                                                                          FedEx SmartPostFedexSmartPost
                                                                                                                                                                                                          Flyt ExpressFlytExpress
                                                                                                                                                                                                          GlobegisticsGlobegistics
                                                                                                                                                                                                          GLSGLS
                                                                                                                                                                                                          GSOGSO
                                                                                                                                                                                                          Hong Kong PostHongKongPost
                                                                                                                                                                                                          IMEXIMEX
                                                                                                                                                                                                          India PostIndiaPost
                                                                                                                                                                                                          Interlink ExpressInterlinkExpress
                                                                                                                                                                                                          Israel PostIsraelPost
                                                                                                                                                                                                          JP PostJPPost
                                                                                                                                                                                                          La PosteLaPoste
                                                                                                                                                                                                          LaserShipLaserShip
                                                                                                                                                                                                          Latvijas PastsLatvijasPasts
                                                                                                                                                                                                          LieferyLiefery
                                                                                                                                                                                                          LSOLSO
                                                                                                                                                                                                          Nanjing WoyuanNanjingWoyuan
                                                                                                                                                                                                          Network4Network4
                                                                                                                                                                                                          NZ Courier PostNZCourierPost
                                                                                                                                                                                                          New Zealand PostNewZealandPost
                                                                                                                                                                                                          NorcoNorco
                                                                                                                                                                                                          Nova PoshtaNovaPoshta
                                                                                                                                                                                                          OnTracOnTrac
                                                                                                                                                                                                          OnTrac DirectPostOnTracDirectPost
                                                                                                                                                                                                          Orange DSOrangeDS
                                                                                                                                                                                                          ParcelforceParcelforce
                                                                                                                                                                                                          POS MalaysiaPOSMalaysia
                                                                                                                                                                                                          PostmatesPostmates
                                                                                                                                                                                                          PostNLPostNL
                                                                                                                                                                                                          PostNordPostNord
                                                                                                                                                                                                          PurolatorPurolator
                                                                                                                                                                                                          R+L CarriersRLCarriers
                                                                                                                                                                                                          Royal MailRoyalMail
                                                                                                                                                                                                          RR DonnelleyRRDonnelley
                                                                                                                                                                                                          Singapore PostSingaporePost
                                                                                                                                                                                                          SMSA ExpressSMSAExpress
                                                                                                                                                                                                          Spee-DeeSpeeDee
                                                                                                                                                                                                          TNT ExpressTNTExpress
                                                                                                                                                                                                          Uber RUSHUberRUSH
                                                                                                                                                                                                          UPSUPS
                                                                                                                                                                                                          UPS Mail InnovationsUPSMailInnovations
                                                                                                                                                                                                          USPSUSPS
                                                                                                                                                                                                          YanwenYanwen
                                                                                                                                                                                                          YodelYodel
                                                                                                                                                                                                          Yun ExpressYunExpress
                                                                                                                                                                                                          POST /trackers

                                                                                                                                                                                                          Create a Tracker

                                                                                                                                                                                                          A Tracker can be created with only a tracking_code. Optionally, you can provide the carrier parameter, which indicates the carrier the package was shipped with. If no carrier is provided, EasyPost will attempt to determine the carrier based on the tracking_code provided. Providing a carrier parameter is recommended, since some tracking_codes are ambiguous and may match with more than one carrier. In addition, not having to auto-match the carrier will significantly speed up the response time.

                                                                                                                                                                                                          In an effort to reduce wasted resources, EasyPost prevents the creation of duplicate Trackers. A Tracker is considered to be a duplicate if another Tracker with the same tracking_code and carrier was created by the same User in the last three months. In the case where a duplicate request is submitted, the original Tracker will be returned.

                                                                                                                                                                                                          Create Tracker Request Parameters
                                                                                                                                                                                                          paramexampleinfo
                                                                                                                                                                                                          tracking_code9400110898825022579493The tracking code associated with the package you'd like to track
                                                                                                                                                                                                          carrierUSPSThe carrier associated with the tracking_code you provided. The carrier will get auto-detected if none is provided

                                                                                                                                                                                                          Create Tracker Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/trackers \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'tracker[tracking_code]=9400110898825022579493' \
                                                                                                                                                                                                            -d 'tracker[carrier]=USPS'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "trk_c8e0edb5bb284caa934a0d3db23a148z",
                                                                                                                                                                                                            "object": "Tracker",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "tracking_code": "9400110898825022579493",
                                                                                                                                                                                                            "status": "in_transit",
                                                                                                                                                                                                            "created_at": "2016-01-13T21:52:28Z",
                                                                                                                                                                                                            "updated_at": "2016-01-13T21:52:32Z",
                                                                                                                                                                                                            "signed_by": null,
                                                                                                                                                                                                            "weight": null,
                                                                                                                                                                                                            "est_delivery_date": null,
                                                                                                                                                                                                            "shipment_id": null,
                                                                                                                                                                                                            "carrier": "USPS",
                                                                                                                                                                                                            "public_url": "https://track.easypost.com/djE6...",
                                                                                                                                                                                                            "tracking_details": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "TrackingDetail",
                                                                                                                                                                                                                "message": "Shipping Label Created",
                                                                                                                                                                                                                "status": "pre_transit",
                                                                                                                                                                                                                "datetime": "2015-12-31T15:58:00Z",
                                                                                                                                                                                                                "source": "USPS",
                                                                                                                                                                                                                "tracking_location": {
                                                                                                                                                                                                                  "object": "TrackingLocation",
                                                                                                                                                                                                                  "city": "FOUNTAIN VALLEY",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "country": null,
                                                                                                                                                                                                                  "zip": "92708"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "TrackingDetail",
                                                                                                                                                                                                                "message": "Arrived at Post Office",
                                                                                                                                                                                                                "status": "in_transit",
                                                                                                                                                                                                                "datetime": "2016-01-07T06:58:00Z",
                                                                                                                                                                                                                "source": "USPS",
                                                                                                                                                                                                                "tracking_location": {
                                                                                                                                                                                                                  "object": "TrackingLocation",
                                                                                                                                                                                                                  "city": "FOUNTAIN VALLEY",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "country": null,
                                                                                                                                                                                                                  "zip": "92728"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "carrier_detail": null,
                                                                                                                                                                                                            "fees": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "Fee",
                                                                                                                                                                                                                "type": "TrackerFee",
                                                                                                                                                                                                                "amount": "0.00000",
                                                                                                                                                                                                                "charged": true,
                                                                                                                                                                                                                "refunded": false
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /trackers

                                                                                                                                                                                                          Retrieve a list of a Trackers

                                                                                                                                                                                                          The Tracker List is a paginated list of all Tracker objects associated with the given API Key. It accepts a variety of parameters which can be used to modify the scope. The has_more attribute indicates whether or not additional pages can be requested. The recommended way of paginating is to use either the before_id or after_id parameter to specify where the next page begins.

                                                                                                                                                                                                          Using the Tracker List endpoint is the recommended way of retrieving a Tracker by tracking_code or carrier. Unlike the retrieving a Tracker using the Retrieve endpoint, which accepts an id, the List endpoint accepts the tracking_code as the search parameter. Normally, you'll only have one Tracker with a given tracking_code, but it is also possible to further filter those results by including the carrier parameter in your request.

                                                                                                                                                                                                          Retrieve a list of Tracker Request Parameters
                                                                                                                                                                                                          paramexampleinfo
                                                                                                                                                                                                          before_idtrk_c8e0edb5bb284cOptional pagination parameter. Only trackers created before the given ID will be included. May not be used with after_id
                                                                                                                                                                                                          after_idtrk_c8e0edb5bb284cOptional pagination parameter. Only trackers created after the given ID will be included. May not be used with before_id
                                                                                                                                                                                                          start_datetime2016-01-02T00:00:00ZOnly return Trackers created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
                                                                                                                                                                                                          end_datetime2016-01-02T00:00:00ZOnly return Trackers created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
                                                                                                                                                                                                          page_size30The number of Trackers to return on each page. The maximum value is 100
                                                                                                                                                                                                          tracking_code9400110898825022579493Only returns Trackers with the given tracking_code. Useful for retrieving an individual Tracker by tracking_code rather than by ID
                                                                                                                                                                                                          carrierUSPSOnly returns Trackers with the given carrier value

                                                                                                                                                                                                          Retrieve a list of Tracker Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/trackers \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'page_size=2' \
                                                                                                                                                                                                            -d 'start_datetime=2016-01-02T08:50:00Z'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "trackers": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "trk_c8e0edb5bb284caa934a0d3db23a148z",
                                                                                                                                                                                                                "object": "Tracker",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "tracking_code": "9400110898825022579493",
                                                                                                                                                                                                                "status": "in_transit",
                                                                                                                                                                                                                "created_at": "2016-01-13T21:52:28Z",
                                                                                                                                                                                                                "updated_at": "2016-01-13T21:52:32Z",
                                                                                                                                                                                                                "signed_by": null,
                                                                                                                                                                                                                "weight": null,
                                                                                                                                                                                                                "est_delivery_date": null,
                                                                                                                                                                                                                "shipment_id": null,
                                                                                                                                                                                                                "carrier": "USPS",
                                                                                                                                                                                                                "public_url": "https://track.easypost.com/djE6...",
                                                                                                                                                                                                                "tracking_details": [
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "object": "TrackingDetail",
                                                                                                                                                                                                                    "message": "Shipping Label Created",
                                                                                                                                                                                                                    "status": "pre_transit",
                                                                                                                                                                                                                    "datetime": "2015-12-31T15:58:00Z",
                                                                                                                                                                                                                    "source": "USPS",
                                                                                                                                                                                                                    "tracking_location": {
                                                                                                                                                                                                                      "object": "TrackingLocation",
                                                                                                                                                                                                                      "city": "FOUNTAIN VALLEY",
                                                                                                                                                                                                                      "state": "CA",
                                                                                                                                                                                                                      "country": null,
                                                                                                                                                                                                                      "zip": "92708"
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "object": "TrackingDetail",
                                                                                                                                                                                                                    "message": "Arrived at Post Office",
                                                                                                                                                                                                                    "status": "in_transit",
                                                                                                                                                                                                                    "datetime": "2016-01-07T06:58:00Z",
                                                                                                                                                                                                                    "source": "USPS",
                                                                                                                                                                                                                    "tracking_location": {
                                                                                                                                                                                                                      "object": "TrackingLocation",
                                                                                                                                                                                                                      "city": "FOUNTAIN VALLEY",
                                                                                                                                                                                                                      "state": "CA",
                                                                                                                                                                                                                      "country": null,
                                                                                                                                                                                                                      "zip": "92728"
                                                                                                                                                                                                                    }
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                ],
                                                                                                                                                                                                                "carrier_detail": null,
                                                                                                                                                                                                                "fees": [
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "object": "Fee",
                                                                                                                                                                                                                    "type": "TrackerFee",
                                                                                                                                                                                                                    "amount": "0.00000",
                                                                                                                                                                                                                    "charged": true,
                                                                                                                                                                                                                    "refunded": false
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                ]
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "trk_bae2066ac16e45dba07b7c08baf10bc9",
                                                                                                                                                                                                                "object": "Tracker",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "tracking_code": "JW061221982GB",
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "created_at": "2016-01-20T19:22:26Z",
                                                                                                                                                                                                                "updated_at": "2016-01-20T19:22:29Z",
                                                                                                                                                                                                                "signed_by": null,
                                                                                                                                                                                                                "weight": null,
                                                                                                                                                                                                                "est_delivery_date": null,
                                                                                                                                                                                                                "shipment_id": null,
                                                                                                                                                                                                                "carrier": "RoyalMail",
                                                                                                                                                                                                                "tracking_details": [],
                                                                                                                                                                                                                "carrier_detail": null,
                                                                                                                                                                                                                "public_url": "https://track.easypost.com/djE7...",
                                                                                                                                                                                                                "fees": [{
                                                                                                                                                                                                                  "object": "Fee",
                                                                                                                                                                                                                  "type": "TrackerFee",
                                                                                                                                                                                                                  "amount": "0.00000",
                                                                                                                                                                                                                  "charged": true,
                                                                                                                                                                                                                  "refunded": false
                                                                                                                                                                                                                }]
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "has_more": true
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                          
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /trackers/:id

                                                                                                                                                                                                          Retrieve a Tracker

                                                                                                                                                                                                          Retrieve a Tracker by id.

                                                                                                                                                                                                          Retrieve a Tracker Request Parameters
                                                                                                                                                                                                          paramexampleinfo
                                                                                                                                                                                                          idtrk_c8e0edb5bb284caa9Unique, starts with "trk_"

                                                                                                                                                                                                          Retrieve a Tracker Example

                                                                                                                                                                                                          curl -X GET https://easypost.com/api/v2/trackers/trk_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "trk_c8e0edb5bb284caa934a0d3db23a148z",
                                                                                                                                                                                                            "object": "Tracker",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "tracking_code": "9400110898825022579493",
                                                                                                                                                                                                            "status": "in_transit",
                                                                                                                                                                                                            "created_at": "2016-01-13T21:52:28Z",
                                                                                                                                                                                                            "updated_at": "2016-01-15T20:56:56Z",
                                                                                                                                                                                                            "signed_by": null,
                                                                                                                                                                                                            "weight": null,
                                                                                                                                                                                                            "est_delivery_date": null,
                                                                                                                                                                                                            "shipment_id": null,
                                                                                                                                                                                                            "carrier": "USPS",
                                                                                                                                                                                                            "public_url": "https://track.easypost.com/djE8...",
                                                                                                                                                                                                            "tracking_details": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "TrackingDetail",
                                                                                                                                                                                                                "message": "Shipping Label Created",
                                                                                                                                                                                                                "status": "pre_transit",
                                                                                                                                                                                                                "datetime": "2015-12-31T15:58:00Z",
                                                                                                                                                                                                                "source": "USPS",
                                                                                                                                                                                                                "tracking_location": {
                                                                                                                                                                                                                  "object": "TrackingLocation",
                                                                                                                                                                                                                  "city": "FOUNTAIN VALLEY",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "country": null,
                                                                                                                                                                                                                  "zip": "92708"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "TrackingDetail",
                                                                                                                                                                                                                "message": "Arrived at Post Office",
                                                                                                                                                                                                                "status": "in_transit",
                                                                                                                                                                                                                "datetime": "2016-01-07T06:58:00Z",
                                                                                                                                                                                                                "source": "USPS",
                                                                                                                                                                                                                "tracking_location": {
                                                                                                                                                                                                                  "object": "TrackingLocation",
                                                                                                                                                                                                                  "city": "FOUNTAIN VALLEY",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "country": null,
                                                                                                                                                                                                                  "zip": "92728"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "carrier_detail": null,
                                                                                                                                                                                                            "fees": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "Fee",
                                                                                                                                                                                                                "type": "TrackerFee",
                                                                                                                                                                                                                "amount": "0.00000",
                                                                                                                                                                                                                "charged": true,
                                                                                                                                                                                                                "refunded": false
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Batches

                                                                                                                                                                                                          The Batch object allows you to perform operations on multiple Shipments at once. This includes scheduling a Pickup, creating a ScanForm and consolidating labels. Operations performed on Batches are asynchronous and take advantage of our webhoook infrastructure.

                                                                                                                                                                                                          Batch Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "batch_"
                                                                                                                                                                                                          referencestringAn optional field that may be used in place of ID in some API endpoints
                                                                                                                                                                                                          objectstring"Batch"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          statestringThe overall state. Possible values are "creating", "creation_failed", "created", "purchasing", "purchase_failed", "purchased", "label_generating", and "label_generated"
                                                                                                                                                                                                          num_shipmentsintegerThe number of shipments added
                                                                                                                                                                                                          shipmentsBatchShipment array
                                                                                                                                                                                                          statusobjectA map of BatchShipment statuses to the count of BatchShipments with that status. Valid statuses are "postage_purchased", "postage_purchase_failed", "queued_for_purchase", and "creation_failed"
                                                                                                                                                                                                          label_urlstringThe label image url
                                                                                                                                                                                                          scan_formScanFormThe created ScanForm
                                                                                                                                                                                                          pickupPickupThe created Pickup
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime

                                                                                                                                                                                                          BatchShipment Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringThe id of the Shipment. Unique, begins with "shp_"
                                                                                                                                                                                                          referencestringAn optional field that may be used in place of ID in some API endpoints
                                                                                                                                                                                                          batch_statusstringThe current status. Possible values are "postage_purchased", "postage_purchase_failed", "queued_for_purchase", and "creation_failed"
                                                                                                                                                                                                          batch_messagestringA human readable message for any errors that occurred during the Batch's life cycle
                                                                                                                                                                                                          POST /batches

                                                                                                                                                                                                          Create a Batch

                                                                                                                                                                                                          A Batch can be created with or without Shipments. When created with Shipments the initial state will be creating. Once the state changes to created a webhook Event will be sent. When created with no Shipments the initial state will be created and webhook will be sent.

                                                                                                                                                                                                          Create Batch Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/batches \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d "batch[shipments][0][id]=shp_..."
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "batch_...",
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "num_shipments": 1,
                                                                                                                                                                                                            "object": "Batch",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_...",
                                                                                                                                                                                                                "batch_status": "postage_purchased",
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "reference": null
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "state": "created",
                                                                                                                                                                                                            "status": {
                                                                                                                                                                                                              "created": 0,
                                                                                                                                                                                                              "queued_for_purchase": 0,
                                                                                                                                                                                                              "creation_failed": 0,
                                                                                                                                                                                                              "postage_purchased": 0,
                                                                                                                                                                                                              "postage_purchase_failed": 0
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "created_at": "2014-07-22T07:34:39Z",
                                                                                                                                                                                                            "updated_at": "2014-07-22T07:34:39Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /batches/:id/add_shipments

                                                                                                                                                                                                          Add Shipments to a Batch

                                                                                                                                                                                                          Shipments can be added to a Batch throughout its life cycle. Just remember that the state change of a Batch is asynchronous and will fire a webhook Event when the state change is completed.

                                                                                                                                                                                                          Add Shipments to Batch Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          shipments[<Shipment>,<Shipment>,...]

                                                                                                                                                                                                          Add Shipments to Batch Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/batches/batch_.../add_shipments \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'batch[shipments][0][id]=shp_...' \
                                                                                                                                                                                                            -d 'batch[shipments][1][id]=shp_...' \
                                                                                                                                                                                                            ...
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "batch_...",
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "num_shipments": 5,
                                                                                                                                                                                                            "object": "Batch",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              ....
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "state": "creating",
                                                                                                                                                                                                            "status": {
                                                                                                                                                                                                              "created": 0,
                                                                                                                                                                                                              "queued_for_purchase": 0,
                                                                                                                                                                                                              "creation_failed": 0,
                                                                                                                                                                                                              "postage_purchased": 5,
                                                                                                                                                                                                              "postage_purchase_failed": 0
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "created_at": "2014-07-22T07:34:39Z",
                                                                                                                                                                                                            "updated_at": "2014-07-22T07:34:39Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /batches/:id/remove_shipments

                                                                                                                                                                                                          Remove shipments from a Batch

                                                                                                                                                                                                          There could be times when a Shipment needs to be removed from the Batch during its life cycle. Removing a Shipment does not remove it from the consolidated label or ScanForm.

                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          shipments[<Shipment>,<Shipment>,...]

                                                                                                                                                                                                          Remove shipments from Batch Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/batches/batch_.../remove_shipments \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'batch[shipments][0][id]=shp_...' \
                                                                                                                                                                                                            ...
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "batch_...",
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "num_shipments": 1,
                                                                                                                                                                                                            "object": "Batch",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_...",
                                                                                                                                                                                                                "batch_status": "postage_purchased",
                                                                                                                                                                                                                "batch_message": null
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "state": "creating",
                                                                                                                                                                                                            "status": {
                                                                                                                                                                                                              "created": 0,
                                                                                                                                                                                                              "queued_for_purchase": 0,
                                                                                                                                                                                                              "creation_failed": 0,
                                                                                                                                                                                                              "postage_purchased": 1,
                                                                                                                                                                                                              "postage_purchase_failed": 0
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "created_at": "2014-07-22T07:34:39Z",
                                                                                                                                                                                                            "updated_at": "2014-07-22T07:34:39Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /batches/:id/label

                                                                                                                                                                                                          Batch Labels

                                                                                                                                                                                                          One of the advantages of processing Shipments in batches is the ability to consolidate the PostageLabel into one file. This can only be done once for each batch and all Shipments must have a status of postage_purchased.

                                                                                                                                                                                                          Available label formats are 'pdf', 'zpl' or 'epl2' format. Like converting a PostageLabel format, if this process will change the format of the labels they must have been created as PNGs.

                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          file_formatZPL

                                                                                                                                                                                                          Generate label for Batch Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/batches/batch_.../label \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'file_format=epl2'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "batch_...",
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "num_shipments": 4,
                                                                                                                                                                                                            "object": "Batch",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              ....
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "state": "creating",
                                                                                                                                                                                                            "status": {
                                                                                                                                                                                                              "created": 0,
                                                                                                                                                                                                              "queued_for_purchase": 0,
                                                                                                                                                                                                              "creation_failed": 0,
                                                                                                                                                                                                              "postage_purchased": 4,
                                                                                                                                                                                                              "postage_purchase_failed": 0
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "created_at": "2014-07-22T07:34:39Z",
                                                                                                                                                                                                            "updated_at": "2014-07-22T07:34:39Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /batches/:id/scan_form
                                                                                                                                                                                                          POST /scan_forms (see ScanForm )

                                                                                                                                                                                                          Manifesting (SCAN Form)

                                                                                                                                                                                                          See Scan Form rules and Object Definition.

                                                                                                                                                                                                          Generate manifest for Batch Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/batches/batch_.../scan_form \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                          # webhook will be sent to indicate the scan form was created
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "batch_...",
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "num_shipments": 2,
                                                                                                                                                                                                            "object": "Batch",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "scan_form": null,
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              ....
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "state": "creating",
                                                                                                                                                                                                            "status": {
                                                                                                                                                                                                              "created": 2,
                                                                                                                                                                                                              "queued_for_purchase": 0,
                                                                                                                                                                                                              "creation_failed": 0,
                                                                                                                                                                                                              "postage_purchased": 0,
                                                                                                                                                                                                              "postage_purchase_failed": 0
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "label_url": null,
                                                                                                                                                                                                            "created_at": "2014-07-22T07:34:39Z",
                                                                                                                                                                                                            "updated_at": "2014-07-22T07:34:39Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          CustomsInfos

                                                                                                                                                                                                          CustomsInfo objects contain CustomsItem objects and all necessary information for the generation of customs forms required for international shipping.

                                                                                                                                                                                                          Please see the Shipments documentation for examples of including a CustomsInfo object in a shipment.

                                                                                                                                                                                                          CustomsInfo Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with 'cstinfo_'
                                                                                                                                                                                                          objectstring'CustomsInfo'
                                                                                                                                                                                                          eel_pfcstring "EEL" or "PFC"
                                                                                                                                                                                                          value less than $2500: "NOEEI 30.37(a)"; value greater than $2500: see Customs Guide
                                                                                                                                                                                                          contents_typestring"documents", "gift", "merchandise", "returned_goods", "sample", or "other"
                                                                                                                                                                                                          contents_explanationstringHuman readable description of content. Required for certain carriers and always required if contents_type is "other"
                                                                                                                                                                                                          customs_certifybooleanElectronically certify the information provided
                                                                                                                                                                                                          customs_signerstringRequired if customs_certify is true
                                                                                                                                                                                                          non_delivery_optionstring"abandon" or "return", defaults to "return"
                                                                                                                                                                                                          restriction_typestring"none", "other", "quarantine", or "sanitary_phytosanitary_inspection"
                                                                                                                                                                                                          restriction_commentsstringRequired if restriction_type is not "none"
                                                                                                                                                                                                          customs_itemsCustomItem arrayDescribes to products being shipped
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime
                                                                                                                                                                                                          POST /customs_infos

                                                                                                                                                                                                          Create a CustomsInfo

                                                                                                                                                                                                          A CustomsInfo object contains all administrative information for processing customs, as well as a list of CustomsItems. When creating a CustomsInfo, you may store the ID from the response for use later in shipment creation.

                                                                                                                                                                                                          Create CustomsInfo Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          customs_certifytrue
                                                                                                                                                                                                          cutoms_signer"Steve Brule"
                                                                                                                                                                                                          contents_type"merchandise"
                                                                                                                                                                                                          restriction_type"none"
                                                                                                                                                                                                          eel_pfc"NOEEI 30.37(a)"
                                                                                                                                                                                                          customs_items[<CustomsItem>,<CustomsItem>,...]

                                                                                                                                                                                                          Create CustomsInfo Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/customs_infos \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'customs_info[customs_certify]=true' \
                                                                                                                                                                                                            -d 'customs_info[customs_signer]=Steve Brule' \
                                                                                                                                                                                                            -d 'customs_info[contents_type]=merchandise' \
                                                                                                                                                                                                            -d 'customs_info[contents_explanation]=' \
                                                                                                                                                                                                            -d 'customs_info[restriction_type]=none' \
                                                                                                                                                                                                            -d 'customs_info[eel_pfc]=NOEEI 30.37(a)' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][0][id]=cstitem_...' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][1][description]=Sweet shirts' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][1][quantity]=2' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][1][value]=23' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][1][weight]=11' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][1][hs_tariff_number]=654321' \
                                                                                                                                                                                                            -d 'customs_info[customs_items][1][origin_country]=US'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "cstinfo_zN5tbjEd",
                                                                                                                                                                                                            "object": "CustomsInfo",
                                                                                                                                                                                                            "contents_explanation": null,
                                                                                                                                                                                                            "contents_type": "merchandise",
                                                                                                                                                                                                            "customs_certify": true,
                                                                                                                                                                                                            "customs_signer": "Steve Brule",
                                                                                                                                                                                                            "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                                                                                                            "non_delivery_option": "return",
                                                                                                                                                                                                            "restriction_comments": null,
                                                                                                                                                                                                            "restriction_type": "none",
                                                                                                                                                                                                            "customs_items": [{
                                                                                                                                                                                                                "id": "cstitem_OpPpXeny",
                                                                                                                                                                                                                "object": "CustomsItem",
                                                                                                                                                                                                                "description": "T-Shirt",
                                                                                                                                                                                                                "hs_tariff_number": "123456",
                                                                                                                                                                                                                "origin_country": "US",
                                                                                                                                                                                                                "quantity": 1,
                                                                                                                                                                                                                "value": 10,
                                                                                                                                                                                                                "weight": 5,
                                                                                                                                                                                                                "created_at": "2013-04-22T07:17:51Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T07:17:51Z"
                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                "id": "cstitem_VklGOHPs",
                                                                                                                                                                                                                "object": "CustomsItem",
                                                                                                                                                                                                                "description": "Sweet shirts",
                                                                                                                                                                                                                "hs_tariff_number": "654321",
                                                                                                                                                                                                                "origin_country": "US",
                                                                                                                                                                                                                "quantity": 2,
                                                                                                                                                                                                                "value": 23,
                                                                                                                                                                                                                "weight": 11,
                                                                                                                                                                                                                "created_at": "2013-04-22T07:17:51Z",
                                                                                                                                                                                                                "updated_at": "2013-04-22T07:17:51Z"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "created_at": "2013-04-22T07:17:51Z",
                                                                                                                                                                                                            "updated_at": "2013-04-22T07:17:51Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          CustomsItems

                                                                                                                                                                                                          A CustomsItem object describes goods for international shipment and should be created then included in a CustomsInfo object.

                                                                                                                                                                                                          CustomsItem Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with 'cstitem_'
                                                                                                                                                                                                          objectstring'CustomsItem'
                                                                                                                                                                                                          descriptionstringRequired, description of item being shipped
                                                                                                                                                                                                          quantityfloatRequired, greater than zero
                                                                                                                                                                                                          valuefloat (USD)Required, greater than zero, total value (unit value * quantity)
                                                                                                                                                                                                          weightfloat (oz)Required, greater than zero, total weight (unit weight * quantity)
                                                                                                                                                                                                          hs_tariff_numberstringHarmonized Tariff Schedule, e.g. "6109.10.0012" for Men's T-shirts
                                                                                                                                                                                                          codestringSKU/UPC or other product identifier
                                                                                                                                                                                                          origin_countrystringRequired, 2 char country code
                                                                                                                                                                                                          currencystring3 char currency code, default USD
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime
                                                                                                                                                                                                          POST /customs_items

                                                                                                                                                                                                          Create a CustomsItem

                                                                                                                                                                                                          A CustomsItem contains information relating to each product within the package. When creating a customs item, you may store the ID from the response for use later in CustomsInfo creation.

                                                                                                                                                                                                          Create CustomsItem Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          description"T-Shirt"
                                                                                                                                                                                                          quantity1
                                                                                                                                                                                                          weight5
                                                                                                                                                                                                          value10
                                                                                                                                                                                                          hs_tariff_number"123456"
                                                                                                                                                                                                          origin_country"US"

                                                                                                                                                                                                          Create CustomsItem Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/customs_items \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'customs_item[description]=T-shirt' \
                                                                                                                                                                                                            -d 'customs_item[quantity]=1' \
                                                                                                                                                                                                            -d 'customs_item[weight]=5' \
                                                                                                                                                                                                            -d 'customs_item[value]=10' \
                                                                                                                                                                                                            -d 'customs_item[hs_tariff_number]=123456' \
                                                                                                                                                                                                            -d 'customs_item[origin_country]=US'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "cstitem_LeWfJAV4",
                                                                                                                                                                                                            "object": "CustomsItem",
                                                                                                                                                                                                            "description": "T-shirt",
                                                                                                                                                                                                            "quantity": 1,
                                                                                                                                                                                                            "value": 10,
                                                                                                                                                                                                            "weight": 5,
                                                                                                                                                                                                            "code": null,
                                                                                                                                                                                                            "hs_tariff_number": "123456",
                                                                                                                                                                                                            "origin_country": "US",
                                                                                                                                                                                                            "created_at": "2013-04-22T06:56:43Z",
                                                                                                                                                                                                            "updated_at": "2013-04-22T06:56:43Z"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Events

                                                                                                                                                                                                          Webhook Events are triggered by changes in objects you've created via the API. Every time an Event related to one of your objects is created, EasyPost guarantees at least one POST request will be sent to each of the webhook URLs set up for your account. For this reason, we strongly encourage your webhook handler to be idempotent. See the webhooks guide for more information.

                                                                                                                                                                                                          Possible Event Types

                                                                                                                                                                                                          A "tracker.created" Event is created when the initial creation of a Tracker object is complete

                                                                                                                                                                                                          A "tracker.updated" Event is created whenever a Tracker object gets successfully updated

                                                                                                                                                                                                          A "batch.created" Event is created when the initial creation of a Batch object is complete

                                                                                                                                                                                                          A "batch.updated" Event is created whenever the status of a Batch object changes

                                                                                                                                                                                                          A "scan_form.created" Event is created when the initial creation of a ScanForm object is complete

                                                                                                                                                                                                          A "scan_form.updated" Event is created whenever the status of a ScanForm object changes

                                                                                                                                                                                                          An "insurance.purchased" Event is created whenever a standalone Insurance completes purchasing and reporting to the insurer

                                                                                                                                                                                                          An "insurance.cancelled" Event is created whenever a standalone Insurance fails purchasing, is refunded to your account balance, and is not reported to the insurer

                                                                                                                                                                                                          A "refund.successful" Event is created whenever a non-instantaneous Refund request is completed. USPS is the best example of this, as USPS postage takes 15+ days to be refunded after the initial refund creation.

                                                                                                                                                                                                          A "payment.created" Event is created whenever a Bank Account or Credit Card is successfully charged. For credit card charges, this event indicates that the charge is complete and your account balance has already been updated. For bank account transfers (ACH) this indicates the beginning of the transfer process, which may still later fail.

                                                                                                                                                                                                          A "payment.completed" Event is created when a Bank Account transfer is successfully completed and credited to your account balance. In the case of Precredit transfers, the credit was applied at transfer creation time, and this event indicates that the accounting for that transfer is now complete.

                                                                                                                                                                                                          A "payment.failed" Event is created when a Bank Account transfer or Credit Card charge has an issue and cannot be completed. If the bank account transfer was not Precredited, nothing else happens. If the transfer was Precredited, then an EasyPost admin will deduct the balance difference from your account and possibly get in contact with you about your account status.

                                                                                                                                                                                                          Event Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"Event"
                                                                                                                                                                                                          idstringUnique identifier, begins with "evt_"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          descriptionstringResult type and event name, see the "Possible Event Types" section for more information
                                                                                                                                                                                                          previous_attributesobjectPrevious values of relevant result attributes
                                                                                                                                                                                                          resultobjectThe object associated with the Event. See the "object" attribute on the result to determine its specific type
                                                                                                                                                                                                          statusstringThe current status of the event. Possible values are "completed", "failed", "in_queue", "retrying", or "pending" (deprecated)
                                                                                                                                                                                                          pending_urlsstring arrayWebhook URLs that have not yet been successfully notified as of the time this webhook event was sent. The URL receiving the Event will still be listed in pending_urls, as will any other URLs that receive the Event at the same time
                                                                                                                                                                                                          completed_urlsstring arrayWebhook URLs that have already been successfully notified as of the time this webhook was sent
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime

                                                                                                                                                                                                          Fees

                                                                                                                                                                                                          Fee objects are used to represent the breakdown of charges made when purchasing an item on EasyPost. Shipments and Trackers both have associations to Fee objects.

                                                                                                                                                                                                          Each Shipment object will have a Fee of type "LabelFee" to represent the five cents charged by EasyPost for the service. Shipments with postage collected by EasyPost (as opposed to shipments with postage collected directly by the carrier) will have a "PostageFee" according to the postage amount. Insurance on a Shipment will add an "InsuranceFee" with the insurance premium (not the covered value) for the amount. Tracker objects will have a "TrackerFee" with the price, even when a Tracker is free.

                                                                                                                                                                                                          Fee Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"Fee"
                                                                                                                                                                                                          typestringThe name of the category of fee. Possible types are "LabelFee", "PostageFee", "InsuranceFee", and "TrackerFee"
                                                                                                                                                                                                          amountstringUSD value with sub-cent precision
                                                                                                                                                                                                          chargedbooleanWhether EasyPost has successfully charged your account for the fee
                                                                                                                                                                                                          refundedbooleanWhether the Fee has been refunded successfully

                                                                                                                                                                                                          Orders

                                                                                                                                                                                                          The Order object represents a collection of packages and can be used for Multi-Piece Shipments. Like a single Shipment each Order consists of a "to" and "from" Address to be used for each Shipment within the Order. These Addresses will be copied to each Shipment so there is no need to specify them multiple times. Each Shipment must then specify its Parcel, Options, and CustomsInfo.

                                                                                                                                                                                                          An Order created with valid Address and Shipment objects will automatically retrieve available shipping Rate options.

                                                                                                                                                                                                          Order Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "order_"
                                                                                                                                                                                                          objectstring"Order"
                                                                                                                                                                                                          referencestringAn optional field that may be used in place of id in other API endpoints
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          to_addressAddressThe destination address
                                                                                                                                                                                                          from_addressAddressThe origin address
                                                                                                                                                                                                          return_addressAddressThe shipper's address, defaults to from_address
                                                                                                                                                                                                          buyer_addressAddressThe buyer's address, defaults to to_address
                                                                                                                                                                                                          shipmentsShipment arrayAll associated Shipment objects
                                                                                                                                                                                                          ratesRate arrayAll associated Rate objects
                                                                                                                                                                                                          messagesMessage arrayAny carrier errors encountered during rating
                                                                                                                                                                                                          is_returnbooleanSet true to create as a return
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime
                                                                                                                                                                                                          POST /orders

                                                                                                                                                                                                          Create an Order

                                                                                                                                                                                                          An Order is almost exclusively a container for other objects, and thus an Order may reuse many of these objects. Alternatively, all the objects contained within an Order may be created at the same time.

                                                                                                                                                                                                          You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter.

                                                                                                                                                                                                          Create Order Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          reference"my-reference"
                                                                                                                                                                                                          to_address<Address>
                                                                                                                                                                                                          from_address<Address>
                                                                                                                                                                                                          shipments[<Shipment>, <Shipment>, ...]
                                                                                                                                                                                                          carrier_accounts[{"id": "ca_f02596dcabbb46a8ba823280efc277bb"}, ...]

                                                                                                                                                                                                          Create Order Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/orders \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d "order[to_address][id]=adr_..." \
                                                                                                                                                                                                            -d "order[from_address][id]=adr_..." \
                                                                                                                                                                                                            -d "order[shipments][0][parcel][predefined_package]=FedExBox" \
                                                                                                                                                                                                            -d "order[shipments][0][parcel][weight]=10.2" \
                                                                                                                                                                                                            -d "order[shipments][1][parcel][predefined_package]=FedExBox" \
                                                                                                                                                                                                            -d "order[shipments][1][parcel][weight]=17.5"
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "order_b39d44e7059a46c8a787174e8320bf1c",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "is_return": false,
                                                                                                                                                                                                            "options": {"currency": "USD","label_date": null},
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                            "updated_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                            "customs_info": null,
                                                                                                                                                                                                            "to_address": { ... },
                                                                                                                                                                                                            "from_address": { ... },
                                                                                                                                                                                                            "buyer_address": { ... },
                                                                                                                                                                                                            "return_address": { ... },
                                                                                                                                                                                                            "items": [],
                                                                                                                                                                                                            "containers": [],
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                                "updated_at": "2016-02-17T02:51:10Z",
                                                                                                                                                                                                                "is_return": false,
                                                                                                                                                                                                                "messages": [],
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "options": {"currency": "USD", "label_date": null},
                                                                                                                                                                                                                "reference": null,
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "tracking_code": null,
                                                                                                                                                                                                                "batch_id": null,
                                                                                                                                                                                                                "batch_status": null,
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "parcel": {
                                                                                                                                                                                                                  "id": "prcl_071994637e1046ab98a79f96d8b26488",
                                                                                                                                                                                                                  "object": "Parcel",
                                                                                                                                                                                                                  "length": 20.2,
                                                                                                                                                                                                                  "width": 10.9,
                                                                                                                                                                                                                  "height": 5.0,
                                                                                                                                                                                                                  "predefined_package": null,
                                                                                                                                                                                                                  "weight": 17.5,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "customs_info": null,
                                                                                                                                                                                                                "to_address": { ... },
                                                                                                                                                                                                                "from_address": { ... },
                                                                                                                                                                                                                "buyer_address": { ... },
                                                                                                                                                                                                                "return_address": { ... },
                                                                                                                                                                                                                "postage_label": null,
                                                                                                                                                                                                                "rates": [
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_1f168714581b40af965dd740ddf35f69",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "PRIORITY_OVERNIGHT",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "47.36",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 1,
                                                                                                                                                                                                                    "delivery_date": "2016-02-18T10:30:00Z",
                                                                                                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_1567998062c445ab909daf872461d15e",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "STANDARD_OVERNIGHT",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "118.00",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 1,
                                                                                                                                                                                                                    "delivery_date": "2016-02-18T15:00:00Z",
                                                                                                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_f9a9706f99754609a60b2ec512e82cbf",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "FEDEX_GROUND",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "17.96",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 4,
                                                                                                                                                                                                                    "delivery_date": null,
                                                                                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                ],
                                                                                                                                                                                                                "refund_status": null,
                                                                                                                                                                                                                "scan_form": null,
                                                                                                                                                                                                                "selected_rate": null,
                                                                                                                                                                                                                "tracker": null,
                                                                                                                                                                                                                "forms": [],
                                                                                                                                                                                                                "fees": [],
                                                                                                                                                                                                                "object": "Shipment"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_b25c22b64a7f45bd859e826d3701471c",
                                                                                                                                                                                                                "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                                "updated_at": "2016-02-17T02:51:10Z",
                                                                                                                                                                                                                "is_return": false,
                                                                                                                                                                                                                "messages": [],
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "options": {"currency": "USD", "label_date": null},
                                                                                                                                                                                                                "reference": null,
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "tracking_code": null,
                                                                                                                                                                                                                "batch_id": null,
                                                                                                                                                                                                                "batch_status": null,
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "parcel": {
                                                                                                                                                                                                                  "id": "prcl_307ea2f3486544e58d5496fc840f6376",
                                                                                                                                                                                                                  "object": "Parcel",
                                                                                                                                                                                                                  "length": 7.2,
                                                                                                                                                                                                                  "width": 1.9,
                                                                                                                                                                                                                  "height": 1.0,
                                                                                                                                                                                                                  "predefined_package": null,
                                                                                                                                                                                                                  "weight": 10.8,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "customs_info": null,
                                                                                                                                                                                                                "to_address": { ... },
                                                                                                                                                                                                                "from_address": { ... },
                                                                                                                                                                                                                "buyer_address": { ... },
                                                                                                                                                                                                                "return_address": { ... },
                                                                                                                                                                                                                "postage_label": null,
                                                                                                                                                                                                                "rates": [],
                                                                                                                                                                                                                "refund_status": null,
                                                                                                                                                                                                                "scan_form": null,
                                                                                                                                                                                                                "selected_rate": null,
                                                                                                                                                                                                                "tracker": null,
                                                                                                                                                                                                                "forms": [],
                                                                                                                                                                                                                "fees": [],
                                                                                                                                                                                                                "object": "Shipment"
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_1f168714581b40af965dd740ddf35f69",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "PRIORITY_OVERNIGHT",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "47.36",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2016-02-18T10:30:00Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_1567998062c445ab909daf872461d15e",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "STANDARD_OVERNIGHT",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "118.00",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2016-02-18T15:00:00Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_f9a9706f99754609a60b2ec512e82cbf",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "FEDEX_GROUND",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "17.96",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 4,
                                                                                                                                                                                                                "delivery_date": null,
                                                                                                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "object": "Order"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /orders/:id

                                                                                                                                                                                                          Retrieve an Order

                                                                                                                                                                                                          An Order can be retrieved by either its id or reference. However it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced.

                                                                                                                                                                                                          Retrieve Order Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/orders/order_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "order_b39d44e7059a46c8a787174e8320bf1c",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "is_return": false,
                                                                                                                                                                                                            "options": {"currency": "USD","label_date": null},
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                            "updated_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                            "customs_info": null,
                                                                                                                                                                                                            "to_address": {
                                                                                                                                                                                                              "id": "adr_zMlCRtmt",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "Redondo Beach",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "90277",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "from_address": {
                                                                                                                                                                                                              "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "EasyPost",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "417 Montgomery Street",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "San Francisco",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "94104",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "email": "support@easypost.com",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "buyer_address": {
                                                                                                                                                                                                              "id": "adr_zMlCRtmt",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "Redondo Beach",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "90277",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "return_address": {
                                                                                                                                                                                                              "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "name": "EasyPost",
                                                                                                                                                                                                              "company": null,
                                                                                                                                                                                                              "street1": "417 Montgomery Street",
                                                                                                                                                                                                              "street2": null,
                                                                                                                                                                                                              "city": "San Francisco",
                                                                                                                                                                                                              "state": "CA",
                                                                                                                                                                                                              "zip": "94104",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "4153334444",
                                                                                                                                                                                                              "email": "support@easypost.com",
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                              "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "items": [],
                                                                                                                                                                                                            "containers": [],
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                                "updated_at": "2016-02-17T02:51:10Z",
                                                                                                                                                                                                                "is_return": false,
                                                                                                                                                                                                                "messages": [],
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "options": {"currency": "USD", "label_date": null},
                                                                                                                                                                                                                "reference": null,
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "tracking_code": null,
                                                                                                                                                                                                                "batch_id": null,
                                                                                                                                                                                                                "batch_status": null,
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "parcel": {
                                                                                                                                                                                                                  "id": "prcl_071994637e1046ab98a79f96d8b26488",
                                                                                                                                                                                                                  "object": "Parcel",
                                                                                                                                                                                                                  "length": 20.2,
                                                                                                                                                                                                                  "width": 10.9,
                                                                                                                                                                                                                  "height": 5.0,
                                                                                                                                                                                                                  "predefined_package": null,
                                                                                                                                                                                                                  "weight": 17.5,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "customs_info": null,
                                                                                                                                                                                                                "to_address": {
                                                                                                                                                                                                                  "id": "adr_zMlCRtmt",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "90277",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "from_address": {
                                                                                                                                                                                                                  "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "EasyPost",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "San Francisco",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "94104",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "email": "support@easypost.com",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "buyer_address": {
                                                                                                                                                                                                                  "id": "adr_zMlCRtmt",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "90277",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "return_address": {
                                                                                                                                                                                                                  "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "EasyPost",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "San Francisco",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "94104",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "email": "support@easypost.com",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "postage_label": null,
                                                                                                                                                                                                                "rates": [
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_1f168714581b40af965dd740ddf35f69",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "PRIORITY_OVERNIGHT",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "47.36",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 1,
                                                                                                                                                                                                                    "delivery_date": "2016-02-18T10:30:00Z",
                                                                                                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_1567998062c445ab909daf872461d15e",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "STANDARD_OVERNIGHT",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "118.00",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 1,
                                                                                                                                                                                                                    "delivery_date": "2016-02-18T15:00:00Z",
                                                                                                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_f9a9706f99754609a60b2ec512e82cbf",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "FEDEX_GROUND",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "17.96",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 4,
                                                                                                                                                                                                                    "delivery_date": null,
                                                                                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                ],
                                                                                                                                                                                                                "refund_status": null,
                                                                                                                                                                                                                "scan_form": null,
                                                                                                                                                                                                                "selected_rate": null,
                                                                                                                                                                                                                "tracker": null,
                                                                                                                                                                                                                "forms": [],
                                                                                                                                                                                                                "fees": [],
                                                                                                                                                                                                                "object": "Shipment"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_b25c22b64a7f45bd859e826d3701471c",
                                                                                                                                                                                                                "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                                "updated_at": "2016-02-17T02:51:10Z",
                                                                                                                                                                                                                "is_return": false,
                                                                                                                                                                                                                "messages": [],
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "options": {"currency": "USD", "label_date": null},
                                                                                                                                                                                                                "reference": null,
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "tracking_code": null,
                                                                                                                                                                                                                "batch_id": null,
                                                                                                                                                                                                                "batch_status": null,
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "parcel": {
                                                                                                                                                                                                                  "id": "prcl_307ea2f3486544e58d5496fc840f6376",
                                                                                                                                                                                                                  "object": "Parcel",
                                                                                                                                                                                                                  "length": 7.2,
                                                                                                                                                                                                                  "width": 1.9,
                                                                                                                                                                                                                  "height": 1.0,
                                                                                                                                                                                                                  "predefined_package": null,
                                                                                                                                                                                                                  "weight": 10.8,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "customs_info": null,
                                                                                                                                                                                                                "to_address": {
                                                                                                                                                                                                                  "id": "adr_zMlCRtmt",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "90277",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "from_address": {
                                                                                                                                                                                                                  "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "EasyPost",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "San Francisco",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "94104",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "email": "support@easypost.com",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "buyer_address": {
                                                                                                                                                                                                                  "id": "adr_zMlCRtmt",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "Dr. Steve Brule",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "179 N Harbor Dr",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "Redondo Beach",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "90277",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "email": "dr_steve_brule@gmail.com",
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:56Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:56Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "return_address": {
                                                                                                                                                                                                                  "id": "adr_VgoLT6Ex",
                                                                                                                                                                                                                  "object": "Address",
                                                                                                                                                                                                                  "name": "EasyPost",
                                                                                                                                                                                                                  "company": null,
                                                                                                                                                                                                                  "street1": "417 Montgomery Street",
                                                                                                                                                                                                                  "street2": null,
                                                                                                                                                                                                                  "city": "San Francisco",
                                                                                                                                                                                                                  "state": "CA",
                                                                                                                                                                                                                  "zip": "94104",
                                                                                                                                                                                                                  "country": "US",
                                                                                                                                                                                                                  "phone": "4153334444",
                                                                                                                                                                                                                  "email": "support@easypost.com",
                                                                                                                                                                                                                  "mode": "test",
                                                                                                                                                                                                                  "carrier_facility": null,
                                                                                                                                                                                                                  "residential": null,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "postage_label": null,
                                                                                                                                                                                                                "rates": [],
                                                                                                                                                                                                                "refund_status": null,
                                                                                                                                                                                                                "scan_form": null,
                                                                                                                                                                                                                "selected_rate": null,
                                                                                                                                                                                                                "tracker": null,
                                                                                                                                                                                                                "forms": [],
                                                                                                                                                                                                                "fees": [],
                                                                                                                                                                                                                "object": "Shipment"
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_1f168714581b40af965dd740ddf35f69",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "PRIORITY_OVERNIGHT",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "47.36",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2016-02-18T10:30:00Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_1567998062c445ab909daf872461d15e",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "STANDARD_OVERNIGHT",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "118.00",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2016-02-18T15:00:00Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_f9a9706f99754609a60b2ec512e82cbf",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "FEDEX_GROUND",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "17.96",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 4,
                                                                                                                                                                                                                "delivery_date": null,
                                                                                                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "object": "Order"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /orders/:id/buy

                                                                                                                                                                                                          Buy an Order

                                                                                                                                                                                                          To purchase an Order you only need to specify the carrier and service to purchase. This operation populates the tracking_code and postage_label attributes of each Shipment.

                                                                                                                                                                                                          Buy Order Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          carrier"FedEx"
                                                                                                                                                                                                          service"FEDEX_GROUND"

                                                                                                                                                                                                          Buy Order Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/orders/order_.../buy \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d "carrier=FedEx" \
                                                                                                                                                                                                            -d "service=FEDEX_GROUND"
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "order_b39d44e7059a46c8a787174e8320bf1c",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "reference": null,
                                                                                                                                                                                                            "is_return": false,
                                                                                                                                                                                                            "options": {"currency": "USD","label_date": null},
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                            "updated_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                            "customs_info": null,
                                                                                                                                                                                                            "to_address": { ... },
                                                                                                                                                                                                            "from_address": { ... },
                                                                                                                                                                                                            "buyer_address": { ... },
                                                                                                                                                                                                            "return_address": { ... },
                                                                                                                                                                                                            "items": [],
                                                                                                                                                                                                            "containers": [],
                                                                                                                                                                                                            "shipments": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                                "updated_at": "2016-02-17T02:51:10Z",
                                                                                                                                                                                                                "is_return": false,
                                                                                                                                                                                                                "messages": [],
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "options": {"currency": "USD", "label_date": null},
                                                                                                                                                                                                                "reference": null,
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "tracking_code": null,
                                                                                                                                                                                                                "batch_id": null,
                                                                                                                                                                                                                "batch_status": null,
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "parcel": {
                                                                                                                                                                                                                  "id": "prcl_071994637e1046ab98a79f96d8b26488",
                                                                                                                                                                                                                  "object": "Parcel",
                                                                                                                                                                                                                  "length": 20.2,
                                                                                                                                                                                                                  "width": 10.9,
                                                                                                                                                                                                                  "height": 5.0,
                                                                                                                                                                                                                  "predefined_package": null,
                                                                                                                                                                                                                  "weight": 17.5,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "customs_info": null,
                                                                                                                                                                                                                "to_address": { ... },
                                                                                                                                                                                                                "from_address": { ... },
                                                                                                                                                                                                                "buyer_address": { ... },
                                                                                                                                                                                                                "return_address": { ... },
                                                                                                                                                                                                                "postage_label": {
                                                                                                                                                                                                                  "id": "pl_317098e591fc4d0bbc94bf5e7e47668f",
                                                                                                                                                                                                                  "object": "PostageLabel",
                                                                                                                                                                                                                  "created_at": "2016-02-17T03:10:30Z",
                                                                                                                                                                                                                  "updated_at": "2016-02-17T03:10:30Z",
                                                                                                                                                                                                                  "date_advance": 0,
                                                                                                                                                                                                                  "integrated_form": "none",
                                                                                                                                                                                                                  "label_date": "2016-02-17T03:00:16Z",
                                                                                                                                                                                                                  "label_resolution": 200,
                                                                                                                                                                                                                  "label_size": "PAPER_4X6",
                                                                                                                                                                                                                  "label_type": "default",
                                                                                                                                                                                                                  "label_url": "http://assets.geteasypost.com/postage_labels/labels/20160217/5205d36225364da686e2ba8476b565a9.png",
                                                                                                                                                                                                                  "label_file_type": "image/png",
                                                                                                                                                                                                                  "label_pdf_url": null,
                                                                                                                                                                                                                  "label_epl2_url": null,
                                                                                                                                                                                                                  "label_zpl_url": null
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "rates": [
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_1f168714581b40af965dd740ddf35f69",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "PRIORITY_OVERNIGHT",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "47.36",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 1,
                                                                                                                                                                                                                    "delivery_date": "2016-02-18T10:30:00Z",
                                                                                                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_1567998062c445ab909daf872461d15e",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "STANDARD_OVERNIGHT",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "118.00",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 1,
                                                                                                                                                                                                                    "delivery_date": "2016-02-18T15:00:00Z",
                                                                                                                                                                                                                    "delivery_date_guaranteed": true,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "id": "rate_f9a9706f99754609a60b2ec512e82cbf",
                                                                                                                                                                                                                    "object": "Rate",
                                                                                                                                                                                                                    "created_at": null,
                                                                                                                                                                                                                    "updated_at": null,
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "service": "FEDEX_GROUND",
                                                                                                                                                                                                                    "carrier": "FedEx",
                                                                                                                                                                                                                    "rate": "17.96",
                                                                                                                                                                                                                    "currency": "USD",
                                                                                                                                                                                                                    "retail_rate": null,
                                                                                                                                                                                                                    "retail_currency": null,
                                                                                                                                                                                                                    "list_rate": null,
                                                                                                                                                                                                                    "list_currency": null,
                                                                                                                                                                                                                    "delivery_days": 4,
                                                                                                                                                                                                                    "delivery_date": null,
                                                                                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                                                                                    "shipment_id": "shp_b701a9da21424a5f85a09530c9f924aa",
                                                                                                                                                                                                                    "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                ],
                                                                                                                                                                                                                "refund_status": null,
                                                                                                                                                                                                                "scan_form": null,
                                                                                                                                                                                                                "selected_rate": null,
                                                                                                                                                                                                                "tracker": null,
                                                                                                                                                                                                                "forms": [],
                                                                                                                                                                                                                "fees": [],
                                                                                                                                                                                                                "object": "Shipment"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "shp_b25c22b64a7f45bd859e826d3701471c",
                                                                                                                                                                                                                "created_at": "2016-02-17T02:51:04Z",
                                                                                                                                                                                                                "updated_at": "2016-02-17T02:51:10Z",
                                                                                                                                                                                                                "is_return": false,
                                                                                                                                                                                                                "messages": [],
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "options": {"currency": "USD", "label_date": null},
                                                                                                                                                                                                                "reference": null,
                                                                                                                                                                                                                "status": "unknown",
                                                                                                                                                                                                                "tracking_code": null,
                                                                                                                                                                                                                "batch_id": null,
                                                                                                                                                                                                                "batch_status": null,
                                                                                                                                                                                                                "batch_message": null,
                                                                                                                                                                                                                "parcel": {
                                                                                                                                                                                                                  "id": "prcl_307ea2f3486544e58d5496fc840f6376",
                                                                                                                                                                                                                  "object": "Parcel",
                                                                                                                                                                                                                  "length": 7.2,
                                                                                                                                                                                                                  "width": 1.9,
                                                                                                                                                                                                                  "height": 1.0,
                                                                                                                                                                                                                  "predefined_package": null,
                                                                                                                                                                                                                  "weight": 10.8,
                                                                                                                                                                                                                  "created_at": "2013-04-22T05:39:57Z",
                                                                                                                                                                                                                  "updated_at": "2013-04-22T05:39:57Z"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "customs_info": null,
                                                                                                                                                                                                                "to_address": { ... },
                                                                                                                                                                                                                "from_address": { ... },
                                                                                                                                                                                                                "buyer_address": { ... },
                                                                                                                                                                                                                "return_address": { ... },
                                                                                                                                                                                                                "postage_label": {
                                                                                                                                                                                                                  "id": "pl_1a118b22c63f4bf9825437c01f6f9f38",
                                                                                                                                                                                                                  "object": "PostageLabel",
                                                                                                                                                                                                                  "created_at": "2016-02-17T03:10:32Z",
                                                                                                                                                                                                                  "updated_at": "2016-02-17T03:10:32Z",
                                                                                                                                                                                                                  "date_advance": 0,
                                                                                                                                                                                                                  "integrated_form": "none",
                                                                                                                                                                                                                  "label_date": "2016-02-17T03:00:16Z",
                                                                                                                                                                                                                  "label_resolution": 200,
                                                                                                                                                                                                                  "label_size": "PAPER_4X6",
                                                                                                                                                                                                                  "label_type": "default",
                                                                                                                                                                                                                  "label_url": "http://assets.geteasypost.com/postage_labels/labels/20160217/788f130b67f34a92b65b8b6f5c17e792.png",
                                                                                                                                                                                                                  "label_file_type": "image/png",
                                                                                                                                                                                                                  "label_pdf_url": null,
                                                                                                                                                                                                                  "label_epl2_url": null,
                                                                                                                                                                                                                  "label_zpl_url": null
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "rates": [],
                                                                                                                                                                                                                "refund_status": null,
                                                                                                                                                                                                                "scan_form": null,
                                                                                                                                                                                                                "selected_rate": null,
                                                                                                                                                                                                                "tracker": null,
                                                                                                                                                                                                                "forms": [],
                                                                                                                                                                                                                "fees": [],
                                                                                                                                                                                                                "object": "Shipment"
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_1f168714581b40af965dd740ddf35f69",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "PRIORITY_OVERNIGHT",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "47.36",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2016-02-18T10:30:00Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_1567998062c445ab909daf872461d15e",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "STANDARD_OVERNIGHT",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "118.00",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 1,
                                                                                                                                                                                                                "delivery_date": "2016-02-18T15:00:00Z",
                                                                                                                                                                                                                "delivery_date_guaranteed": true,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "rate_f9a9706f99754609a60b2ec512e82cbf",
                                                                                                                                                                                                                "object": "Rate",
                                                                                                                                                                                                                "created_at": null,
                                                                                                                                                                                                                "updated_at": null,
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "service": "FEDEX_GROUND",
                                                                                                                                                                                                                "carrier": "FedEx",
                                                                                                                                                                                                                "rate": "17.96",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "retail_rate": null,
                                                                                                                                                                                                                "retail_currency": null,
                                                                                                                                                                                                                "list_rate": null,
                                                                                                                                                                                                                "list_currency": null,
                                                                                                                                                                                                                "delivery_days": 4,
                                                                                                                                                                                                                "delivery_date": null,
                                                                                                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                                                                                                "est_delivery_days": null,
                                                                                                                                                                                                                "shipment_id": "shp_7a387659db374a8ea197d7bba3009d5d",
                                                                                                                                                                                                                "carrier_account_id": "ca_f02596dcabbb46a8ba823280efc277bb"
                                                                                                                                                                                                              },
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "object": "Order"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Pickups

                                                                                                                                                                                                          The Pickup object allows you to schedule a pickup from your carrier from your customer's residence or place of business. Supported carriers include USPS, UPS, FedEx, and DHL Express.

                                                                                                                                                                                                          After a Pickup is successfully created, it will automatically fetch PickupRates for each CarrierAccount specified that supports scheduled pickups. Then a PickupRate must be selected and purchased before the pickup can be successfully scheduled.

                                                                                                                                                                                                          Pickup Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringunique, begins with "pickup_"
                                                                                                                                                                                                          objectstring"Pickup"
                                                                                                                                                                                                          referencestringAn optional field that may be used in place of ID in some API endpoints
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          statusstringOne of: "unknown", "scheduled", or "canceled"
                                                                                                                                                                                                          min_datetimedatetimeThe earliest time at which the package is available to pick up
                                                                                                                                                                                                          max_datetimedatetimeThe latest time at which the package is available to pick up. Must be later than the min_datetime
                                                                                                                                                                                                          is_account_addressbooleanIs the pickup address the account's address?
                                                                                                                                                                                                          instructionsstringAdditional text to help the driver successfully obtain the package
                                                                                                                                                                                                          messagesMessage arrayA list of messages containing carrier errors encountered during pickup rate generation
                                                                                                                                                                                                          confirmationstringThe confirmation number for a booked pickup from the carrier
                                                                                                                                                                                                          shipmentShipmentThe associated Shipment
                                                                                                                                                                                                          addressAddressThe associated Address
                                                                                                                                                                                                          carrier_accountsCarrierAccount arrayThe list of carriers (if empty, all carriers were used) used to generate pickup rates
                                                                                                                                                                                                          pickup_ratesPickupRate arrayThe list of different pickup rates across valid carrier accounts for the shipment
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime

                                                                                                                                                                                                          PickupRate Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringunique, begins with 'pickuprate_'
                                                                                                                                                                                                          objectstring"PickupRate"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          servicestringservice name
                                                                                                                                                                                                          carrierstringname of carrier
                                                                                                                                                                                                          ratestringthe actual rate quote for this service
                                                                                                                                                                                                          currencystringcurrency for the rate
                                                                                                                                                                                                          pickup_idstringthe ID of the pickup this is a quote for
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime
                                                                                                                                                                                                          POST /pickups

                                                                                                                                                                                                          Create a Pickup

                                                                                                                                                                                                          Creating a Pickup will automatically fetch rates for the given time frame and location.

                                                                                                                                                                                                          Pickups work with existing shipments or a batch and either a fully-specified Address object or id. The examples below assume that a shipment and address have both already been created.

                                                                                                                                                                                                          Create Pickup Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          address<Address>
                                                                                                                                                                                                          shipment<Shipment> (if no batch)
                                                                                                                                                                                                          batch<Batch> (if no shipment)
                                                                                                                                                                                                          carrier_accounts[<CarrierAccount>,<CarrierAccount>,...]
                                                                                                                                                                                                          instructions"Knock loudly"
                                                                                                                                                                                                          reference"my-custom-pickup"
                                                                                                                                                                                                          is_account_addresstrue
                                                                                                                                                                                                          min_datetime2014-10-21 10:30:00
                                                                                                                                                                                                          max_datetime2014-10-22 10:30:00

                                                                                                                                                                                                          Create Pickup Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/pickups \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'pickup[reference]=my-first-pickup' \
                                                                                                                                                                                                            -d 'pickup[min_datetime]=2014-10-20 17:10:00' \
                                                                                                                                                                                                            -d 'pickup[max_datetime]=2014-10-21 10:30:00' \
                                                                                                                                                                                                            -d 'pickup[shipment][id]=shp_...' \
                                                                                                                                                                                                            -d 'pickup[address][id]=adr_...' \
                                                                                                                                                                                                            -d 'pickup[is_account_address]=false' \
                                                                                                                                                                                                            -d 'pickup[instructions]=Special pickup instructions'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                            "object": "Pickup",
                                                                                                                                                                                                            "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "status": "unknown",
                                                                                                                                                                                                            "reference": "my-first-pickup",
                                                                                                                                                                                                            "min_datetime": "2015-03-18T08:00:00Z",
                                                                                                                                                                                                            "max_datetime": "2015-03-18T18:00:00Z",
                                                                                                                                                                                                            "is_account_address": false,
                                                                                                                                                                                                            "instructions": "My special instructions",
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "confirmation": null,
                                                                                                                                                                                                            "address": {
                                                                                                                                                                                                              "id": "adr_72N1gd6k",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "created_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "updated_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "name": "John Smith",
                                                                                                                                                                                                              "company": "",
                                                                                                                                                                                                              "street1": "123 Main St",
                                                                                                                                                                                                              "street2": "",
                                                                                                                                                                                                              "city": "Park City",
                                                                                                                                                                                                              "state": "UT",
                                                                                                                                                                                                              "zip": "84060",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "5551231234",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "federal_tax_id": null,
                                                                                                                                                                                                              "state_tax_id": null
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "carrier_accounts": [],
                                                                                                                                                                                                            "pickup_rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "rate": "5.96",
                                                                                                                                                                                                                "service": "Future-day Pickup",
                                                                                                                                                                                                                "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "carrier": "UPS",
                                                                                                                                                                                                                "pickup_id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                                "id": "pickuprate_092af6ac0opkhsfg72hj23eab18964bf2",
                                                                                                                                                                                                                "object": "PickupRate"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /pickups/:id

                                                                                                                                                                                                          Retrieve a Pickup

                                                                                                                                                                                                          A Pickup object can be retrieved by either an id or reference. However it is recommended to use EasyPost's provided identifiers because uniqueness on reference is not enforced.

                                                                                                                                                                                                          Retrieve Pickup Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/pickups/pck_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                            "object": "Pickup",
                                                                                                                                                                                                            "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "status": "unknown",
                                                                                                                                                                                                            "reference": "my-first-pickup",
                                                                                                                                                                                                            "min_datetime": "2015-03-18T08:00:00Z",
                                                                                                                                                                                                            "max_datetime": "2015-03-18T18:00:00Z",
                                                                                                                                                                                                            "is_account_address": false,
                                                                                                                                                                                                            "instructions": "My special instructions",
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "confirmation": null,
                                                                                                                                                                                                            "address": {
                                                                                                                                                                                                              "id": "adr_72N1gd6k",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "created_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "updated_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "name": "John Smith",
                                                                                                                                                                                                              "company": "",
                                                                                                                                                                                                              "street1": "123 Main St",
                                                                                                                                                                                                              "street2": "",
                                                                                                                                                                                                              "city": "Park City",
                                                                                                                                                                                                              "state": "UT",
                                                                                                                                                                                                              "zip": "84060",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "5551231234",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "federal_tax_id": null,
                                                                                                                                                                                                              "state_tax_id": null
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "carrier_accounts": [],
                                                                                                                                                                                                            "pickup_rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "rate": "5.96",
                                                                                                                                                                                                                "service": "Future-day Pickup",
                                                                                                                                                                                                                "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "carrier": "UPS",
                                                                                                                                                                                                                "pickup_id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                                "id": "pickuprate_092af6ac0opkhsfg72hj23eab18964bf2",
                                                                                                                                                                                                                "object": "PickupRate"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /pickups/:id/buy

                                                                                                                                                                                                          Buy a Pickup

                                                                                                                                                                                                          To purchase a Pickup a PickupRate must be specified by its carrier and service name, instead of its id. The client libraries will handle this automatically if a PickupRate is provided.

                                                                                                                                                                                                          Buy Pickup Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          carrier"UPS"
                                                                                                                                                                                                          service"Same-day Pickup"

                                                                                                                                                                                                          Buy Pickup Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/pickups/pck_.../buy \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'carrier=UPS' \
                                                                                                                                                                                                            -d 'service=Same-Day Pickup'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                            "object": "Pickup",
                                                                                                                                                                                                            "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "status": "scheduled",
                                                                                                                                                                                                            "reference": "my-first-pickup",
                                                                                                                                                                                                            "min_datetime": "2015-03-18T08:00:00Z",
                                                                                                                                                                                                            "max_datetime": "2015-03-18T18:00:00Z",
                                                                                                                                                                                                            "is_account_address": false,
                                                                                                                                                                                                            "instructions": "My special instructions",
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "confirmation": "C377283498",
                                                                                                                                                                                                            "address": {
                                                                                                                                                                                                              "id": "adr_72N1gd6k",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "created_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "updated_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "name": "John Smith",
                                                                                                                                                                                                              "company": "",
                                                                                                                                                                                                              "street1": "123 Main St",
                                                                                                                                                                                                              "street2": "",
                                                                                                                                                                                                              "city": "Park City",
                                                                                                                                                                                                              "state": "UT",
                                                                                                                                                                                                              "zip": "84060",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "5551231234",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "federal_tax_id": null,
                                                                                                                                                                                                              "state_tax_id": null
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "carrier_accounts": [],
                                                                                                                                                                                                            "pickup_rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "rate": "5.96",
                                                                                                                                                                                                                "service": "Future-day Pickup",
                                                                                                                                                                                                                "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "carrier": "UPS",
                                                                                                                                                                                                                "pickup_id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                                "id": "pickuprate_092af6ac0opkhsfg72hj23eab18964bf2",
                                                                                                                                                                                                                "object": "PickupRate"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          POST /pickups/:id/cancel

                                                                                                                                                                                                          Cancel a Pickup

                                                                                                                                                                                                          You may cancel a Pickup anytime before it has been completed. It requires no additional parameters other than the id or reference. The status will change to "canceled" on success.

                                                                                                                                                                                                          Cancel Pickup Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/pickups/pck_.../cancel \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                            "object": "Pickup",
                                                                                                                                                                                                            "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                            "mode": "test",
                                                                                                                                                                                                            "status": "canceled",
                                                                                                                                                                                                            "reference": "my-first-pickup",
                                                                                                                                                                                                            "min_datetime": "2015-03-18T08:00:00Z",
                                                                                                                                                                                                            "max_datetime": "2015-03-18T18:00:00Z",
                                                                                                                                                                                                            "is_account_address": false,
                                                                                                                                                                                                            "instructions": "My special instructions",
                                                                                                                                                                                                            "messages": [],
                                                                                                                                                                                                            "confirmation": "C377283498",
                                                                                                                                                                                                            "address": {
                                                                                                                                                                                                              "id": "adr_72N1gd6k",
                                                                                                                                                                                                              "object": "Address",
                                                                                                                                                                                                              "created_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "updated_at": "2015-03-17T20:03:06Z",
                                                                                                                                                                                                              "name": "John Smith",
                                                                                                                                                                                                              "company": "",
                                                                                                                                                                                                              "street1": "123 Main St",
                                                                                                                                                                                                              "street2": "",
                                                                                                                                                                                                              "city": "Park City",
                                                                                                                                                                                                              "state": "UT",
                                                                                                                                                                                                              "zip": "84060",
                                                                                                                                                                                                              "country": "US",
                                                                                                                                                                                                              "phone": "5551231234",
                                                                                                                                                                                                              "email": null,
                                                                                                                                                                                                              "mode": "test",
                                                                                                                                                                                                              "carrier_facility": null,
                                                                                                                                                                                                              "residential": null,
                                                                                                                                                                                                              "federal_tax_id": null,
                                                                                                                                                                                                              "state_tax_id": null
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "carrier_accounts": [],
                                                                                                                                                                                                            "pickup_rates": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "created_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "currency": "USD",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "rate": "5.96",
                                                                                                                                                                                                                "service": "Future-day Pickup",
                                                                                                                                                                                                                "updated_at": "2015-03-17T20:03:07Z",
                                                                                                                                                                                                                "carrier": "UPS",
                                                                                                                                                                                                                "pickup_id": "pickup_ebae2c59mdk83jsh39ma3a056ab3d1f1",
                                                                                                                                                                                                                "id": "pickuprate_092af6ac0opkhsfg72hj23eab18964bf2",
                                                                                                                                                                                                                "object": "PickupRate"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Reports

                                                                                                                                                                                                          A Report contains a written account of information in a csv file. If you want to create and view a log of all the shipments, trackers or payment logs created within a certain time frame, a Report is useful for that.

                                                                                                                                                                                                          Reports can be generated using the Reports Endpoint. You can create and view Reports created between any time frame defined between the start_date and end_date.

                                                                                                                                                                                                          The Report api can be categorized into 3 types. These types determine which EasyPost Object to produce a Report for, and should be passed as the type in our libraries:

                                                                                                                                                                                                          • shipment
                                                                                                                                                                                                          • payment_log
                                                                                                                                                                                                          • tracker

                                                                                                                                                                                                          Report Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "shprep_" (Shipment Report), "plrep_" (Payment Log Report), or "trkrep_" (Tracker Report)
                                                                                                                                                                                                          objectstring"ShipmentReport", "PaymentLogReport", or "TrackerReport"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          statusstring"new", "available", "failed", or null
                                                                                                                                                                                                          start_datestringA date string in YYYY-MM-DD form eg: "2016-02-02"
                                                                                                                                                                                                          end_datestringA date string in YYYY-MM-DD form eg: "2016-02-03"
                                                                                                                                                                                                          include_childrenbooleanSet true if you would like to include Shipments /Trackers created by child users
                                                                                                                                                                                                          urlstringA url that contains a link to the Report. Expires 30 seconds after retrieving this object
                                                                                                                                                                                                          url_expires_atdatetimeUrl expiring time
                                                                                                                                                                                                          send_emailbooleanSet true if you would like to send an email containing the Report
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime
                                                                                                                                                                                                          POST /reports/:type

                                                                                                                                                                                                          Create a Report

                                                                                                                                                                                                          To create a Report, provide a start_date and end_date that are less than 31 days apart along with any other optional parameter that you would like to specify. A detailed list of Report Object attributes are provided below.

                                                                                                                                                                                                          The expiry on url is 30 seconds. The default status on each new Report is "new". It changes to "available" if the csv file is created successfully or to "failed" when csv creation is unsuccessful. Additionally, null could also be a status.

                                                                                                                                                                                                          When a Report's status changes, a webhook will be created. See our Webhooks Guide for help on Event handling.

                                                                                                                                                                                                          Report Regeneration

                                                                                                                                                                                                          A Report will regenerate if new shipments or payment logs are created after the Report is generated the first time (i.e end_date is later than or same as the Report updated date). You will receive an error if consecutive requests are made to create a Report. This does not hold true for tracker Reports as it is set to always regenerate each time a request is placed.

                                                                                                                                                                                                          Create Report Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          start_date2016-11-02
                                                                                                                                                                                                          end_date2016-12-02
                                                                                                                                                                                                          send_emailtrue

                                                                                                                                                                                                          Create Report Example

                                                                                                                                                                                                          curl -X POST 'https://api.easypost.com/v2/reports/shipment' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d '{"start_date":"2016-10-01","end_date":"2016-10-31"}' \
                                                                                                                                                                                                            -H "Content-Type:Application/json"
                                                                                                                                                                                                          
                                                                                                                                                                                                          curl -X POST 'https://api.easypost.com/v2/reports/payment_log' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d '{"start_date":"2016-10-01","end_date":"2016-10-31"}' \
                                                                                                                                                                                                            -H "Content-Type:Application/json"
                                                                                                                                                                                                          
                                                                                                                                                                                                            curl -X POST 'https://api.easypost.com/v2/reports/tracker' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d '{"start_date":"2016-10-01","end_date":"2016-10-31"}' \
                                                                                                                                                                                                            -H "Content-Type:Application/json"
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "created_at": "2016-12-15T23:49:16Z",
                                                                                                                                                                                                            "end_date": "2016-11-08",
                                                                                                                                                                                                            "id": "shprep_a1b2c3",
                                                                                                                                                                                                            "include_children": false,
                                                                                                                                                                                                            "mode": "production",
                                                                                                                                                                                                            "object": "ShipmentReport",
                                                                                                                                                                                                            "start_date": "2016-10-15",
                                                                                                                                                                                                            "status": "new",
                                                                                                                                                                                                            "updated_at": "2016-12-15T23:49:16Z",
                                                                                                                                                                                                            "url": null,
                                                                                                                                                                                                            "url_expires_at": null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /reports/:type

                                                                                                                                                                                                          Retrieve a list of a Reports

                                                                                                                                                                                                          The Report List is a paginated list of all Report objects associated with the given API Key. It accepts a variety of parameters which can be used to modify the scope. The has_more attribute indicates whether or not additional pages can be requested. The recommended way of paginating is to use either the before_id or after_id parameter to specify where the next page begins.

                                                                                                                                                                                                          Retrieve a list of Report Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          start_date2016-01-02Only return Reports created after this date. Report range defaults to 30 days from this date if end_date isn't passed
                                                                                                                                                                                                          end_date2016-01-31Only return Reports created before this date. Report range defaults to 30 days before this date if start_date isn't passed
                                                                                                                                                                                                          before_idshprep_c8e0edb5efebb28Optional pagination parameter. Only Reports created before the given ID will be included. May not be used with after_id
                                                                                                                                                                                                          after_idshprep_c8e0edbz5zebb4cOptional pagination parameter. Only Reports created after the given ID will be included. May not be used with before_id
                                                                                                                                                                                                          page_size30The number of Reports to return on each page. The maximum value is 100

                                                                                                                                                                                                          Retrieve a list of Report Example

                                                                                                                                                                                                          curl -X GET 'https://www.easypost.com/api/v2/reports/shipment' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'page_size=2'
                                                                                                                                                                                                          
                                                                                                                                                                                                          curl -X GET 'https://www.easypost.com/api/v2/reports/payment_log' \
                                                                                                                                                                                                          -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                          -d 'page_size=2'
                                                                                                                                                                                                          
                                                                                                                                                                                                          curl -X GET 'https://www.easypost.com/api/v2/reports/tracker' \
                                                                                                                                                                                                          -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                          -d 'page_size=2'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "reports": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "created_at": "2016-12-15T23:49:16Z",
                                                                                                                                                                                                                "end_date": "2016-11-08",
                                                                                                                                                                                                                "id": "shprep_a1b2c3",
                                                                                                                                                                                                                "include_children": false,
                                                                                                                                                                                                                "mode": "production",
                                                                                                                                                                                                                "object": "ShipmentReport",
                                                                                                                                                                                                                "start_date": "2016-10-15",
                                                                                                                                                                                                                "status": "available",
                                                                                                                                                                                                                "updated_at": "2016-12-15T23:49:17Z",
                                                                                                                                                                                                                "url": "https://easypost-files....",
                                                                                                                                                                                                                "url_expires_at": "2016-12-15T23:51:04+00:00"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              { ... }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "has_more": true
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /reports/:type/:id

                                                                                                                                                                                                          Retrieve a Report

                                                                                                                                                                                                          Retrieve a Report by id.

                                                                                                                                                                                                          Retrieve Report Request Parameters
                                                                                                                                                                                                          paramexampleinfo
                                                                                                                                                                                                          idshprep_c8e0ecb4bb284caa9Unique. See object definition for possible id prefixes

                                                                                                                                                                                                          Retrieve Report Example

                                                                                                                                                                                                          curl -X GET 'https://api.easypost.com/api/v2/reports/shipment/shprep_...' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                          curl -X GET 'https://api.easypost.com/api/v2/reports/payment_log/plrep_...' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                          curl -X GET 'https://api.easypost.com/api/v2/reports/tracker/trkrep_...' \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "created_at": "2016-12-15T23:49:16Z",
                                                                                                                                                                                                            "end_date": "2016-11-08",
                                                                                                                                                                                                            "id": "shprep_a1b2c3",
                                                                                                                                                                                                            "include_children": false,
                                                                                                                                                                                                            "mode": "production",
                                                                                                                                                                                                            "object": "ShipmentReport",
                                                                                                                                                                                                            "start_date": "2016-10-15",
                                                                                                                                                                                                            "status": "available",
                                                                                                                                                                                                            "updated_at": "2016-12-15T23:49:17Z",
                                                                                                                                                                                                            "url": "https://easypost-files....",
                                                                                                                                                                                                            "url_expires_at": "2016-12-15T23:51:04+00:00"
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          ScanForms

                                                                                                                                                                                                          A ScanForm can be created to speed up and simplify the carrier pickup process. The ScanForm is one document that can be scanned to mark all included tracking codes as "Accepted for Shipment" by the carrier. The following criteria must met before creation:

                                                                                                                                                                                                          • Refunded Shipments cannot be added
                                                                                                                                                                                                          • Each Shipment must have the same origin address
                                                                                                                                                                                                          • Shipments must all be dated (using the label_date option) on or after the date the form is generated
                                                                                                                                                                                                          • Shipments cannot be added to more than one ScanForm
                                                                                                                                                                                                          • Shipments should be provided in the form of an array

                                                                                                                                                                                                          ScanForm Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "sf_"
                                                                                                                                                                                                          objectstring"ScanForm"
                                                                                                                                                                                                          statusstringCurrent status. Possible values are "creating", "created" and "failed"
                                                                                                                                                                                                          messagestringHuman readable message explaining any failures
                                                                                                                                                                                                          addressAddressAddress the will be Shipments shipped from
                                                                                                                                                                                                          tracking_codesstring arrayTracking codes included on the ScanForm
                                                                                                                                                                                                          form_urlstringUrl of the document
                                                                                                                                                                                                          form_file_typestringFile format of the document
                                                                                                                                                                                                          batch_idstringThe id of the associated Batch. Unique, starts with "batch_"
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime
                                                                                                                                                                                                          POST /scan_forms
                                                                                                                                                                                                          POST /batches/:id/scan_form (see Batches Manifesting )

                                                                                                                                                                                                          Create a ScanForm

                                                                                                                                                                                                          A ScanForm can be created in two ways:

                                                                                                                                                                                                          • Add Shipments to a Batch and create a ScanForm for a Batch of Shipments
                                                                                                                                                                                                          • Create a scan-form for shipments directly without adding shipments to a batch

                                                                                                                                                                                                            Note: A Batch is created in the background for Shipments as an intermediate process to creating ScanForms. You can create a ScanForm for 1 or a group of Shipments.

                                                                                                                                                                                                          Create ScanForm Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          shipments[<Shipment>,<Shipment>,...]

                                                                                                                                                                                                          Create ScanForm Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/scan_forms \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'shipments[0][id]=shp_...' \
                                                                                                                                                                                                            -d 'shipments[1][id]=shp_...'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "id":"sf_5fcd15deb9d84483835ed687a73fee7d",
                                                                                                                                                                                                             "object":"ScanForm",
                                                                                                                                                                                                             "created_at":"2017-01-20T22:59:03Z",
                                                                                                                                                                                                             "updated_at":"2017-01-20T22:59:04Z",
                                                                                                                                                                                                             "tracking_codes":[
                                                                                                                                                                                                                "8888888888888888888888"
                                                                                                                                                                                                             ],
                                                                                                                                                                                                             "address":{
                                                                                                                                                                                                                "id":"adr_d5415c4f055c44169cc159d2958d768f",
                                                                                                                                                                                                                "object":"Address",
                                                                                                                                                                                                                "created_at":"2016-10-04T19:08:20Z",
                                                                                                                                                                                                                "updated_at":"2016-10-04T19:08:20Z",
                                                                                                                                                                                                                "name":"EasyPost",
                                                                                                                                                                                                                "company":null,
                                                                                                                                                                                                                "street1":"417 Montgomery Street",
                                                                                                                                                                                                                "street2":"5th Floor",
                                                                                                                                                                                                                "city":"San Francisco",
                                                                                                                                                                                                                "state":"CA",
                                                                                                                                                                                                                "zip":"94104",
                                                                                                                                                                                                                "country":"US",
                                                                                                                                                                                                                "phone":"4153334445",
                                                                                                                                                                                                                "email":"support@easypost.com",
                                                                                                                                                                                                                "mode":"test",
                                                                                                                                                                                                                "carrier_facility":null,
                                                                                                                                                                                                                "residential":null,
                                                                                                                                                                                                                "federal_tax_id":null,
                                                                                                                                                                                                                "state_tax_id":null,
                                                                                                                                                                                                                "verifications":{
                                                                                                                                                                                                          
                                                                                                                                                                                                                }
                                                                                                                                                                                                             },
                                                                                                                                                                                                             "status":"created",
                                                                                                                                                                                                             "message":null,
                                                                                                                                                                                                             "form_url":"https://easypost-files.s3-us-west-2.amazonaws.com/files/scan_form/20170120/27099fe01af34349821e4be06d0cdu7t.pdf",
                                                                                                                                                                                                             "form_file_type":null,
                                                                                                                                                                                                             "batch_id":"batch_6b145453b20740209ddaedef63a4a88k",
                                                                                                                                                                                                             "confirmation":null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /scan_forms

                                                                                                                                                                                                          Retrieve a list of a ScanForms

                                                                                                                                                                                                          The ScanForm List is a paginated list of all ScanForm objects associated with the given API Key. It accepts a variety of parameters which can be used to modify the scope. The has_more attribute indicates whether or not additional pages can be requested. The recommended way of paginating is to use either the before_id or after_id parameter to specify where the next page begins.

                                                                                                                                                                                                          Retrieve a list of ScanForms Request Parameters
                                                                                                                                                                                                          paramexampleinfo
                                                                                                                                                                                                          before_idsf_c8e0edb5bb284cOptional pagination parameter. Only ScanForms created before the given ID will be included. May not be used with after_id
                                                                                                                                                                                                          after_idsf_c8e0edb5bb284cOptional pagination parameter. Only ScanForms created after the given ID will be included. May not be used with before_id
                                                                                                                                                                                                          start_datetime2016-01-02T00:00:00ZOnly return ScanForms created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
                                                                                                                                                                                                          end_datetime2016-01-02T00:00:00ZOnly return ScanForms created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
                                                                                                                                                                                                          page_size20The number of ScanForms to return on each page. The maximum value is 100

                                                                                                                                                                                                          Retrieve a list of ScanForm Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/scan_forms \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'page_size=2'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "scan_forms":[
                                                                                                                                                                                                                {
                                                                                                                                                                                                                   "id":"sf_0853b005a8834d68rada20e60b082a8c",
                                                                                                                                                                                                                   "object":"ScanForm",
                                                                                                                                                                                                                   "created_at":"2017-01-20T23:06:56Z",
                                                                                                                                                                                                                   "updated_at":"2017-01-20T23:06:56Z",
                                                                                                                                                                                                                   "tracking_codes":[
                                                                                                                                                                                                                      "8888888888888888888888"
                                                                                                                                                                                                                   ],
                                                                                                                                                                                                                   "address":{
                                                                                                                                                                                                                      "id":"adr_d5415c4f055c44169cc159d2958dte1c",
                                                                                                                                                                                                                      "object":"Address",
                                                                                                                                                                                                                      "created_at":"2016-10-04T19:08:20Z",
                                                                                                                                                                                                                      "updated_at":"2016-10-04T19:08:20Z",
                                                                                                                                                                                                                      "name":"EasyPost",
                                                                                                                                                                                                                      "company":null,
                                                                                                                                                                                                                      "street1":"417 Montgomery Street",
                                                                                                                                                                                                                      "street2":"5th Floor",
                                                                                                                                                                                                                      "city":"San Francisco",
                                                                                                                                                                                                                      "state":"CA",
                                                                                                                                                                                                                      "zip":"94104",
                                                                                                                                                                                                                      "country":"US",
                                                                                                                                                                                                                      "phone":"4153334445",
                                                                                                                                                                                                                      "email":"support@easypost.com",
                                                                                                                                                                                                                      "mode":"test",
                                                                                                                                                                                                                      "carrier_facility":null,
                                                                                                                                                                                                                      "residential":null,
                                                                                                                                                                                                                      "federal_tax_id":null,
                                                                                                                                                                                                                      "state_tax_id":null,
                                                                                                                                                                                                                      "verifications":{
                                                                                                                                                                                                          
                                                                                                                                                                                                                      }
                                                                                                                                                                                                                   },
                                                                                                                                                                                                                   "status":"created",
                                                                                                                                                                                                                   "message":null,
                                                                                                                                                                                                                   "form_url":"https://easypost-files.s3-us-west-2.amazonaws.com/files/scan_form/20170120/f02edb1487474db2b7dddd36d467e1f1.pdf",
                                                                                                                                                                                                                   "form_file_type":null,
                                                                                                                                                                                                                   "batch_id":"batch_f794b43c04f24010a7a6346d3976klc9",
                                                                                                                                                                                                                   "confirmation":null
                                                                                                                                                                                                                },
                                                                                                                                                                                                                {
                                                                                                                                                                                                                   "id":"sf_36d59c908f5b49cb93802de6d9b07hbb",
                                                                                                                                                                                                                   "object":"ScanForm",
                                                                                                                                                                                                                   "created_at":"2017-01-20T23:06:48Z",
                                                                                                                                                                                                                   "updated_at":"2017-01-20T23:06:48Z",
                                                                                                                                                                                                                   "tracking_codes":[],
                                                                                                                                                                                                                   "address":null,
                                                                                                                                                                                                                   "status":"failed",
                                                                                                                                                                                                                   "message":"A consistent from_address is required to create a USPS ScanForm.",
                                                                                                                                                                                                                   "form_url":null,
                                                                                                                                                                                                                   "form_file_type":null,
                                                                                                                                                                                                                   "batch_id":"batch_89212ca2e32049d0a8818ab3dcb639k0",
                                                                                                                                                                                                                   "confirmation":null
                                                                                                                                                                                                                }
                                                                                                                                                                                                             ],
                                                                                                                                                                                                             "has_more":true
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /scan_forms/:id

                                                                                                                                                                                                          Retrieve a ScanForm

                                                                                                                                                                                                          Retrieve a ScanForm by id.

                                                                                                                                                                                                          Retrieve a ScanForm Request Parameters
                                                                                                                                                                                                          paramexampleinfo
                                                                                                                                                                                                          idsf_c8e0edb5bb284caa9Unique, starts with "sf"

                                                                                                                                                                                                          Retrieve a ScanForm Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/scan_forms/sf_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "id":"sf_5fcd15deb9d84483835ed687a73fee7d",
                                                                                                                                                                                                             "object":"ScanForm",
                                                                                                                                                                                                             "created_at":"2017-01-20T22:59:03Z",
                                                                                                                                                                                                             "updated_at":"2017-01-20T22:59:04Z",
                                                                                                                                                                                                             "tracking_codes":[
                                                                                                                                                                                                                "8888888888888888888888"
                                                                                                                                                                                                             ],
                                                                                                                                                                                                             "address":{
                                                                                                                                                                                                                "id":"adr_d5415c4f055c44169cc159d2958d768f",
                                                                                                                                                                                                                "object":"Address",
                                                                                                                                                                                                                "created_at":"2016-10-04T19:08:20Z",
                                                                                                                                                                                                                "updated_at":"2016-10-04T19:08:20Z",
                                                                                                                                                                                                                "name":"EasyPost",
                                                                                                                                                                                                                "company":null,
                                                                                                                                                                                                                "street1":"417 Montgomery Street",
                                                                                                                                                                                                                "street2":"5th Floor",
                                                                                                                                                                                                                "city":"San Francisco",
                                                                                                                                                                                                                "state":"CA",
                                                                                                                                                                                                                "zip":"94104",
                                                                                                                                                                                                                "country":"US",
                                                                                                                                                                                                                "phone":"4153334445",
                                                                                                                                                                                                                "email":"support@easypost.com",
                                                                                                                                                                                                                "mode":"test",
                                                                                                                                                                                                                "carrier_facility":null,
                                                                                                                                                                                                                "residential":null,
                                                                                                                                                                                                                "federal_tax_id":null,
                                                                                                                                                                                                                "state_tax_id":null,
                                                                                                                                                                                                                "verifications":{
                                                                                                                                                                                                          
                                                                                                                                                                                                                }
                                                                                                                                                                                                             },
                                                                                                                                                                                                             "status":"created",
                                                                                                                                                                                                             "message":null,
                                                                                                                                                                                                             "form_url":"https://easypost-files.s3-us-west-2.amazonaws.com/files/scan_form/20170120/27099fe01af34349821e4be06d0cdu7t.pdf",
                                                                                                                                                                                                             "form_file_type":null,
                                                                                                                                                                                                             "batch_id":"batch_6b145453b20740209ddaedef63a4a88k",
                                                                                                                                                                                                             "confirmation":null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Webhooks

                                                                                                                                                                                                          Each Webhook contains the url which EasyPost will notify whenever an object in our system updates. Several types of objects are processed asynchronously in the EasyPost system, so whenever an object updates, an Event is sent via HTTP POST to each configured webhook URL. The Webhook object provides CRUD operations for all Webhooks.

                                                                                                                                                                                                          Currently, our recommended best practice for securing Webhooks involves using basic authentication and HTTPS on your endpoint. This will help prevent any altering of any information communicated to you by EasyPost, and it will prevent any third parties from masquerading as EasyPost and sending fraudulent data.

                                                                                                                                                                                                          In general, a Webhook's endpoint should return a status code of 2XX. A 200 is preferred, but any 2XX status will indicate to our system that the Webhook request was successful. Endpoints that return a large volume and rate of failures over a period of time will get automatically disabled by the system; a disabled Webhook can be re-enabled using the Webhook update endpoint.

                                                                                                                                                                                                          Webhook Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "hook_"
                                                                                                                                                                                                          objectstring"Webhook"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          urlstringhttp://example.com
                                                                                                                                                                                                          disabled_atdatetimethe timestamp at which the webhook was most recently disabled (if any)
                                                                                                                                                                                                          POST /webhooks

                                                                                                                                                                                                          Create a Webhook

                                                                                                                                                                                                          To create a Webhook, you simply need to provide a url parameter that you wish to receive notifications to.

                                                                                                                                                                                                          Create Webhook Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          urlexample.com

                                                                                                                                                                                                          Create Webhook Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/webhooks \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'webhook[url]=example.com'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "id":"hook_...",
                                                                                                                                                                                                             "object":"Webhook",
                                                                                                                                                                                                             "mode":"production",
                                                                                                                                                                                                             "url":"http://example.com",
                                                                                                                                                                                                             "disabled_at":null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /webhooks

                                                                                                                                                                                                          List a Webhooks

                                                                                                                                                                                                          Retrieve an unpaginated list of all Webhooks available to the authenticated account.

                                                                                                                                                                                                          List Webhook Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/webhooks \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "webhooks":[
                                                                                                                                                                                                                {
                                                                                                                                                                                                                   "id":"hook_...",
                                                                                                                                                                                                                   "object":"Webhook",
                                                                                                                                                                                                                   "mode":"production",
                                                                                                                                                                                                                   "url":"http://requestb.in/uj9j48uj",
                                                                                                                                                                                                                   "disabled_at":null
                                                                                                                                                                                                                },
                                                                                                                                                                                                                {
                                                                                                                                                                                                                   "id":"hook_...",
                                                                                                                                                                                                                   "object":"Webhook",
                                                                                                                                                                                                                   "mode":"production",
                                                                                                                                                                                                                   "url":"http://example.com",
                                                                                                                                                                                                                   "disabled_at":null
                                                                                                                                                                                                                }
                                                                                                                                                                                                             ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /webhooks/:id

                                                                                                                                                                                                          Retrieve a Webhook

                                                                                                                                                                                                          Retrieve a Webhook by id.

                                                                                                                                                                                                          Retrieve Webhook Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          idhook_abc1234

                                                                                                                                                                                                          Retrieve Webhook Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/webhooks/hook_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "id":"hook_...",
                                                                                                                                                                                                             "object":"Webhook",
                                                                                                                                                                                                             "mode":"production",
                                                                                                                                                                                                             "url":"http://example.com",
                                                                                                                                                                                                             "disabled_at":null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          PUT /webhooks/:id

                                                                                                                                                                                                          Update a Webhook

                                                                                                                                                                                                          Enables a Webhook that has been disabled.

                                                                                                                                                                                                          Update Webhook Example

                                                                                                                                                                                                          curl -X PUT https://api.easypost.com/v2/webhooks/hook_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                             "id":"hook_...",
                                                                                                                                                                                                             "object":"Webhook",
                                                                                                                                                                                                             "mode":"production",
                                                                                                                                                                                                             "url":"http://example.com",
                                                                                                                                                                                                             "disabled_at":null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          DELETE /webhooks/:id

                                                                                                                                                                                                          Delete a Webhook

                                                                                                                                                                                                          Delete a Webhook by id.

                                                                                                                                                                                                          Delete Webhook Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          idhook_abc1234

                                                                                                                                                                                                          Delete Webhook Example

                                                                                                                                                                                                          curl -X DELETE https://api.easypost.com/v2/webhooks/hook_... \
                                                                                                                                                                                                            -u <YOUR_TEST/PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {}
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          API Keys

                                                                                                                                                                                                          When performing opterations on API Keys for a specific user, you must be authencicated using a production key.

                                                                                                                                                                                                          API Keys full response structure

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringThe User id of the authenticated User making the API Key request
                                                                                                                                                                                                          childrenarray of API Key response structuresA list of all Child Users presented with ONLY id, children, and key array structures.
                                                                                                                                                                                                          keysAPI Key arrayThe list of all API keys active for an account, both for "test" and "production" modes.

                                                                                                                                                                                                          API Key object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"ApiKey"
                                                                                                                                                                                                          modestring"test" or "production"
                                                                                                                                                                                                          keystringThe actual key value to use for authentication
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          GET /api_keys
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Retrieve a Api Key

                                                                                                                                                                                                          Both production and test keys will be returned a User and all of its children. If the request is authenticated as a Child only the API Keys for that Child will be returned.

                                                                                                                                                                                                          Retrieve Api Key Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/api_keys \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "user_...",
                                                                                                                                                                                                            "keys": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "object": "ApiKey",
                                                                                                                                                                                                                "key": "342sCQQQQQEKypxIg",
                                                                                                                                                                                                                "mode": "test",
                                                                                                                                                                                                                "created_at": "2014-04-09T01:00:01Z"
                                                                                                                                                                                                              }, {
                                                                                                                                                                                                                "object": "ApiKey",
                                                                                                                                                                                                                "key": "dsa3OdoUG1q2fa7D5FBg",
                                                                                                                                                                                                                "mode": "production",
                                                                                                                                                                                                                "created_at": "2014-04-09T01:00:02Z"
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ],
                                                                                                                                                                                                            "children": [
                                                                                                                                                                                                              {
                                                                                                                                                                                                                "id": "user_...",
                                                                                                                                                                                                                "keys": [
                                                                                                                                                                                                                  {
                                                                                                                                                                                                                    "object": "ApiKey",
                                                                                                                                                                                                                    "key": "d32fdddfdfsdf3AA",
                                                                                                                                                                                                                    "mode": "test",
                                                                                                                                                                                                                    "created_at": "2015-02-11T01:01:01Z"
                                                                                                                                                                                                                  }, {
                                                                                                                                                                                                                    "object": "ApiKey",
                                                                                                                                                                                                                    "key": "34363fg11g545345fs",
                                                                                                                                                                                                                    "mode": "production",
                                                                                                                                                                                                                    "created_at": "2015-02-11T01:01:01Z"
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                ],
                                                                                                                                                                                                                "children": []
                                                                                                                                                                                                              }
                                                                                                                                                                                                            ]
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Users

                                                                                                                                                                                                          The User object can be used to manage your own account and to create child accounts. Only a Production mode API key can be used to make requests against the Users API.

                                                                                                                                                                                                          Balance and recharge values on User objects are expressed in higher precision USD.

                                                                                                                                                                                                          User Object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "user_"
                                                                                                                                                                                                          objectstring"User"
                                                                                                                                                                                                          parent_idstringThe ID of the parent user object. Top-level users are defined as users with no parent
                                                                                                                                                                                                          namestringFirst and last name required
                                                                                                                                                                                                          emailstringRequired
                                                                                                                                                                                                          phone_numberstringOptional
                                                                                                                                                                                                          balancestringFormatted as string "XX.XXXXX"
                                                                                                                                                                                                          recharge_amountstringUSD formatted dollars and cents, delimited by a decimal point
                                                                                                                                                                                                          secondary_recharge_amountstringUSD formatted dollars and cents, delimited by a decimal point
                                                                                                                                                                                                          recharge_thresholdstringNumber of cents USD that when your balance drops below, we automatically recharge your account with your primary payment method.
                                                                                                                                                                                                          childrenUser array arrayAll associated children
                                                                                                                                                                                                          POST /users
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Create a User

                                                                                                                                                                                                          There are two kinds of accounts. The first is the standard (parent) User object. It represents your account state, settings, and credentials to log in via the website.

                                                                                                                                                                                                          The second is the child User, which is a User that belongs to a parent. The following example demonstrates creating a parent user; child users are discussed in more depth in their own section.

                                                                                                                                                                                                          Creating a non-child user requires specifically NOT using an API key when making the request. Any User creation attempts made by an authenticated request will be interpreted as the creation of a child.

                                                                                                                                                                                                          Create User Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          nameChad Vader
                                                                                                                                                                                                          password4thedarkside
                                                                                                                                                                                                          password_confirmation4thedarkside
                                                                                                                                                                                                          emailc.vader@example.com
                                                                                                                                                                                                          phone_number555-123-4321

                                                                                                                                                                                                          Create User Example

                                                                                                                                                                                                          # Note that there is no API key submitted with this request,
                                                                                                                                                                                                          # as it must be made unauthenticated to register a new account
                                                                                                                                                                                                          # instead of a child user.
                                                                                                                                                                                                          
                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/users \
                                                                                                                                                                                                            -d 'user[name]=Chad Vader' \
                                                                                                                                                                                                            -d 'user[email]=c.vader@example.com' \
                                                                                                                                                                                                            -d 'user[password]=4theempire' \
                                                                                                                                                                                                            -d 'user[password_confirmation]=4theempire' \
                                                                                                                                                                                                            -d 'user[phone_number]=555-123-4321'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "user_qqUy4rWef",
                                                                                                                                                                                                            "object": "User",
                                                                                                                                                                                                            "parent_id": null,
                                                                                                                                                                                                            "name": "Chad Vader",
                                                                                                                                                                                                            "email": "c.vader@example.com",
                                                                                                                                                                                                            "phone_number": "555-123-4321",
                                                                                                                                                                                                            "balance": "0.00000",
                                                                                                                                                                                                            "price_per_shipment": 5,
                                                                                                                                                                                                            "recharge_amount": "100.00",
                                                                                                                                                                                                            "secondary_recharge_amount": "100.00",
                                                                                                                                                                                                            "recharge_threshold": 0,
                                                                                                                                                                                                            "children": []
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /users/:id
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Retrieve a User

                                                                                                                                                                                                          Each User can be retrieved individually by id. Any id provided must be either the id of the authenticated User or the id of one of its children. Additionally, to retrieve the authenticated User directly no id is required.

                                                                                                                                                                                                          Retrieve User Example

                                                                                                                                                                                                          # Option 1: Accessing the user of the given API key
                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/users \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                          # Option 2: Passing an ID
                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/users/user_... \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "user_qqUy4rWef",
                                                                                                                                                                                                            "object": "User",
                                                                                                                                                                                                            "parent_id": null,
                                                                                                                                                                                                            "name": "Chad Vader",
                                                                                                                                                                                                            "email": "c.vader@example.com",
                                                                                                                                                                                                            "phone_number": "555-123-4321",
                                                                                                                                                                                                            "balance": "1234.99000",
                                                                                                                                                                                                            "price_per_shipment": 5,
                                                                                                                                                                                                            "recharge_amount": "5000.00",
                                                                                                                                                                                                            "secondary_recharge_amount": "250.00",
                                                                                                                                                                                                            "recharge_threshold": "100.00",
                                                                                                                                                                                                            "children": []
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          PUT /users/:id
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Update a User

                                                                                                                                                                                                          Just like retrieving a User they can be updated using the same patterns. Passing an id will allow the update of a child or the authenticated User. Passing no id will update the authenticated User.

                                                                                                                                                                                                          Since children also have the ability to authenticate themselves they can be updated without passing an id. Children may only have their "name" field updated, all other fields are ignored.

                                                                                                                                                                                                          All update requests are considered partial updates. Only attributes specifically passed in will be updated. The current_password attribute is required when updaing email or password.

                                                                                                                                                                                                          Update User Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          email"foo@example.com"
                                                                                                                                                                                                          password"hunter2"
                                                                                                                                                                                                          password_confirmation"hunter2"
                                                                                                                                                                                                          current_password"Cthon98"
                                                                                                                                                                                                          name"Azure Diamond"
                                                                                                                                                                                                          phone_number"555-867-5309"
                                                                                                                                                                                                          recharge_amount"100.00"
                                                                                                                                                                                                          secondary_recharge_amount"50.00"
                                                                                                                                                                                                          recharge_threshold"20.00"

                                                                                                                                                                                                          Update User Example

                                                                                                                                                                                                          # Option 1: Updating the user of the given API key
                                                                                                                                                                                                          curl -X PUT https://api.easypost.com/v2/users \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'user[recharge_threshold]=50.00'
                                                                                                                                                                                                          
                                                                                                                                                                                                          # Option 2: Updating by ID
                                                                                                                                                                                                          curl -X PUT https://api.easypost.com/v2/users/user_... \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'user[name]=Test Child'
                                                                                                                                                                                                          
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "user_qqUy4rWef",
                                                                                                                                                                                                            "object": "User",
                                                                                                                                                                                                            "parent_id": null,
                                                                                                                                                                                                            "name": "Update Me",
                                                                                                                                                                                                            "email": "c.vader@example.com",
                                                                                                                                                                                                            "phone_number": "555-123-4321",
                                                                                                                                                                                                            "balance": "1234.99000",
                                                                                                                                                                                                            "price_per_shipment": 5,
                                                                                                                                                                                                            "recharge_amount": "50.00",
                                                                                                                                                                                                            "secondary_recharge_amount": "250.00",
                                                                                                                                                                                                            "recharge_threshold": "100.00",
                                                                                                                                                                                                            "children": []
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          Child Users

                                                                                                                                                                                                          A child User can be created for the purpose of organizing larger integrations with EasyPost. If you are representing multiple end users, each with their own set of carrier credentials it can make sense to organize them a child User.

                                                                                                                                                                                                          Other than organizing activity and CarrierAccounts the central advantage of a child account is that billing flows through the parent's payment information. This allows the child to not have to duplicate payment information.

                                                                                                                                                                                                          The structure of a child User is identicial to its parent, which means that their representations contain many more properties than are actually used. As well, creating a child User requires almost none of the properties necessary for creating a top-level User.

                                                                                                                                                                                                          POST /users
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Create a Child User

                                                                                                                                                                                                          Children use the billing information of the parent, and are not able to log in to the website. Any User creation attempt made with an authenticated request (via API key or cookie) is assumed to be the creation of a child of that User.

                                                                                                                                                                                                          The name attribute is the only user-settable value on child accounts. It is also optional, as one will automatically generated if it is not supplied.

                                                                                                                                                                                                          Create Child User Request Parameters
                                                                                                                                                                                                          paramexample
                                                                                                                                                                                                          nameImma Child

                                                                                                                                                                                                          Create User Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/users \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'user[name]=Imma Child'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "user_ttUy4rWef",
                                                                                                                                                                                                            "object": "User",
                                                                                                                                                                                                            "parent_id": "user_qqUy3rQer",
                                                                                                                                                                                                            "name": "Imma Child",
                                                                                                                                                                                                            "email": "child_user_ttUy4rWef@example.com",
                                                                                                                                                                                                            "phone_number": "8005550100",
                                                                                                                                                                                                            "balance": "0.00000",
                                                                                                                                                                                                            "price_per_shipment": 5,
                                                                                                                                                                                                            "recharge_amount": "100.00",
                                                                                                                                                                                                            "secondary_recharge_amount": "100.00",
                                                                                                                                                                                                            "recharge_threshold": "0.00",
                                                                                                                                                                                                            "children": []
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          CarrierTypes

                                                                                                                                                                                                          The CarrierType object provides an interface for determining the valid fields of a CarrierAccount. The list of CarrierType objects only changes when a new carrier is added to EasyPost.

                                                                                                                                                                                                          Only one USPS CarrierAccount can be associated with your EasyPost account. Thus, if you have deleted your USPS account it will show in the CarrierType list.

                                                                                                                                                                                                          The CarrierType objects consist of their top level attributes as well as a fields object that contains credentials and sometimes test_credentials sub-objects, which themselves are collections of attributes for CarrierAccount creation as well as metadata about presentation and the naming of said attributes.

                                                                                                                                                                                                          There are a couple special case CarrierAccounts, with structures differing somewhat from the norm. For instance, instead of credentials for EndiciaAccount, it has only auto_link: true, which indicates that it is an account that can be added or removed without any carrier-specific fields.

                                                                                                                                                                                                          The other custom option in the fields list is custom_workflow: true, which indicates that the EasyPost website interface includes special processing for signups for the associated CarrierType. Carriers with a custom workflow will also present their normal credential rules, but it is considered unsafe to directly add a CarrierAccount of this type with these attributes filled out via another source than the EasyPost custom workflow.

                                                                                                                                                                                                          CarrierType object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          objectstring"CarrierType"
                                                                                                                                                                                                          typestringSpecifies the CarrierAccount type. Note that "EndiciaAccount" is the current USPS integration account type
                                                                                                                                                                                                          fieldsfields objectContains at least one of the following keys: "auto_link", "credentials", "test_credentials", and "custom_workflow"

                                                                                                                                                                                                          fields object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          auto_linkbooleanIf this key is present with the value of true, no other attributes are needed for CarrierAccount creation
                                                                                                                                                                                                          custom_workflowbooleanIf this key is present with the value of true, CarrierAccount creation of this type requires extra work not handled by the CarrierAccount standard API
                                                                                                                                                                                                          credentialscredentials objectIf this object is present, required attribute names and their metadata are presented inside
                                                                                                                                                                                                          test_credentialscredentials objectIf this object is present, it contains attribute names and metadata just as the credentials object. It is not required for CarrierAccount creation if you do not plan on using the carrier account for test mode

                                                                                                                                                                                                          attribute objects from credentials/test_credentials

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          namestringThe key for each attribute sub-object within credentials is the name of the attribute for submission on CarrierAccounts
                                                                                                                                                                                                          visibilitystringThere are five possible values, which encode the security need and storage type for each attribute: "visible", "checkbox", "fake", "password", and "masked"
                                                                                                                                                                                                          labelstringMost attributes have generic names, so for clarity a "label" value is provided for clearer representation when rendering forms
                                                                                                                                                                                                          GET /carrier_types
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Retrieve available Carrier Types

                                                                                                                                                                                                          The CarrierType list is an unpaginated list of all carrier types available to the account of the given API key.

                                                                                                                                                                                                          Retrieve available CarrierType Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/carrier_types \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          [
                                                                                                                                                                                                            {
                                                                                                                                                                                                              "object": "CarrierType",
                                                                                                                                                                                                              "type": "EndiciaAccount",
                                                                                                                                                                                                              "readable": "USPS",
                                                                                                                                                                                                              "logo": null,
                                                                                                                                                                                                              "fields": {
                                                                                                                                                                                                                "auto_link": true
                                                                                                                                                                                                              }
                                                                                                                                                                                                            },
                                                                                                                                                                                                            {
                                                                                                                                                                                                              "object": "CarrierType",
                                                                                                                                                                                                              "type": "AramexAccount",
                                                                                                                                                                                                              "readable": "Aramex",
                                                                                                                                                                                                              "logo": null,
                                                                                                                                                                                                              "fields": {
                                                                                                                                                                                                                "credentials": {
                                                                                                                                                                                                                  "username": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "ARAMEX Username"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "password": {
                                                                                                                                                                                                                    "visibility": "password",
                                                                                                                                                                                                                    "label": "ARAMEX Password"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "account_number": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "ARAMEX Account Number"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "account_entity": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "ARAMEX Account Entity"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "account_pin": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "ARAMEX Account Pin"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "account_country": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "ARAMEX Account Country"
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                }
                                                                                                                                                                                                              }
                                                                                                                                                                                                            },
                                                                                                                                                                                                            {
                                                                                                                                                                                                              "object": "CarrierType",
                                                                                                                                                                                                              "type": "CanadaPostAccount",
                                                                                                                                                                                                              "readable": "Canada Post",
                                                                                                                                                                                                              "logo": null,
                                                                                                                                                                                                              "fields": {
                                                                                                                                                                                                                "credentials": {
                                                                                                                                                                                                                  "api_key": {
                                                                                                                                                                                                                    "visibility": "masked",
                                                                                                                                                                                                                    "label": "CanadaPost API Key"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "contract_id": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "CanadaPost Contract ID"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "customer_number": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "CanadaPost Customer Number"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "has_credit_card": {
                                                                                                                                                                                                                    "visibility": "checkbox",
                                                                                                                                                                                                                    "label": "CanadaPost account has credit card?"
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "custom_workflow": true
                                                                                                                                                                                                              }
                                                                                                                                                                                                            }
                                                                                                                                                                                                          ]
                                                                                                                                                                                                          
                                                                                                                                                                                                                

                                                                                                                                                                                                          CarrierAccounts

                                                                                                                                                                                                          A CarrierAccount encapsulates your credentials with the carrier. The CarrierAccount object provides CRUD operations for all CarrierAccounts.

                                                                                                                                                                                                          Each EasyPost account is automatically provided a USPS account managed by EasyPost.

                                                                                                                                                                                                          Other operations, such as Shipment creation, can reference CarrierAccounts to reduce the scope of data returned. For instance, you may have multiple warehouses that need to use distinct FedEx SmartPost credentials to request the correct rates. Rate objects will include a carrier_account_id field which can be used to determine the account used for rating.

                                                                                                                                                                                                          CarrierAccount object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          idstringUnique, begins with "ca_"
                                                                                                                                                                                                          objectstring"CarrierAccount"
                                                                                                                                                                                                          typestringThe name of the carrier type. Note that "EndiciaAccount" is the current USPS integration account type
                                                                                                                                                                                                          fieldsFields objectContains "credentials" and/or "test_credentials", or may be empty
                                                                                                                                                                                                          clonebooleanIf clone is true, only the reference and description are possible to update
                                                                                                                                                                                                          descriptionstringAn optional, user-readable field to help distinguish accounts
                                                                                                                                                                                                          referencestringAn optional field that may be used in place of carrier_account_id in other API endpoints
                                                                                                                                                                                                          readablestringThe name used when displaying a readable value for the type of the account
                                                                                                                                                                                                          credentialsobjectUnlike the "credentials" object contained in "fields", this nullable object contains just raw credential pairs for client library consumption
                                                                                                                                                                                                          test_credentialsobjectUnlike the "test_credentials" object contained in "fields", this nullable object contains just raw test_credential pairs for client library consumption
                                                                                                                                                                                                          created_atdatetime
                                                                                                                                                                                                          updated_atdatetime

                                                                                                                                                                                                          Fields object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          credentialsField objectCredentials used in the production environment.
                                                                                                                                                                                                          test_credentialsField objectCredentials used in the test environment.
                                                                                                                                                                                                          auto_linkbooleanFor USPS this designates that no credentials are required.
                                                                                                                                                                                                          custom_workflowbooleanWhen present, a seperate authentication process will be required through the UI to link this account type.

                                                                                                                                                                                                          Field object

                                                                                                                                                                                                          attributetypespecification
                                                                                                                                                                                                          keystringEach key in the sub-objects of a CarrierAccount's fields is the name of a settable field
                                                                                                                                                                                                          visibilitystringThe visibility value is used to control form field types, and is discussed in the CarrierType section
                                                                                                                                                                                                          labelstringThe label value is used in form rendering to display a more precise field name
                                                                                                                                                                                                          valuestringCheckbox fields use "0" and "1" as False and True, all other field types present plaintext, partly-masked, or masked credential data for reference
                                                                                                                                                                                                          POST /carrier_accounts
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Create a Carrier Account

                                                                                                                                                                                                          CarrierAccount objects may be managed through the EasyPost API using the Production mode API key only. Multiple accounts can be added for a single carrier (with the exception of the USPS).

                                                                                                                                                                                                          The CarrierType of the prefered CarrierAccount should be consulted before attempting to create a new CarrierAccount, as it will inform you of the field names expected by a certain carrier.

                                                                                                                                                                                                          Create CarrierAccount Example

                                                                                                                                                                                                          curl -X POST https://api.easypost.com/v2/carrier_accounts \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'carrier_account[type]=UpsAccount' \
                                                                                                                                                                                                            -d 'carrier_account[description]=NY Location UPS Account' \
                                                                                                                                                                                                            -d 'carrier_account[reference]=my-reference' \
                                                                                                                                                                                                            -d 'carrier_account[credentials][account_number]=A1A1A1' \
                                                                                                                                                                                                            -d 'carrier_account[credentials][user_id]=USERID' \
                                                                                                                                                                                                            -d 'carrier_account[credentials][password]=PASSWORD' \
                                                                                                                                                                                                            -d 'carrier_account[credentials][access_license_number]=ALN'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "ca_27839172aee03918a701",
                                                                                                                                                                                                            "object": "CarrierAccount",
                                                                                                                                                                                                            "type": "UpsAccount",
                                                                                                                                                                                                            "description": "NY Location UPS Account",
                                                                                                                                                                                                            "clone": false,
                                                                                                                                                                                                            "created_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                            "updated_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                            "reference": "my-reference",
                                                                                                                                                                                                            "readable": "UPS",
                                                                                                                                                                                                            "logo": null,
                                                                                                                                                                                                            "fields": {
                                                                                                                                                                                                              "credentials": {
                                                                                                                                                                                                                "account_number": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "UPS Account Number",
                                                                                                                                                                                                                  "value": "A1A1A1"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "access_license_number": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "UPS Access License Number",
                                                                                                                                                                                                                  "value": "ALN"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "user_id": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "UPS.com User ID",
                                                                                                                                                                                                                  "value": "USERID"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "password": {
                                                                                                                                                                                                                  "visibility": "password",
                                                                                                                                                                                                                  "label": "UPS.com Password",
                                                                                                                                                                                                                  "value": "********"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              }
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "credentials": {
                                                                                                                                                                                                              "account_number": "A1A1A1",
                                                                                                                                                                                                              "user_id": "USERID",
                                                                                                                                                                                                              "password": "********",
                                                                                                                                                                                                              "access_license_number": "ALN"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "test_credentials": null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /carrier_accounts
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          List all Carrier Accounts

                                                                                                                                                                                                          Retrieve an unpaginated list of all CarrierAccounts available to the authenticated account. Only Production API keys may be used to retrieve this list, as there is no test mode equivalent.

                                                                                                                                                                                                          List CarrierAccount Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/carrier_accounts \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          [
                                                                                                                                                                                                            {
                                                                                                                                                                                                              "id": "ca_34534634765aa3123",
                                                                                                                                                                                                              "object": "CarrierAccount",
                                                                                                                                                                                                              "type": "EndiciaAccount",
                                                                                                                                                                                                              "clone": true,
                                                                                                                                                                                                              "created_at": "2016-01-13T01:00:00Z",
                                                                                                                                                                                                              "updated_at": "2016-01-13T01:00:00Z",
                                                                                                                                                                                                              "description": "USPS Account",
                                                                                                                                                                                                              "reference": null,
                                                                                                                                                                                                              "readable": "USPS",
                                                                                                                                                                                                              "logo": null,
                                                                                                                                                                                                              "fields": {},
                                                                                                                                                                                                              "credentials": null,
                                                                                                                                                                                                              "test_credentials": null
                                                                                                                                                                                                            },
                                                                                                                                                                                                            {
                                                                                                                                                                                                              "id": "ca_27839172aee03918a701",
                                                                                                                                                                                                              "object": "CarrierAccount",
                                                                                                                                                                                                              "type": "AsendiaAccount",
                                                                                                                                                                                                              "clone": false,
                                                                                                                                                                                                              "created_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                              "updated_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                              "description": "Roswell",
                                                                                                                                                                                                              "reference": "my_custom_carrier",
                                                                                                                                                                                                              "readable": "Asendia USA",
                                                                                                                                                                                                              "logo": "/assets/images/carriers/asendia-logo-ca.png",
                                                                                                                                                                                                              "fields": {
                                                                                                                                                                                                                "credentials": {
                                                                                                                                                                                                                  "account_number": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "Asendia Account Number",
                                                                                                                                                                                                                    "value": "12345"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "company_name": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "Company Name",
                                                                                                                                                                                                                    "value": "CarryMe"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "ftp_username": {
                                                                                                                                                                                                                    "visibility": "visible",
                                                                                                                                                                                                                    "label": "FTP Username",
                                                                                                                                                                                                                    "value": "foouser"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "ftp_password": {
                                                                                                                                                                                                                    "visibility": "password",
                                                                                                                                                                                                                    "label": "FTP Password",
                                                                                                                                                                                                                    "value": "********"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "prioritytracked": {
                                                                                                                                                                                                                    "visibility": "checkbox",
                                                                                                                                                                                                                    "label": "Priority Tracked",
                                                                                                                                                                                                                    "value": "1"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "pmi": {
                                                                                                                                                                                                                    "visibility": "checkbox",
                                                                                                                                                                                                                    "label": "PMI",
                                                                                                                                                                                                                    "value": "0"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "epacket": {
                                                                                                                                                                                                                    "visibility": "checkbox",
                                                                                                                                                                                                                    "label": "ePacket",
                                                                                                                                                                                                                    "value": "1"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "ipa": {
                                                                                                                                                                                                                    "visibility": "checkbox",
                                                                                                                                                                                                                    "label": "IPA",
                                                                                                                                                                                                                    "value": "0"
                                                                                                                                                                                                                  },
                                                                                                                                                                                                                  "isal": {
                                                                                                                                                                                                                    "visibility": "checkbox",
                                                                                                                                                                                                                    "label": "ISAL",
                                                                                                                                                                                                                    "value": "0"
                                                                                                                                                                                                                  }
                                                                                                                                                                                                                }
                                                                                                                                                                                                              },
                                                                                                                                                                                                              "credentials": {
                                                                                                                                                                                                                "account_number": "12345",
                                                                                                                                                                                                                "company_name": "CarryMe",
                                                                                                                                                                                                                "ftp_username": "foouser",
                                                                                                                                                                                                                "ftp_password": "********",
                                                                                                                                                                                                                "prioritytracked": "1",
                                                                                                                                                                                                                "pmi": "0",
                                                                                                                                                                                                                "epacket": "1",
                                                                                                                                                                                                                "ipa": "0",
                                                                                                                                                                                                                "isal": "0"
                                                                                                                                                                                                              },
                                                                                                                                                                                                              "test_credentials": null
                                                                                                                                                                                                            }
                                                                                                                                                                                                          ]
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          GET /carrier_accounts/:id
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Retrieve a CarrierAccount

                                                                                                                                                                                                          Retrieve a CarrierAccount by either its id or reference. However it is recommended to use EasyPost's provided identifiers because we do not enforce a unique reference.

                                                                                                                                                                                                          Retrieve CarrierAccount Example

                                                                                                                                                                                                          curl -X GET https://api.easypost.com/v2/carrier_accounts/ca_... \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "ca_27839172aee03918a701",
                                                                                                                                                                                                            "object": "CarrierAccount",
                                                                                                                                                                                                            "type": "AsendiaAccount",
                                                                                                                                                                                                            "clone": false,
                                                                                                                                                                                                            "created_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                            "updated_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                            "description": "Roswell",
                                                                                                                                                                                                            "reference": "my_custom_carrier",
                                                                                                                                                                                                            "readable": "Asendia USA",
                                                                                                                                                                                                            "logo": null,
                                                                                                                                                                                                            "fields": {
                                                                                                                                                                                                              "credentials": {
                                                                                                                                                                                                                "account_number": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "Asendia Account Number",
                                                                                                                                                                                                                  "value": "12345"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "company_name": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "Company Name",
                                                                                                                                                                                                                  "value": "CarryMe"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "ftp_username": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "FTP Username",
                                                                                                                                                                                                                  "value": "foouser"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "ftp_password": {
                                                                                                                                                                                                                  "visibility": "password",
                                                                                                                                                                                                                  "label": "FTP Password",
                                                                                                                                                                                                                  "value": "********"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "prioritytracked": {
                                                                                                                                                                                                                  "visibility": "checkbox",
                                                                                                                                                                                                                  "label": "Priority Tracked",
                                                                                                                                                                                                                  "value": "1"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "pmi": {
                                                                                                                                                                                                                  "visibility": "checkbox",
                                                                                                                                                                                                                  "label": "PMI",
                                                                                                                                                                                                                  "value": "0"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "epacket": {
                                                                                                                                                                                                                  "visibility": "checkbox",
                                                                                                                                                                                                                  "label": "ePacket",
                                                                                                                                                                                                                  "value": "1"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "ipa": {
                                                                                                                                                                                                                  "visibility": "checkbox",
                                                                                                                                                                                                                  "label": "IPA",
                                                                                                                                                                                                                  "value": "0"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "isal": {
                                                                                                                                                                                                                  "visibility": "checkbox",
                                                                                                                                                                                                                  "label": "ISAL",
                                                                                                                                                                                                                  "value": "0"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              }
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "credentials": {
                                                                                                                                                                                                              "account_number": "12345",
                                                                                                                                                                                                              "company_name": "CarryMe",
                                                                                                                                                                                                              "ftp_username": "foouser",
                                                                                                                                                                                                              "ftp_password": "********",
                                                                                                                                                                                                              "prioritytracked": "1",
                                                                                                                                                                                                              "pmi": "0",
                                                                                                                                                                                                              "epacket": "1",
                                                                                                                                                                                                              "ipa": "0",
                                                                                                                                                                                                              "isal": "0"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "test_credentials": null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          PUT /carrier_accounts/:id
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Update a CarrierAccount

                                                                                                                                                                                                          Updates can be made to description, reference, and any fields in credentials or test_credentials.

                                                                                                                                                                                                          The CarrierType of the CarrierAccount should be consulted before attempting to updating an existing CarrierAccount, as it will inform you of the field names expected by a certain carrier.

                                                                                                                                                                                                          Update CarrierAccount Example

                                                                                                                                                                                                          curl -X PUT https://api.easypost.com/v2/carrier_accounts/ca_... \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>: \
                                                                                                                                                                                                            -d 'carrier_account[description]=FL Location UPS Account' \
                                                                                                                                                                                                            -d 'carrier_account[credentials][account_number]=B2B2B2'
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          {
                                                                                                                                                                                                            "id": "ca_B0jH9G5c",
                                                                                                                                                                                                            "object": "CarrierAccount",
                                                                                                                                                                                                            "type": "UpsAccount",
                                                                                                                                                                                                            "description": "FL Location UPS Account",
                                                                                                                                                                                                            "clone": false,
                                                                                                                                                                                                            "created_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                            "updated_at": "2016-01-13T01:00:01Z",
                                                                                                                                                                                                            "reference": "my-reference",
                                                                                                                                                                                                            "readable": "UPS",
                                                                                                                                                                                                            "logo": null,
                                                                                                                                                                                                            "fields": {
                                                                                                                                                                                                              "credentials": {
                                                                                                                                                                                                                "account_number": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "UPS Account Number",
                                                                                                                                                                                                                  "value": "B2B2B2"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "access_license_number": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "UPS Access License Number",
                                                                                                                                                                                                                  "value": "ALN"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "user_id": {
                                                                                                                                                                                                                  "visibility": "visible",
                                                                                                                                                                                                                  "label": "UPS.com User ID",
                                                                                                                                                                                                                  "value": "USERID"
                                                                                                                                                                                                                },
                                                                                                                                                                                                                "password": {
                                                                                                                                                                                                                  "visibility": "password",
                                                                                                                                                                                                                  "label": "UPS.com Password",
                                                                                                                                                                                                                  "value": "********"
                                                                                                                                                                                                                }
                                                                                                                                                                                                              }
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "credentials": {
                                                                                                                                                                                                              "account_number": "B2B2B2",
                                                                                                                                                                                                              "user_id": "USERID",
                                                                                                                                                                                                              "password": "********",
                                                                                                                                                                                                              "access_license_number": "ALN"
                                                                                                                                                                                                            },
                                                                                                                                                                                                            "test_credentials": null
                                                                                                                                                                                                          }
                                                                                                                                                                                                          
                                                                                                                                                                                                                
                                                                                                                                                                                                          DELETE /carrier_accounts/:id
                                                                                                                                                                                                          Production Only This call will only work with your production API Key.

                                                                                                                                                                                                          Delete a Carrier Account

                                                                                                                                                                                                          CarrierAccount objects may be removed from your account when they become out of date or no longer useful.

                                                                                                                                                                                                          Delete CarrierAccount Example

                                                                                                                                                                                                          curl -X DELETE https://api.easypost.com/v2/carrier_accounts/ca_... \
                                                                                                                                                                                                            -u <YOUR_PRODUCTION_API_KEY>:
                                                                                                                                                                                                          
                                                                                                                                                                                                                  
                                                                                                                                                                                                          { }