Order

Important: This endpoint only works with the following carriers:

AustraliaPost
DHLExpress
DPD
DPDUK
Fastway
FedEx
UPS
Purolator

This legacy feature will only work for grandfathered users. If you are unable to access this feature and feel you should be able to, please contact our Support team.

The Order object represents a collection of packages and is intended only for multi-parcel shipping; please use Shipments for single-parcel shipping. Like a single Shipment, each Order consists of a to_address and from_address, to be used for each Shipment within the Order. These Address objects 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 CustomInfo.

An Order created with a valid Address pair and Parcel nested within the Order's Shipment object will automatically retrieve available shipping Rate options.

Endpoints

Order object

string

Unique, begins with "order_"

object

string

"Order"

reference

string

An optional field that may be used in place of id in other API endpoints

mode

string

"test" or "production"

to_address

Address

The destination address

from_address

Address

The origin address

return_address

Address

The shipper's address, defaults to from_address

buyer_address

Address

The buyer's address, defaults to to_address

shipments

Shipment array

All associated Shipment objects. Maximum of 100.

rates

Rate array

All associated Rate objects

messages

Message array

Any carrier errors encountered during rating

is_return

boolean

Set true to create as a return.

created_at

datetime

When the Order was created

updated_at

datetime

When the Order was last updated

Order Object

{
  "mode": "test",
  "reference": "",
  "is_return": false,
  "options": {
    "currency": "USD",
    "payment": {
      "type": "SENDER"
    }
  },
  "messages": [],
  "created_at": "2024-01-24T00:05:56Z",
  "updated_at": "2024-01-24T00:05:56Z",
  "customs_info": null,
  "from_address": {
    "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
    "object": "Address",
    "created_at": "2024-01-24T00:05:56+00:00",
    "updated_at": "2024-01-24T00:05:56+00:00",
    "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": {}
  },
  "to_address": {
    "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
    "object": "Address",
    "created_at": "2024-01-24T00:05:56+00:00",
    "updated_at": "2024-01-24T00:05:57+00:00",
    "name": "DR. STEVE BRULE",
    "company": null,
    "street1": "179 N HARBOR DR",
    "street2": "",
    "city": "REDONDO BEACH",
    "state": "CA",
    "zip": "90277-2506",
    "country": "US",
    "phone": "8573875756",
    "email": "DR_STEVE_BRULE@GMAIL.COM",
    "mode": "test",
    "carrier_facility": null,
    "residential": false,
    "federal_tax_id": null,
    "state_tax_id": null,
    "verifications": {
      "zip4": {
        "success": true,
        "errors": [],
        "details": null
      },
      "delivery": {
        "success": true,
        "errors": [],
        "details": {
          "latitude": 33.8436,
          "longitude": -118.39177,
          "time_zone": "America/Los_Angeles"
        }
      }
    }
  },
  "buyer_address": {
    "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
    "object": "Address",
    "created_at": "2024-01-24T00:05:56+00:00",
    "updated_at": "2024-01-24T00:05:57+00:00",
    "name": "DR. STEVE BRULE",
    "company": null,
    "street1": "179 N HARBOR DR",
    "street2": "",
    "city": "REDONDO BEACH",
    "state": "CA",
    "zip": "90277-2506",
    "country": "US",
    "phone": "8573875756",
    "email": "DR_STEVE_BRULE@GMAIL.COM",
    "mode": "test",
    "carrier_facility": null,
    "residential": false,
    "federal_tax_id": null,
    "state_tax_id": null,
    "verifications": {
      "zip4": {
        "success": true,
        "errors": [],
        "details": null
      },
      "delivery": {
        "success": true,
        "errors": [],
        "details": {
          "latitude": 33.8436,
          "longitude": -118.39177,
          "time_zone": "America/Los_Angeles"
        }
      }
    }
  },
  "return_address": {
    "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
    "object": "Address",
    "created_at": "2024-01-24T00:05:56+00:00",
    "updated_at": "2024-01-24T00:05:56+00:00",
    "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": {}
  },
  "shipments": [
    {
      "created_at": "2024-01-24T00:05:56Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {
        "currency": "USD",
        "payment": {
          "type": "SENDER"
        },
        "date_advance": 0
      },
      "reference": null,
      "status": "unknown",
      "tracking_code": "9400100207552011812556",
      "updated_at": "2024-01-24T00:05:58Z",
      "batch_id": null,
      "batch_status": null,
      "batch_message": null,
      "customs_info": null,
      "from_address": {
        "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
        "object": "Address",
        "created_at": "2024-01-24T00:05:56+00:00",
        "updated_at": "2024-01-24T00:05:56+00:00",
        "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": {}
      },
      "insurance": null,
      "order_id": "order_12032df7a2c440c08adcf90653c22b9b",
      "parcel": {
        "id": "prcl_2e3d35cf1f4645a8bb23095b8cd4382e",
        "object": "Parcel",
        "created_at": "2024-01-24T00:05:56Z",
        "updated_at": "2024-01-24T00:05:56Z",
        "length": null,
        "width": null,
        "height": null,
        "predefined_package": null,
        "weight": 10.2,
        "mode": "test"
      },
      "postage_label": {
        "object": "PostageLabel",
        "id": "pl_717a685a1bb7490f908559900668f9d7",
        "created_at": "2024-01-24T00:05:57Z",
        "updated_at": "2024-01-24T00:05:57Z",
        "date_advance": 0,
        "integrated_form": "none",
        "label_date": "2024-01-24T00:05:57Z",
        "label_resolution": 300,
        "label_size": "4x6",
        "label_type": "default",
        "label_file_type": "image/png",
        "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240124/e82f4c1546988644378a9a63fb5bb1507e.png",
        "label_pdf_url": null,
        "label_zpl_url": null,
        "label_epl2_url": null,
        "label_file": null
      },
      "rates": [
        {
          "id": "rate_a15180650fa747c9b39df69fed0837cc",
          "object": "Rate",
          "created_at": "2024-01-24T00:05:56Z",
          "updated_at": "2024-01-24T00:05:56Z",
          "mode": "test",
          "service": "Express",
          "carrier": "USPS",
          "rate": "33.10",
          "currency": "USD",
          "retail_rate": "37.90",
          "retail_currency": "USD",
          "list_rate": "33.10",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": null,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_f80af12685ed43dd8449574aaa79d320",
          "object": "Rate",
          "created_at": "2024-01-24T00:05:56Z",
          "updated_at": "2024-01-24T00:05:56Z",
          "mode": "test",
          "service": "Priority",
          "carrier": "USPS",
          "rate": "6.88",
          "currency": "USD",
          "retail_rate": "9.80",
          "retail_currency": "USD",
          "list_rate": "8.25",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 2,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 2,
          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_1a9a747ade654bae93f2b81003af08dc",
          "object": "Rate",
          "created_at": "2024-01-24T00:05:56Z",
          "updated_at": "2024-01-24T00:05:56Z",
          "mode": "test",
          "service": "GroundAdvantage",
          "carrier": "USPS",
          "rate": "5.07",
          "currency": "USD",
          "retail_rate": "6.70",
          "retail_currency": "USD",
          "list_rate": "5.07",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_e5a4f53119594475935dc6c89990e9f9",
          "object": "Rate",
          "created_at": "2024-01-24T00:05:56Z",
          "updated_at": "2024-01-24T00:05:56Z",
          "mode": "test",
          "service": "First",
          "carrier": "USPS",
          "rate": "5.07",
          "currency": "USD",
          "retail_rate": "6.70",
          "retail_currency": "USD",
          "list_rate": "5.07",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_0a08acd20fe5497191b4346db709464b",
          "object": "Rate",
          "created_at": "2024-01-24T00:05:56Z",
          "updated_at": "2024-01-24T00:05:56Z",
          "mode": "test",
          "service": "ParcelSelect",
          "carrier": "USPS",
          "rate": "5.07",
          "currency": "USD",
          "retail_rate": "6.70",
          "retail_currency": "USD",
          "list_rate": "5.07",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        }
      ],
      "refund_status": null,
      "scan_form": null,
      "selected_rate": {
        "id": "rate_e5a4f53119594475935dc6c89990e9f9",
        "object": "Rate",
        "created_at": "2024-01-24T00:05:57Z",
        "updated_at": "2024-01-24T00:05:57Z",
        "mode": "test",
        "service": "First",
        "carrier": "USPS",
        "rate": "5.07",
        "currency": "USD",
        "retail_rate": "6.70",
        "retail_currency": "USD",
        "list_rate": "5.07",
        "list_currency": "USD",
        "billing_type": "easypost",
        "delivery_days": 3,
        "delivery_date": null,
        "delivery_date_guaranteed": false,
        "est_delivery_days": 3,
        "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
      },
      "tracker": {
        "id": "trk_2165a610b2ca4c0da08583c70a0efa27",
        "object": "Tracker",
        "mode": "test",
        "tracking_code": "9400100207552011812556",
        "status": "unknown",
        "status_detail": "unknown",
        "created_at": "2024-01-24T00:05:58Z",
        "updated_at": "2024-01-24T00:05:58Z",
        "signed_by": null,
        "weight": null,
        "est_delivery_date": null,
        "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
        "carrier": "USPS",
        "tracking_details": [],
        "fees": [],
        "carrier_detail": null,
        "public_url": "https://track.easypost.com/djE6dHJrXzIxNjVhNjEwYjJjYTRjMGRhMDg1ODNjNzBhMGVmYTI3"
      },
      "to_address": {
        "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:05:56+00:00",
        "updated_at": "2024-01-24T00:05:57+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": "",
        "city": "REDONDO BEACH",
        "state": "CA",
        "zip": "90277-2506",
        "country": "US",
        "phone": "8573875756",
        "email": "DR_STEVE_BRULE@GMAIL.COM",
        "mode": "test",
        "carrier_facility": null,
        "residential": false,
        "federal_tax_id": null,
        "state_tax_id": null,
        "verifications": {
          "zip4": {
            "success": true,
            "errors": [],
            "details": null
          },
          "delivery": {
            "success": true,
            "errors": [],
            "details": {
              "latitude": 33.8436,
              "longitude": -118.39177,
              "time_zone": "America/Los_Angeles"
            }
          }
        }
      },
      "usps_zone": 4,
      "return_address": {
        "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
        "object": "Address",
        "created_at": "2024-01-24T00:05:56+00:00",
        "updated_at": "2024-01-24T00:05:56+00:00",
        "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": {}
      },
      "buyer_address": {
        "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:05:56+00:00",
        "updated_at": "2024-01-24T00:05:57+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": "",
        "city": "REDONDO BEACH",
        "state": "CA",
        "zip": "90277-2506",
        "country": "US",
        "phone": "8573875756",
        "email": "DR_STEVE_BRULE@GMAIL.COM",
        "mode": "test",
        "carrier_facility": null,
        "residential": false,
        "federal_tax_id": null,
        "state_tax_id": null,
        "verifications": {
          "zip4": {
            "success": true,
            "errors": [],
            "details": null
          },
          "delivery": {
            "success": true,
            "errors": [],
            "details": {
              "latitude": 33.8436,
              "longitude": -118.39177,
              "time_zone": "America/Los_Angeles"
            }
          }
        }
      },
      "forms": [],
      "fees": [
        {
          "object": "Fee",
          "type": "LabelFee",
          "amount": "0.00000",
          "charged": true,
          "refunded": false
        },
        {
          "object": "Fee",
          "type": "PostageFee",
          "amount": "5.07000",
          "charged": true,
          "refunded": false
        }
      ],
      "id": "shp_3767a779a1b442d9bbf80a81c58499d8",
      "object": "Shipment"
    }
  ],
  "rates": [
    {
      "id": "rate_a15180650fa747c9b39df69fed0837cc",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "Express",
      "carrier": "USPS",
      "rate": "33.10",
      "currency": "USD",
      "retail_rate": "37.90",
      "retail_currency": "USD",
      "list_rate": "33.10",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": null,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": null,
      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    },
    {
      "id": "rate_f80af12685ed43dd8449574aaa79d320",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "Priority",
      "carrier": "USPS",
      "rate": "6.88",
      "currency": "USD",
      "retail_rate": "9.80",
      "retail_currency": "USD",
      "list_rate": "8.25",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 2,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 2,
      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    },
    {
      "id": "rate_1a9a747ade654bae93f2b81003af08dc",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "GroundAdvantage",
      "carrier": "USPS",
      "rate": "5.07",
      "currency": "USD",
      "retail_rate": "6.70",
      "retail_currency": "USD",
      "list_rate": "5.07",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 3,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 3,
      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    },
    {
      "id": "rate_e5a4f53119594475935dc6c89990e9f9",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "First",
      "carrier": "USPS",
      "rate": "5.07",
      "currency": "USD",
      "retail_rate": "6.70",
      "retail_currency": "USD",
      "list_rate": "5.07",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 3,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 3,
      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    },
    {
      "id": "rate_0a08acd20fe5497191b4346db709464b",
      "object": "Rate",
      "created_at": null,
      "updated_at": null,
      "mode": "test",
      "service": "ParcelSelect",
      "carrier": "USPS",
      "rate": "5.07",
      "currency": "USD",
      "retail_rate": "6.70",
      "retail_currency": "USD",
      "list_rate": "5.07",
      "list_currency": "USD",
      "billing_type": "easypost",
      "delivery_days": 3,
      "delivery_date": null,
      "delivery_date_guaranteed": false,
      "est_delivery_days": 3,
      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
    }
  ],
  "id": "order_12032df7a2c440c08adcf90653c22b9b",
  "object": "Order"
}

Create an Order

Creating an Order is intended only for multi-parcel shipping; please use Shipments for single-parcel shipping. 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.

An Order object is immutable once created. All information must be provided during creation; it cannot be modified later.

Request Parameters

reference

i.e. "my-reference"

to_address

i.e. Address

Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address

from_address

i.e. Address

Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address

shipments

i.e. Shipment array

List of shipments

carrier_accounts

i.e. [{"id": "ca_..."}, ...]

List of carrier accounts

POST /orders

1curl -X POST https://api.easypost.com/v2/orders \
2  -u "EASYPOST_API_KEY": \
3  -H 'Content-Type: application/json' \
4  -d '{
5    "order": {
6      "to_address": {
7        "id": "adr_..."
8      },
9      "from_address": {
10        "id": "adr_..."
11      },
12      "shipments": [
13        {
14          "parcel": {
15            "weight": "10.2"
16          }
17        },
18        {
19          "parcel": {
20            "predefined_package": "FedExBox",
21            "weight": "17.5"
22          }
23        }
24      ]
25    }
26  }'

Response

1{
2  "mode": "test",
3  "reference": "",
4  "is_return": false,
5  "options": {
6    "currency": "USD",
7    "payment": {
8      "type": "SENDER"
9    }
10  },
11  "messages": [],
12  "created_at": "2024-01-24T00:05:55Z",
13  "updated_at": "2024-01-24T00:05:55Z",
14  "customs_info": null,
15  "from_address": {
16    "id": "adr_57ea4540ba4c11ee8d58ac1f6bc539ae",
17    "object": "Address",
18    "created_at": "2024-01-24T00:05:55+00:00",
19    "updated_at": "2024-01-24T00:05:55+00:00",
20    "name": "EasyPost",
21    "company": null,
22    "street1": "417 Montgomery Street",
23    "street2": "5th Floor",
24    "city": "San Francisco",
25    "state": "CA",
26    "zip": "94104",
27    "country": "US",
28    "phone": "4153334445",
29    "email": "support@easypost.com",
30    "mode": "test",
31    "carrier_facility": null,
32    "residential": null,
33    "federal_tax_id": null,
34    "state_tax_id": null,
35    "verifications": {}
36  },
37  "to_address": {
38    "id": "adr_57e87debba4c11eebad4ac1f6bc53342",
39    "object": "Address",
40    "created_at": "2024-01-24T00:05:55+00:00",
41    "updated_at": "2024-01-24T00:05:55+00:00",
42    "name": "Dr. Steve Brule",
43    "company": null,
44    "street1": "179 N Harbor Dr",
45    "street2": null,
46    "city": "Redondo Beach",
47    "state": "CA",
48    "zip": "90277",
49    "country": "US",
50    "phone": "8573875756",
51    "email": "dr_steve_brule@gmail.com",
52    "mode": "test",
53    "carrier_facility": null,
54    "residential": null,
55    "federal_tax_id": null,
56    "state_tax_id": null,
57    "verifications": {}
58  },
59  "buyer_address": {
60    "id": "adr_57e87debba4c11eebad4ac1f6bc53342",
61    "object": "Address",
62    "created_at": "2024-01-24T00:05:55+00:00",
63    "updated_at": "2024-01-24T00:05:55+00:00",
64    "name": "Dr. Steve Brule",
65    "company": null,
66    "street1": "179 N Harbor Dr",
67    "street2": null,
68    "city": "Redondo Beach",
69    "state": "CA",
70    "zip": "90277",
71    "country": "US",
72    "phone": "8573875756",
73    "email": "dr_steve_brule@gmail.com",
74    "mode": "test",
75    "carrier_facility": null,
76    "residential": null,
77    "federal_tax_id": null,
78    "state_tax_id": null,
79    "verifications": {}
80  },
81  "return_address": {
82    "id": "adr_57ea4540ba4c11ee8d58ac1f6bc539ae",
83    "object": "Address",
84    "created_at": "2024-01-24T00:05:55+00:00",
85    "updated_at": "2024-01-24T00:05:55+00:00",
86    "name": "EasyPost",
87    "company": null,
88    "street1": "417 Montgomery Street",
89    "street2": "5th Floor",
90    "city": "San Francisco",
91    "state": "CA",
92    "zip": "94104",
93    "country": "US",
94    "phone": "4153334445",
95    "email": "support@easypost.com",
96    "mode": "test",
97    "carrier_facility": null,
98    "residential": null,
99    "federal_tax_id": null,
100    "state_tax_id": null,
101    "verifications": {}
102  },
103  "shipments": [
104    {
105      "created_at": "2024-01-24T00:05:55Z",
106      "is_return": false,
107      "messages": [],
108      "mode": "test",
109      "options": {
110        "currency": "USD",
111        "payment": {
112          "type": "SENDER"
113        },
114        "date_advance": 0
115      },
116      "reference": null,
117      "status": "unknown",
118      "tracking_code": null,
119      "updated_at": "2024-01-24T00:05:55Z",
120      "batch_id": null,
121      "batch_status": null,
122      "batch_message": null,
123      "customs_info": null,
124      "from_address": {
125        "id": "adr_57ea4540ba4c11ee8d58ac1f6bc539ae",
126        "object": "Address",
127        "created_at": "2024-01-24T00:05:55+00:00",
128        "updated_at": "2024-01-24T00:05:55+00:00",
129        "name": "EasyPost",
130        "company": null,
131        "street1": "417 Montgomery Street",
132        "street2": "5th Floor",
133        "city": "San Francisco",
134        "state": "CA",
135        "zip": "94104",
136        "country": "US",
137        "phone": "4153334445",
138        "email": "support@easypost.com",
139        "mode": "test",
140        "carrier_facility": null,
141        "residential": null,
142        "federal_tax_id": null,
143        "state_tax_id": null,
144        "verifications": {}
145      },
146      "insurance": null,
147      "order_id": "order_825e4008bd1448c5acf82bb90dc461ca",
148      "parcel": {
149        "id": "prcl_ca08509bfc8347748c8acb479ec7c0dd",
150        "object": "Parcel",
151        "created_at": "2024-01-24T00:05:55Z",
152        "updated_at": "2024-01-24T00:05:55Z",
153        "length": null,
154        "width": null,
155        "height": null,
156        "predefined_package": null,
157        "weight": 10.2,
158        "mode": "test"
159      },
160      "postage_label": null,
161      "rates": [
162        {
163          "id": "rate_ce70a3f843e74306a5271286a315c8d6",
164          "object": "Rate",
165          "created_at": "2024-01-24T00:05:55Z",
166          "updated_at": "2024-01-24T00:05:55Z",
167          "mode": "test",
168          "service": "Express",
169          "carrier": "USPS",
170          "rate": "33.10",
171          "currency": "USD",
172          "retail_rate": "37.90",
173          "retail_currency": "USD",
174          "list_rate": "33.10",
175          "list_currency": "USD",
176          "billing_type": "easypost",
177          "delivery_days": null,
178          "delivery_date": null,
179          "delivery_date_guaranteed": false,
180          "est_delivery_days": null,
181          "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
182          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
183        },
184        {
185          "id": "rate_bd2b1a604fdf497b950763818474b99c",
186          "object": "Rate",
187          "created_at": "2024-01-24T00:05:55Z",
188          "updated_at": "2024-01-24T00:05:55Z",
189          "mode": "test",
190          "service": "Priority",
191          "carrier": "USPS",
192          "rate": "6.88",
193          "currency": "USD",
194          "retail_rate": "9.80",
195          "retail_currency": "USD",
196          "list_rate": "8.25",
197          "list_currency": "USD",
198          "billing_type": "easypost",
199          "delivery_days": 2,
200          "delivery_date": null,
201          "delivery_date_guaranteed": false,
202          "est_delivery_days": 2,
203          "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
204          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
205        },
206        {
207          "id": "rate_cceeab9b94c74cd98b2bea0a53f092bb",
208          "object": "Rate",
209          "created_at": "2024-01-24T00:05:55Z",
210          "updated_at": "2024-01-24T00:05:55Z",
211          "mode": "test",
212          "service": "GroundAdvantage",
213          "carrier": "USPS",
214          "rate": "5.07",
215          "currency": "USD",
216          "retail_rate": "6.70",
217          "retail_currency": "USD",
218          "list_rate": "5.07",
219          "list_currency": "USD",
220          "billing_type": "easypost",
221          "delivery_days": 3,
222          "delivery_date": null,
223          "delivery_date_guaranteed": false,
224          "est_delivery_days": 3,
225          "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
226          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
227        },
228        {
229          "id": "rate_98a7f1f78555474f9d12fcc38fc4b640",
230          "object": "Rate",
231          "created_at": "2024-01-24T00:05:55Z",
232          "updated_at": "2024-01-24T00:05:55Z",
233          "mode": "test",
234          "service": "First",
235          "carrier": "USPS",
236          "rate": "5.07",
237          "currency": "USD",
238          "retail_rate": "6.70",
239          "retail_currency": "USD",
240          "list_rate": "5.07",
241          "list_currency": "USD",
242          "billing_type": "easypost",
243          "delivery_days": 3,
244          "delivery_date": null,
245          "delivery_date_guaranteed": false,
246          "est_delivery_days": 3,
247          "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
248          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
249        },
250        {
251          "id": "rate_674286cd966845ae8a830c4b554c00a0",
252          "object": "Rate",
253          "created_at": "2024-01-24T00:05:55Z",
254          "updated_at": "2024-01-24T00:05:55Z",
255          "mode": "test",
256          "service": "ParcelSelect",
257          "carrier": "USPS",
258          "rate": "5.07",
259          "currency": "USD",
260          "retail_rate": "6.70",
261          "retail_currency": "USD",
262          "list_rate": "5.07",
263          "list_currency": "USD",
264          "billing_type": "easypost",
265          "delivery_days": 3,
266          "delivery_date": null,
267          "delivery_date_guaranteed": false,
268          "est_delivery_days": 3,
269          "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
270          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
271        }
272      ],
273      "refund_status": null,
274      "scan_form": null,
275      "selected_rate": null,
276      "tracker": null,
277      "to_address": {
278        "id": "adr_57e87debba4c11eebad4ac1f6bc53342",
279        "object": "Address",
280        "created_at": "2024-01-24T00:05:55+00:00",
281        "updated_at": "2024-01-24T00:05:55+00:00",
282        "name": "Dr. Steve Brule",
283        "company": null,
284        "street1": "179 N Harbor Dr",
285        "street2": null,
286        "city": "Redondo Beach",
287        "state": "CA",
288        "zip": "90277",
289        "country": "US",
290        "phone": "8573875756",
291        "email": "dr_steve_brule@gmail.com",
292        "mode": "test",
293        "carrier_facility": null,
294        "residential": null,
295        "federal_tax_id": null,
296        "state_tax_id": null,
297        "verifications": {}
298      },
299      "usps_zone": 4,
300      "return_address": {
301        "id": "adr_57ea4540ba4c11ee8d58ac1f6bc539ae",
302        "object": "Address",
303        "created_at": "2024-01-24T00:05:55+00:00",
304        "updated_at": "2024-01-24T00:05:55+00:00",
305        "name": "EasyPost",
306        "company": null,
307        "street1": "417 Montgomery Street",
308        "street2": "5th Floor",
309        "city": "San Francisco",
310        "state": "CA",
311        "zip": "94104",
312        "country": "US",
313        "phone": "4153334445",
314        "email": "support@easypost.com",
315        "mode": "test",
316        "carrier_facility": null,
317        "residential": null,
318        "federal_tax_id": null,
319        "state_tax_id": null,
320        "verifications": {}
321      },
322      "buyer_address": {
323        "id": "adr_57e87debba4c11eebad4ac1f6bc53342",
324        "object": "Address",
325        "created_at": "2024-01-24T00:05:55+00:00",
326        "updated_at": "2024-01-24T00:05:55+00:00",
327        "name": "Dr. Steve Brule",
328        "company": null,
329        "street1": "179 N Harbor Dr",
330        "street2": null,
331        "city": "Redondo Beach",
332        "state": "CA",
333        "zip": "90277",
334        "country": "US",
335        "phone": "8573875756",
336        "email": "dr_steve_brule@gmail.com",
337        "mode": "test",
338        "carrier_facility": null,
339        "residential": null,
340        "federal_tax_id": null,
341        "state_tax_id": null,
342        "verifications": {}
343      },
344      "forms": [],
345      "fees": [],
346      "id": "shp_f4ca387fab464f7dac233a355801b61c",
347      "object": "Shipment"
348    }
349  ],
350  "rates": [
351    {
352      "id": "rate_ce70a3f843e74306a5271286a315c8d6",
353      "object": "Rate",
354      "created_at": null,
355      "updated_at": null,
356      "mode": "test",
357      "service": "Express",
358      "carrier": "USPS",
359      "rate": "33.10",
360      "currency": "USD",
361      "retail_rate": "37.90",
362      "retail_currency": "USD",
363      "list_rate": "33.10",
364      "list_currency": "USD",
365      "billing_type": "easypost",
366      "delivery_days": null,
367      "delivery_date": null,
368      "delivery_date_guaranteed": false,
369      "est_delivery_days": null,
370      "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
371      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
372    },
373    {
374      "id": "rate_bd2b1a604fdf497b950763818474b99c",
375      "object": "Rate",
376      "created_at": null,
377      "updated_at": null,
378      "mode": "test",
379      "service": "Priority",
380      "carrier": "USPS",
381      "rate": "6.88",
382      "currency": "USD",
383      "retail_rate": "9.80",
384      "retail_currency": "USD",
385      "list_rate": "8.25",
386      "list_currency": "USD",
387      "billing_type": "easypost",
388      "delivery_days": 2,
389      "delivery_date": null,
390      "delivery_date_guaranteed": false,
391      "est_delivery_days": 2,
392      "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
393      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
394    },
395    {
396      "id": "rate_cceeab9b94c74cd98b2bea0a53f092bb",
397      "object": "Rate",
398      "created_at": null,
399      "updated_at": null,
400      "mode": "test",
401      "service": "GroundAdvantage",
402      "carrier": "USPS",
403      "rate": "5.07",
404      "currency": "USD",
405      "retail_rate": "6.70",
406      "retail_currency": "USD",
407      "list_rate": "5.07",
408      "list_currency": "USD",
409      "billing_type": "easypost",
410      "delivery_days": 3,
411      "delivery_date": null,
412      "delivery_date_guaranteed": false,
413      "est_delivery_days": 3,
414      "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
415      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
416    },
417    {
418      "id": "rate_98a7f1f78555474f9d12fcc38fc4b640",
419      "object": "Rate",
420      "created_at": null,
421      "updated_at": null,
422      "mode": "test",
423      "service": "First",
424      "carrier": "USPS",
425      "rate": "5.07",
426      "currency": "USD",
427      "retail_rate": "6.70",
428      "retail_currency": "USD",
429      "list_rate": "5.07",
430      "list_currency": "USD",
431      "billing_type": "easypost",
432      "delivery_days": 3,
433      "delivery_date": null,
434      "delivery_date_guaranteed": false,
435      "est_delivery_days": 3,
436      "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
437      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
438    },
439    {
440      "id": "rate_674286cd966845ae8a830c4b554c00a0",
441      "object": "Rate",
442      "created_at": null,
443      "updated_at": null,
444      "mode": "test",
445      "service": "ParcelSelect",
446      "carrier": "USPS",
447      "rate": "5.07",
448      "currency": "USD",
449      "retail_rate": "6.70",
450      "retail_currency": "USD",
451      "list_rate": "5.07",
452      "list_currency": "USD",
453      "billing_type": "easypost",
454      "delivery_days": 3,
455      "delivery_date": null,
456      "delivery_date_guaranteed": false,
457      "est_delivery_days": 3,
458      "shipment_id": "shp_f4ca387fab464f7dac233a355801b61c",
459      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
460    }
461  ],
462  "id": "order_825e4008bd1448c5acf82bb90dc461ca",
463  "object": "Order"
464}

Buy an Order

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

Request Parameters

carrier

i.e. "FedEx"

service

i.e. "FEDEX_GROUND"

POST /orders/:id/buy

1curl -X POST https://api.easypost.com/v2/orders/order_.../buy \
2  -u "EASYPOST_API_KEY": \
3  -H 'Content-Type: application/json' \
4  -d '{
5    "carrier": "FedEx",
6    "service": "FEDEX_GROUND"
7  }'

Response

1{
2  "mode": "test",
3  "reference": "",
4  "is_return": false,
5  "options": {
6    "currency": "USD",
7    "payment": {
8      "type": "SENDER"
9    }
10  },
11  "messages": [],
12  "created_at": "2024-01-24T00:05:56Z",
13  "updated_at": "2024-01-24T00:05:56Z",
14  "customs_info": null,
15  "from_address": {
16    "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
17    "object": "Address",
18    "created_at": "2024-01-24T00:05:56+00:00",
19    "updated_at": "2024-01-24T00:05:56+00:00",
20    "name": "EasyPost",
21    "company": null,
22    "street1": "417 Montgomery Street",
23    "street2": "5th Floor",
24    "city": "San Francisco",
25    "state": "CA",
26    "zip": "94104",
27    "country": "US",
28    "phone": "4153334445",
29    "email": "support@easypost.com",
30    "mode": "test",
31    "carrier_facility": null,
32    "residential": null,
33    "federal_tax_id": null,
34    "state_tax_id": null,
35    "verifications": {}
36  },
37  "to_address": {
38    "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
39    "object": "Address",
40    "created_at": "2024-01-24T00:05:56+00:00",
41    "updated_at": "2024-01-24T00:05:57+00:00",
42    "name": "DR. STEVE BRULE",
43    "company": null,
44    "street1": "179 N HARBOR DR",
45    "street2": "",
46    "city": "REDONDO BEACH",
47    "state": "CA",
48    "zip": "90277-2506",
49    "country": "US",
50    "phone": "8573875756",
51    "email": "DR_STEVE_BRULE@GMAIL.COM",
52    "mode": "test",
53    "carrier_facility": null,
54    "residential": false,
55    "federal_tax_id": null,
56    "state_tax_id": null,
57    "verifications": {
58      "zip4": {
59        "success": true,
60        "errors": [],
61        "details": null
62      },
63      "delivery": {
64        "success": true,
65        "errors": [],
66        "details": {
67          "latitude": 33.8436,
68          "longitude": -118.39177,
69          "time_zone": "America/Los_Angeles"
70        }
71      }
72    }
73  },
74  "buyer_address": {
75    "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
76    "object": "Address",
77    "created_at": "2024-01-24T00:05:56+00:00",
78    "updated_at": "2024-01-24T00:05:57+00:00",
79    "name": "DR. STEVE BRULE",
80    "company": null,
81    "street1": "179 N HARBOR DR",
82    "street2": "",
83    "city": "REDONDO BEACH",
84    "state": "CA",
85    "zip": "90277-2506",
86    "country": "US",
87    "phone": "8573875756",
88    "email": "DR_STEVE_BRULE@GMAIL.COM",
89    "mode": "test",
90    "carrier_facility": null,
91    "residential": false,
92    "federal_tax_id": null,
93    "state_tax_id": null,
94    "verifications": {
95      "zip4": {
96        "success": true,
97        "errors": [],
98        "details": null
99      },
100      "delivery": {
101        "success": true,
102        "errors": [],
103        "details": {
104          "latitude": 33.8436,
105          "longitude": -118.39177,
106          "time_zone": "America/Los_Angeles"
107        }
108      }
109    }
110  },
111  "return_address": {
112    "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
113    "object": "Address",
114    "created_at": "2024-01-24T00:05:56+00:00",
115    "updated_at": "2024-01-24T00:05:56+00:00",
116    "name": "EasyPost",
117    "company": null,
118    "street1": "417 Montgomery Street",
119    "street2": "5th Floor",
120    "city": "San Francisco",
121    "state": "CA",
122    "zip": "94104",
123    "country": "US",
124    "phone": "4153334445",
125    "email": "support@easypost.com",
126    "mode": "test",
127    "carrier_facility": null,
128    "residential": null,
129    "federal_tax_id": null,
130    "state_tax_id": null,
131    "verifications": {}
132  },
133  "shipments": [
134    {
135      "created_at": "2024-01-24T00:05:56Z",
136      "is_return": false,
137      "messages": [],
138      "mode": "test",
139      "options": {
140        "currency": "USD",
141        "payment": {
142          "type": "SENDER"
143        },
144        "date_advance": 0
145      },
146      "reference": null,
147      "status": "unknown",
148      "tracking_code": "9400100207552011812556",
149      "updated_at": "2024-01-24T00:05:58Z",
150      "batch_id": null,
151      "batch_status": null,
152      "batch_message": null,
153      "customs_info": null,
154      "from_address": {
155        "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
156        "object": "Address",
157        "created_at": "2024-01-24T00:05:56+00:00",
158        "updated_at": "2024-01-24T00:05:56+00:00",
159        "name": "EasyPost",
160        "company": null,
161        "street1": "417 Montgomery Street",
162        "street2": "5th Floor",
163        "city": "San Francisco",
164        "state": "CA",
165        "zip": "94104",
166        "country": "US",
167        "phone": "4153334445",
168        "email": "support@easypost.com",
169        "mode": "test",
170        "carrier_facility": null,
171        "residential": null,
172        "federal_tax_id": null,
173        "state_tax_id": null,
174        "verifications": {}
175      },
176      "insurance": null,
177      "order_id": "order_12032df7a2c440c08adcf90653c22b9b",
178      "parcel": {
179        "id": "prcl_2e3d35cf1f4645a8bb23095b8cd4382e",
180        "object": "Parcel",
181        "created_at": "2024-01-24T00:05:56Z",
182        "updated_at": "2024-01-24T00:05:56Z",
183        "length": null,
184        "width": null,
185        "height": null,
186        "predefined_package": null,
187        "weight": 10.2,
188        "mode": "test"
189      },
190      "postage_label": {
191        "object": "PostageLabel",
192        "id": "pl_717a685a1bb7490f908559900668f9d7",
193        "created_at": "2024-01-24T00:05:57Z",
194        "updated_at": "2024-01-24T00:05:57Z",
195        "date_advance": 0,
196        "integrated_form": "none",
197        "label_date": "2024-01-24T00:05:57Z",
198        "label_resolution": 300,
199        "label_size": "4x6",
200        "label_type": "default",
201        "label_file_type": "image/png",
202        "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240124/e82f4c1546988644378a9a63fb5bb1507e.png",
203        "label_pdf_url": null,
204        "label_zpl_url": null,
205        "label_epl2_url": null,
206        "label_file": null
207      },
208      "rates": [
209        {
210          "id": "rate_a15180650fa747c9b39df69fed0837cc",
211          "object": "Rate",
212          "created_at": "2024-01-24T00:05:56Z",
213          "updated_at": "2024-01-24T00:05:56Z",
214          "mode": "test",
215          "service": "Express",
216          "carrier": "USPS",
217          "rate": "33.10",
218          "currency": "USD",
219          "retail_rate": "37.90",
220          "retail_currency": "USD",
221          "list_rate": "33.10",
222          "list_currency": "USD",
223          "billing_type": "easypost",
224          "delivery_days": null,
225          "delivery_date": null,
226          "delivery_date_guaranteed": false,
227          "est_delivery_days": null,
228          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
229          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
230        },
231        {
232          "id": "rate_f80af12685ed43dd8449574aaa79d320",
233          "object": "Rate",
234          "created_at": "2024-01-24T00:05:56Z",
235          "updated_at": "2024-01-24T00:05:56Z",
236          "mode": "test",
237          "service": "Priority",
238          "carrier": "USPS",
239          "rate": "6.88",
240          "currency": "USD",
241          "retail_rate": "9.80",
242          "retail_currency": "USD",
243          "list_rate": "8.25",
244          "list_currency": "USD",
245          "billing_type": "easypost",
246          "delivery_days": 2,
247          "delivery_date": null,
248          "delivery_date_guaranteed": false,
249          "est_delivery_days": 2,
250          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
251          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
252        },
253        {
254          "id": "rate_1a9a747ade654bae93f2b81003af08dc",
255          "object": "Rate",
256          "created_at": "2024-01-24T00:05:56Z",
257          "updated_at": "2024-01-24T00:05:56Z",
258          "mode": "test",
259          "service": "GroundAdvantage",
260          "carrier": "USPS",
261          "rate": "5.07",
262          "currency": "USD",
263          "retail_rate": "6.70",
264          "retail_currency": "USD",
265          "list_rate": "5.07",
266          "list_currency": "USD",
267          "billing_type": "easypost",
268          "delivery_days": 3,
269          "delivery_date": null,
270          "delivery_date_guaranteed": false,
271          "est_delivery_days": 3,
272          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
273          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
274        },
275        {
276          "id": "rate_e5a4f53119594475935dc6c89990e9f9",
277          "object": "Rate",
278          "created_at": "2024-01-24T00:05:56Z",
279          "updated_at": "2024-01-24T00:05:56Z",
280          "mode": "test",
281          "service": "First",
282          "carrier": "USPS",
283          "rate": "5.07",
284          "currency": "USD",
285          "retail_rate": "6.70",
286          "retail_currency": "USD",
287          "list_rate": "5.07",
288          "list_currency": "USD",
289          "billing_type": "easypost",
290          "delivery_days": 3,
291          "delivery_date": null,
292          "delivery_date_guaranteed": false,
293          "est_delivery_days": 3,
294          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
295          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
296        },
297        {
298          "id": "rate_0a08acd20fe5497191b4346db709464b",
299          "object": "Rate",
300          "created_at": "2024-01-24T00:05:56Z",
301          "updated_at": "2024-01-24T00:05:56Z",
302          "mode": "test",
303          "service": "ParcelSelect",
304          "carrier": "USPS",
305          "rate": "5.07",
306          "currency": "USD",
307          "retail_rate": "6.70",
308          "retail_currency": "USD",
309          "list_rate": "5.07",
310          "list_currency": "USD",
311          "billing_type": "easypost",
312          "delivery_days": 3,
313          "delivery_date": null,
314          "delivery_date_guaranteed": false,
315          "est_delivery_days": 3,
316          "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
317          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
318        }
319      ],
320      "refund_status": null,
321      "scan_form": null,
322      "selected_rate": {
323        "id": "rate_e5a4f53119594475935dc6c89990e9f9",
324        "object": "Rate",
325        "created_at": "2024-01-24T00:05:57Z",
326        "updated_at": "2024-01-24T00:05:57Z",
327        "mode": "test",
328        "service": "First",
329        "carrier": "USPS",
330        "rate": "5.07",
331        "currency": "USD",
332        "retail_rate": "6.70",
333        "retail_currency": "USD",
334        "list_rate": "5.07",
335        "list_currency": "USD",
336        "billing_type": "easypost",
337        "delivery_days": 3,
338        "delivery_date": null,
339        "delivery_date_guaranteed": false,
340        "est_delivery_days": 3,
341        "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
342        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
343      },
344      "tracker": {
345        "id": "trk_2165a610b2ca4c0da08583c70a0efa27",
346        "object": "Tracker",
347        "mode": "test",
348        "tracking_code": "9400100207552011812556",
349        "status": "unknown",
350        "status_detail": "unknown",
351        "created_at": "2024-01-24T00:05:58Z",
352        "updated_at": "2024-01-24T00:05:58Z",
353        "signed_by": null,
354        "weight": null,
355        "est_delivery_date": null,
356        "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
357        "carrier": "USPS",
358        "tracking_details": [],
359        "fees": [],
360        "carrier_detail": null,
361        "public_url": "https://track.easypost.com/djE6dHJrXzIxNjVhNjEwYjJjYTRjMGRhMDg1ODNjNzBhMGVmYTI3"
362      },
363      "to_address": {
364        "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
365        "object": "Address",
366        "created_at": "2024-01-24T00:05:56+00:00",
367        "updated_at": "2024-01-24T00:05:57+00:00",
368        "name": "DR. STEVE BRULE",
369        "company": null,
370        "street1": "179 N HARBOR DR",
371        "street2": "",
372        "city": "REDONDO BEACH",
373        "state": "CA",
374        "zip": "90277-2506",
375        "country": "US",
376        "phone": "8573875756",
377        "email": "DR_STEVE_BRULE@GMAIL.COM",
378        "mode": "test",
379        "carrier_facility": null,
380        "residential": false,
381        "federal_tax_id": null,
382        "state_tax_id": null,
383        "verifications": {
384          "zip4": {
385            "success": true,
386            "errors": [],
387            "details": null
388          },
389          "delivery": {
390            "success": true,
391            "errors": [],
392            "details": {
393              "latitude": 33.8436,
394              "longitude": -118.39177,
395              "time_zone": "America/Los_Angeles"
396            }
397          }
398        }
399      },
400      "usps_zone": 4,
401      "return_address": {
402        "id": "adr_58ec479fba4c11ee975e3cecef1b359e",
403        "object": "Address",
404        "created_at": "2024-01-24T00:05:56+00:00",
405        "updated_at": "2024-01-24T00:05:56+00:00",
406        "name": "EasyPost",
407        "company": null,
408        "street1": "417 Montgomery Street",
409        "street2": "5th Floor",
410        "city": "San Francisco",
411        "state": "CA",
412        "zip": "94104",
413        "country": "US",
414        "phone": "4153334445",
415        "email": "support@easypost.com",
416        "mode": "test",
417        "carrier_facility": null,
418        "residential": null,
419        "federal_tax_id": null,
420        "state_tax_id": null,
421        "verifications": {}
422      },
423      "buyer_address": {
424        "id": "adr_58ea8f17ba4c11eea6f0ac1f6bc539aa",
425        "object": "Address",
426        "created_at": "2024-01-24T00:05:56+00:00",
427        "updated_at": "2024-01-24T00:05:57+00:00",
428        "name": "DR. STEVE BRULE",
429        "company": null,
430        "street1": "179 N HARBOR DR",
431        "street2": "",
432        "city": "REDONDO BEACH",
433        "state": "CA",
434        "zip": "90277-2506",
435        "country": "US",
436        "phone": "8573875756",
437        "email": "DR_STEVE_BRULE@GMAIL.COM",
438        "mode": "test",
439        "carrier_facility": null,
440        "residential": false,
441        "federal_tax_id": null,
442        "state_tax_id": null,
443        "verifications": {
444          "zip4": {
445            "success": true,
446            "errors": [],
447            "details": null
448          },
449          "delivery": {
450            "success": true,
451            "errors": [],
452            "details": {
453              "latitude": 33.8436,
454              "longitude": -118.39177,
455              "time_zone": "America/Los_Angeles"
456            }
457          }
458        }
459      },
460      "forms": [],
461      "fees": [
462        {
463          "object": "Fee",
464          "type": "LabelFee",
465          "amount": "0.00000",
466          "charged": true,
467          "refunded": false
468        },
469        {
470          "object": "Fee",
471          "type": "PostageFee",
472          "amount": "5.07000",
473          "charged": true,
474          "refunded": false
475        }
476      ],
477      "id": "shp_3767a779a1b442d9bbf80a81c58499d8",
478      "object": "Shipment"
479    }
480  ],
481  "rates": [
482    {
483      "id": "rate_a15180650fa747c9b39df69fed0837cc",
484      "object": "Rate",
485      "created_at": null,
486      "updated_at": null,
487      "mode": "test",
488      "service": "Express",
489      "carrier": "USPS",
490      "rate": "33.10",
491      "currency": "USD",
492      "retail_rate": "37.90",
493      "retail_currency": "USD",
494      "list_rate": "33.10",
495      "list_currency": "USD",
496      "billing_type": "easypost",
497      "delivery_days": null,
498      "delivery_date": null,
499      "delivery_date_guaranteed": false,
500      "est_delivery_days": null,
501      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
502      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
503    },
504    {
505      "id": "rate_f80af12685ed43dd8449574aaa79d320",
506      "object": "Rate",
507      "created_at": null,
508      "updated_at": null,
509      "mode": "test",
510      "service": "Priority",
511      "carrier": "USPS",
512      "rate": "6.88",
513      "currency": "USD",
514      "retail_rate": "9.80",
515      "retail_currency": "USD",
516      "list_rate": "8.25",
517      "list_currency": "USD",
518      "billing_type": "easypost",
519      "delivery_days": 2,
520      "delivery_date": null,
521      "delivery_date_guaranteed": false,
522      "est_delivery_days": 2,
523      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
524      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
525    },
526    {
527      "id": "rate_1a9a747ade654bae93f2b81003af08dc",
528      "object": "Rate",
529      "created_at": null,
530      "updated_at": null,
531      "mode": "test",
532      "service": "GroundAdvantage",
533      "carrier": "USPS",
534      "rate": "5.07",
535      "currency": "USD",
536      "retail_rate": "6.70",
537      "retail_currency": "USD",
538      "list_rate": "5.07",
539      "list_currency": "USD",
540      "billing_type": "easypost",
541      "delivery_days": 3,
542      "delivery_date": null,
543      "delivery_date_guaranteed": false,
544      "est_delivery_days": 3,
545      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
546      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
547    },
548    {
549      "id": "rate_e5a4f53119594475935dc6c89990e9f9",
550      "object": "Rate",
551      "created_at": null,
552      "updated_at": null,
553      "mode": "test",
554      "service": "First",
555      "carrier": "USPS",
556      "rate": "5.07",
557      "currency": "USD",
558      "retail_rate": "6.70",
559      "retail_currency": "USD",
560      "list_rate": "5.07",
561      "list_currency": "USD",
562      "billing_type": "easypost",
563      "delivery_days": 3,
564      "delivery_date": null,
565      "delivery_date_guaranteed": false,
566      "est_delivery_days": 3,
567      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
568      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
569    },
570    {
571      "id": "rate_0a08acd20fe5497191b4346db709464b",
572      "object": "Rate",
573      "created_at": null,
574      "updated_at": null,
575      "mode": "test",
576      "service": "ParcelSelect",
577      "carrier": "USPS",
578      "rate": "5.07",
579      "currency": "USD",
580      "retail_rate": "6.70",
581      "retail_currency": "USD",
582      "list_rate": "5.07",
583      "list_currency": "USD",
584      "billing_type": "easypost",
585      "delivery_days": 3,
586      "delivery_date": null,
587      "delivery_date_guaranteed": false,
588      "est_delivery_days": 3,
589      "shipment_id": "shp_3767a779a1b442d9bbf80a81c58499d8",
590      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
591    }
592  ],
593  "id": "order_12032df7a2c440c08adcf90653c22b9b",
594  "object": "Order"
595}

Buy an Order without rating (One-Call Buy)

There is an alternative way to purchase orders that is known as the "one-call buy" method. This method is often used if you have a flat-rate set with a mail carrier for a given service level, or if you know your desired service level without needing to see the rate first.

Utilizing the "one-call buy" method can improve the performance of your integration, because it cuts out an API call from our standard "create order" then "buy order" workflow. In order to achieve this behavior, all you have to do is add a carrier_account and service name to your creation API call.

Request Parameters

reference

i.e. "my-reference"

to_address

i.e. Address

Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address

from_address

i.e. Address

Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address

shipments

i.e. Shipment array

A list of shipments

carrier_accounts

i.e. ["ca_..."]

List of carrier accounts

service

i.e. "Priority"

Service of carrier

POST /orders

1curl -X POST https://api.easypost.com/v2/orders \
2  -u "EASYPOST_API_KEY": \
3  -H 'Content-Type: application/json' \
4  -d '{
5    "order": {
6      "to_address": {
7        "id": "adr_..."
8      },
9      "from_address": {
10        "id": "adr_..."
11      },
12      "shipments": [
13        {
14          "parcel": {
15            "weight": "10.2"
16          }
17        },
18        {
19          "parcel": {
20            "predefined_package": "FedExBox",
21            "weight": "17.5"
22          }
23        }
24      ],
25      "service": "NextDayAir",
26      "carrier_accounts": ["ca_..."]
27    }
28  }'

Response

1{
2  "messages": [],
3  "mode": "test",
4  "reference": "",
5  "is_return": false,
6  "options": {
7    "currency": "USD",
8    "payment": {
9      "type": "SENDER"
10    }
11  },
12  "created_at": "2024-01-24T00:05:58Z",
13  "updated_at": "2024-01-24T00:05:58Z",
14  "customs_info": null,
15  "from_address": {
16    "id": "adr_5a0f5af8ba4c11eebb69ac1f6bc53342",
17    "object": "Address",
18    "created_at": "2024-01-24T00:05:58+00:00",
19    "updated_at": "2024-01-24T00:05:58+00:00",
20    "name": "EasyPost",
21    "company": null,
22    "street1": "417 Montgomery Street",
23    "street2": "5th Floor",
24    "city": "San Francisco",
25    "state": "CA",
26    "zip": "94104",
27    "country": "US",
28    "phone": "4153334445",
29    "email": "support@easypost.com",
30    "mode": "test",
31    "carrier_facility": null,
32    "residential": null,
33    "federal_tax_id": null,
34    "state_tax_id": null,
35    "verifications": {}
36  },
37  "to_address": {
38    "id": "adr_5a0dc9a4ba4c11ee8df2ac1f6bc539ae",
39    "object": "Address",
40    "created_at": "2024-01-24T00:05:58+00:00",
41    "updated_at": "2024-01-24T00:05:58+00:00",
42    "name": "DR. STEVE BRULE",
43    "company": null,
44    "street1": "179 N HARBOR DR",
45    "street2": "",
46    "city": "REDONDO BEACH",
47    "state": "CA",
48    "zip": "90277-2506",
49    "country": "US",
50    "phone": "8573875756",
51    "email": "DR_STEVE_BRULE@GMAIL.COM",
52    "mode": "test",
53    "carrier_facility": null,
54    "residential": false,
55    "federal_tax_id": null,
56    "state_tax_id": null,
57    "verifications": {
58      "zip4": {
59        "success": true,
60        "errors": [],
61        "details": null
62      },
63      "delivery": {
64        "success": true,
65        "errors": [],
66        "details": {
67          "latitude": 33.8436,
68          "longitude": -118.39177,
69          "time_zone": "America/Los_Angeles"
70        }
71      }
72    }
73  },
74  "buyer_address": {
75    "id": "adr_5a0dc9a4ba4c11ee8df2ac1f6bc539ae",
76    "object": "Address",
77    "created_at": "2024-01-24T00:05:58+00:00",
78    "updated_at": "2024-01-24T00:05:58+00:00",
79    "name": "DR. STEVE BRULE",
80    "company": null,
81    "street1": "179 N HARBOR DR",
82    "street2": "",
83    "city": "REDONDO BEACH",
84    "state": "CA",
85    "zip": "90277-2506",
86    "country": "US",
87    "phone": "8573875756",
88    "email": "DR_STEVE_BRULE@GMAIL.COM",
89    "mode": "test",
90    "carrier_facility": null,
91    "residential": false,
92    "federal_tax_id": null,
93    "state_tax_id": null,
94    "verifications": {
95      "zip4": {
96        "success": true,
97        "errors": [],
98        "details": null
99      },
100      "delivery": {
101        "success": true,
102        "errors": [],
103        "details": {
104          "latitude": 33.8436,
105          "longitude": -118.39177,
106          "time_zone": "America/Los_Angeles"
107        }
108      }
109    }
110  },
111  "return_address": {
112    "id": "adr_5a0f5af8ba4c11eebb69ac1f6bc53342",
113    "object": "Address",
114    "created_at": "2024-01-24T00:05:58+00:00",
115    "updated_at": "2024-01-24T00:05:58+00:00",
116    "name": "EasyPost",
117    "company": null,
118    "street1": "417 Montgomery Street",
119    "street2": "5th Floor",
120    "city": "San Francisco",
121    "state": "CA",
122    "zip": "94104",
123    "country": "US",
124    "phone": "4153334445",
125    "email": "support@easypost.com",
126    "mode": "test",
127    "carrier_facility": null,
128    "residential": null,
129    "federal_tax_id": null,
130    "state_tax_id": null,
131    "verifications": {}
132  },
133  "shipments": [
134    {
135      "created_at": "2024-01-24T00:05:58Z",
136      "is_return": false,
137      "messages": [],
138      "mode": "test",
139      "options": {
140        "currency": "USD",
141        "payment": {
142          "type": "SENDER"
143        },
144        "date_advance": 0
145      },
146      "reference": null,
147      "status": "unknown",
148      "tracking_code": "9400100207552011812563",
149      "updated_at": "2024-01-24T00:05:59Z",
150      "batch_id": null,
151      "batch_status": null,
152      "batch_message": null,
153      "customs_info": null,
154      "from_address": {
155        "id": "adr_5a0f5af8ba4c11eebb69ac1f6bc53342",
156        "object": "Address",
157        "created_at": "2024-01-24T00:05:58+00:00",
158        "updated_at": "2024-01-24T00:05:58+00:00",
159        "name": "EasyPost",
160        "company": null,
161        "street1": "417 Montgomery Street",
162        "street2": "5th Floor",
163        "city": "San Francisco",
164        "state": "CA",
165        "zip": "94104",
166        "country": "US",
167        "phone": "4153334445",
168        "email": "support@easypost.com",
169        "mode": "test",
170        "carrier_facility": null,
171        "residential": null,
172        "federal_tax_id": null,
173        "state_tax_id": null,
174        "verifications": {}
175      },
176      "insurance": null,
177      "order_id": "order_700c1e0203b24cf192d38ba62aacdb86",
178      "parcel": {
179        "id": "prcl_d12175ef61644588b383d5debb91bf96",
180        "object": "Parcel",
181        "created_at": "2024-01-24T00:05:58Z",
182        "updated_at": "2024-01-24T00:05:58Z",
183        "length": null,
184        "width": null,
185        "height": null,
186        "predefined_package": null,
187        "weight": 10.2,
188        "mode": "test"
189      },
190      "postage_label": {
191        "object": "PostageLabel",
192        "id": "pl_a9d0d35f3cc24095a458b14fef6cbd96",
193        "created_at": "2024-01-24T00:05:59Z",
194        "updated_at": "2024-01-24T00:05:59Z",
195        "date_advance": 0,
196        "integrated_form": "none",
197        "label_date": "2024-01-24T00:05:59Z",
198        "label_resolution": 300,
199        "label_size": "4x6",
200        "label_type": "default",
201        "label_file_type": "image/png",
202        "label_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/postage_label/20240124/e8050a603da7fe4bc5bc98247ca27a2dde.png",
203        "label_pdf_url": null,
204        "label_zpl_url": null,
205        "label_epl2_url": null,
206        "label_file": null
207      },
208      "rates": [
209        {
210          "id": "rate_985c0d7c85f545ecb6367f377df13453",
211          "object": "Rate",
212          "created_at": "2024-01-24T00:05:58Z",
213          "updated_at": "2024-01-24T00:05:58Z",
214          "mode": "test",
215          "service": "Priority",
216          "carrier": "USPS",
217          "rate": "6.88",
218          "currency": "USD",
219          "retail_rate": "9.80",
220          "retail_currency": "USD",
221          "list_rate": "8.25",
222          "list_currency": "USD",
223          "billing_type": "easypost",
224          "delivery_days": 2,
225          "delivery_date": null,
226          "delivery_date_guaranteed": false,
227          "est_delivery_days": 2,
228          "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
229          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
230        },
231        {
232          "id": "rate_01c4b156f83247d9a8087b60ba19a4e0",
233          "object": "Rate",
234          "created_at": "2024-01-24T00:05:58Z",
235          "updated_at": "2024-01-24T00:05:58Z",
236          "mode": "test",
237          "service": "GroundAdvantage",
238          "carrier": "USPS",
239          "rate": "5.07",
240          "currency": "USD",
241          "retail_rate": "6.70",
242          "retail_currency": "USD",
243          "list_rate": "5.07",
244          "list_currency": "USD",
245          "billing_type": "easypost",
246          "delivery_days": 3,
247          "delivery_date": null,
248          "delivery_date_guaranteed": false,
249          "est_delivery_days": 3,
250          "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
251          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
252        },
253        {
254          "id": "rate_b499467fd724497caf04475555082734",
255          "object": "Rate",
256          "created_at": "2024-01-24T00:05:58Z",
257          "updated_at": "2024-01-24T00:05:58Z",
258          "mode": "test",
259          "service": "First",
260          "carrier": "USPS",
261          "rate": "5.07",
262          "currency": "USD",
263          "retail_rate": "6.70",
264          "retail_currency": "USD",
265          "list_rate": "5.07",
266          "list_currency": "USD",
267          "billing_type": "easypost",
268          "delivery_days": 3,
269          "delivery_date": null,
270          "delivery_date_guaranteed": false,
271          "est_delivery_days": 3,
272          "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
273          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
274        },
275        {
276          "id": "rate_b35f9780e45d463a9cf672f04fafa3c3",
277          "object": "Rate",
278          "created_at": "2024-01-24T00:05:58Z",
279          "updated_at": "2024-01-24T00:05:58Z",
280          "mode": "test",
281          "service": "ParcelSelect",
282          "carrier": "USPS",
283          "rate": "5.07",
284          "currency": "USD",
285          "retail_rate": "6.70",
286          "retail_currency": "USD",
287          "list_rate": "5.07",
288          "list_currency": "USD",
289          "billing_type": "easypost",
290          "delivery_days": 3,
291          "delivery_date": null,
292          "delivery_date_guaranteed": false,
293          "est_delivery_days": 3,
294          "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
295          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
296        },
297        {
298          "id": "rate_b1bac17f8cc6444f8d192ed09965f667",
299          "object": "Rate",
300          "created_at": "2024-01-24T00:05:58Z",
301          "updated_at": "2024-01-24T00:05:58Z",
302          "mode": "test",
303          "service": "Express",
304          "carrier": "USPS",
305          "rate": "33.10",
306          "currency": "USD",
307          "retail_rate": "37.90",
308          "retail_currency": "USD",
309          "list_rate": "33.10",
310          "list_currency": "USD",
311          "billing_type": "easypost",
312          "delivery_days": null,
313          "delivery_date": null,
314          "delivery_date_guaranteed": false,
315          "est_delivery_days": null,
316          "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
317          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
318        }
319      ],
320      "refund_status": null,
321      "scan_form": null,
322      "selected_rate": {
323        "id": "rate_b499467fd724497caf04475555082734",
324        "object": "Rate",
325        "created_at": "2024-01-24T00:05:59Z",
326        "updated_at": "2024-01-24T00:05:59Z",
327        "mode": "test",
328        "service": "First",
329        "carrier": "USPS",
330        "rate": "5.07",
331        "currency": "USD",
332        "retail_rate": "6.70",
333        "retail_currency": "USD",
334        "list_rate": "5.07",
335        "list_currency": "USD",
336        "billing_type": "easypost",
337        "delivery_days": 3,
338        "delivery_date": null,
339        "delivery_date_guaranteed": false,
340        "est_delivery_days": 3,
341        "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
342        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
343      },
344      "tracker": {
345        "id": "trk_02a7da80556f4742b9d39a854f135661",
346        "object": "Tracker",
347        "mode": "test",
348        "tracking_code": "9400100207552011812563",
349        "status": "unknown",
350        "status_detail": "unknown",
351        "created_at": "2024-01-24T00:05:59Z",
352        "updated_at": "2024-01-24T00:05:59Z",
353        "signed_by": null,
354        "weight": null,
355        "est_delivery_date": null,
356        "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
357        "carrier": "USPS",
358        "tracking_details": [],
359        "fees": [],
360        "carrier_detail": null,
361        "public_url": "https://track.easypost.com/djE6dHJrXzAyYTdkYTgwNTU2ZjQ3NDJiOWQzOWE4NTRmMTM1NjYx"
362      },
363      "to_address": {
364        "id": "adr_5a0dc9a4ba4c11ee8df2ac1f6bc539ae",
365        "object": "Address",
366        "created_at": "2024-01-24T00:05:58+00:00",
367        "updated_at": "2024-01-24T00:05:58+00:00",
368        "name": "DR. STEVE BRULE",
369        "company": null,
370        "street1": "179 N HARBOR DR",
371        "street2": "",
372        "city": "REDONDO BEACH",
373        "state": "CA",
374        "zip": "90277-2506",
375        "country": "US",
376        "phone": "8573875756",
377        "email": "DR_STEVE_BRULE@GMAIL.COM",
378        "mode": "test",
379        "carrier_facility": null,
380        "residential": false,
381        "federal_tax_id": null,
382        "state_tax_id": null,
383        "verifications": {
384          "zip4": {
385            "success": true,
386            "errors": [],
387            "details": null
388          },
389          "delivery": {
390            "success": true,
391            "errors": [],
392            "details": {
393              "latitude": 33.8436,
394              "longitude": -118.39177,
395              "time_zone": "America/Los_Angeles"
396            }
397          }
398        }
399      },
400      "usps_zone": 4,
401      "return_address": {
402        "id": "adr_5a0f5af8ba4c11eebb69ac1f6bc53342",
403        "object": "Address",
404        "created_at": "2024-01-24T00:05:58+00:00",
405        "updated_at": "2024-01-24T00:05:58+00:00",
406        "name": "EasyPost",
407        "company": null,
408        "street1": "417 Montgomery Street",
409        "street2": "5th Floor",
410        "city": "San Francisco",
411        "state": "CA",
412        "zip": "94104",
413        "country": "US",
414        "phone": "4153334445",
415        "email": "support@easypost.com",
416        "mode": "test",
417        "carrier_facility": null,
418        "residential": null,
419        "federal_tax_id": null,
420        "state_tax_id": null,
421        "verifications": {}
422      },
423      "buyer_address": {
424        "id": "adr_5a0dc9a4ba4c11ee8df2ac1f6bc539ae",
425        "object": "Address",
426        "created_at": "2024-01-24T00:05:58+00:00",
427        "updated_at": "2024-01-24T00:05:58+00:00",
428        "name": "DR. STEVE BRULE",
429        "company": null,
430        "street1": "179 N HARBOR DR",
431        "street2": "",
432        "city": "REDONDO BEACH",
433        "state": "CA",
434        "zip": "90277-2506",
435        "country": "US",
436        "phone": "8573875756",
437        "email": "DR_STEVE_BRULE@GMAIL.COM",
438        "mode": "test",
439        "carrier_facility": null,
440        "residential": false,
441        "federal_tax_id": null,
442        "state_tax_id": null,
443        "verifications": {
444          "zip4": {
445            "success": true,
446            "errors": [],
447            "details": null
448          },
449          "delivery": {
450            "success": true,
451            "errors": [],
452            "details": {
453              "latitude": 33.8436,
454              "longitude": -118.39177,
455              "time_zone": "America/Los_Angeles"
456            }
457          }
458        }
459      },
460      "forms": [],
461      "fees": [
462        {
463          "object": "Fee",
464          "type": "LabelFee",
465          "amount": "0.00000",
466          "charged": true,
467          "refunded": false
468        },
469        {
470          "object": "Fee",
471          "type": "PostageFee",
472          "amount": "5.07000",
473          "charged": true,
474          "refunded": false
475        }
476      ],
477      "id": "shp_ca14f75e17154537a4cd8b80d31e0825",
478      "object": "Shipment"
479    }
480  ],
481  "rates": [
482    {
483      "id": "rate_985c0d7c85f545ecb6367f377df13453",
484      "object": "Rate",
485      "created_at": null,
486      "updated_at": null,
487      "mode": "test",
488      "service": "Priority",
489      "carrier": "USPS",
490      "rate": "6.88",
491      "currency": "USD",
492      "retail_rate": "9.80",
493      "retail_currency": "USD",
494      "list_rate": "8.25",
495      "list_currency": "USD",
496      "billing_type": "easypost",
497      "delivery_days": 2,
498      "delivery_date": null,
499      "delivery_date_guaranteed": false,
500      "est_delivery_days": 2,
501      "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
502      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
503    },
504    {
505      "id": "rate_01c4b156f83247d9a8087b60ba19a4e0",
506      "object": "Rate",
507      "created_at": null,
508      "updated_at": null,
509      "mode": "test",
510      "service": "GroundAdvantage",
511      "carrier": "USPS",
512      "rate": "5.07",
513      "currency": "USD",
514      "retail_rate": "6.70",
515      "retail_currency": "USD",
516      "list_rate": "5.07",
517      "list_currency": "USD",
518      "billing_type": "easypost",
519      "delivery_days": 3,
520      "delivery_date": null,
521      "delivery_date_guaranteed": false,
522      "est_delivery_days": 3,
523      "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
524      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
525    },
526    {
527      "id": "rate_b499467fd724497caf04475555082734",
528      "object": "Rate",
529      "created_at": null,
530      "updated_at": null,
531      "mode": "test",
532      "service": "First",
533      "carrier": "USPS",
534      "rate": "5.07",
535      "currency": "USD",
536      "retail_rate": "6.70",
537      "retail_currency": "USD",
538      "list_rate": "5.07",
539      "list_currency": "USD",
540      "billing_type": "easypost",
541      "delivery_days": 3,
542      "delivery_date": null,
543      "delivery_date_guaranteed": false,
544      "est_delivery_days": 3,
545      "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
546      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
547    },
548    {
549      "id": "rate_b35f9780e45d463a9cf672f04fafa3c3",
550      "object": "Rate",
551      "created_at": null,
552      "updated_at": null,
553      "mode": "test",
554      "service": "ParcelSelect",
555      "carrier": "USPS",
556      "rate": "5.07",
557      "currency": "USD",
558      "retail_rate": "6.70",
559      "retail_currency": "USD",
560      "list_rate": "5.07",
561      "list_currency": "USD",
562      "billing_type": "easypost",
563      "delivery_days": 3,
564      "delivery_date": null,
565      "delivery_date_guaranteed": false,
566      "est_delivery_days": 3,
567      "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
568      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
569    },
570    {
571      "id": "rate_b1bac17f8cc6444f8d192ed09965f667",
572      "object": "Rate",
573      "created_at": null,
574      "updated_at": null,
575      "mode": "test",
576      "service": "Express",
577      "carrier": "USPS",
578      "rate": "33.10",
579      "currency": "USD",
580      "retail_rate": "37.90",
581      "retail_currency": "USD",
582      "list_rate": "33.10",
583      "list_currency": "USD",
584      "billing_type": "easypost",
585      "delivery_days": null,
586      "delivery_date": null,
587      "delivery_date_guaranteed": false,
588      "est_delivery_days": null,
589      "shipment_id": "shp_ca14f75e17154537a4cd8b80d31e0825",
590      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
591    }
592  ],
593  "id": "order_700c1e0203b24cf192d38ba62aacdb86",
594  "object": "Order"
595}

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.

GET /orders/:id

1curl -X GET https://api.easypost.com/v2/orders/order_... \
2  -u "EASYPOST_API_KEY":

Response

1{
2  "mode": "test",
3  "reference": "",
4  "is_return": false,
5  "options": {
6    "currency": "USD",
7    "payment": {
8      "type": "SENDER"
9    }
10  },
11  "messages": [],
12  "created_at": "2024-01-24T00:05:55Z",
13  "updated_at": "2024-01-24T00:05:55Z",
14  "customs_info": null,
15  "from_address": {
16    "id": "adr_5836298bba4c11eebaecac1f6bc53342",
17    "object": "Address",
18    "created_at": "2024-01-24T00:05:55+00:00",
19    "updated_at": "2024-01-24T00:05:55+00:00",
20    "name": "EasyPost",
21    "company": null,
22    "street1": "417 Montgomery Street",
23    "street2": "5th Floor",
24    "city": "San Francisco",
25    "state": "CA",
26    "zip": "94104",
27    "country": "US",
28    "phone": "4153334445",
29    "email": "support@easypost.com",
30    "mode": "test",
31    "carrier_facility": null,
32    "residential": null,
33    "federal_tax_id": null,
34    "state_tax_id": null,
35    "verifications": {}
36  },
37  "to_address": {
38    "id": "adr_583448c1ba4c11eebaebac1f6bc53342",
39    "object": "Address",
40    "created_at": "2024-01-24T00:05:55+00:00",
41    "updated_at": "2024-01-24T00:05:55+00:00",
42    "name": "Dr. Steve Brule",
43    "company": null,
44    "street1": "179 N Harbor Dr",
45    "street2": null,
46    "city": "Redondo Beach",
47    "state": "CA",
48    "zip": "90277",
49    "country": "US",
50    "phone": "8573875756",
51    "email": "dr_steve_brule@gmail.com",
52    "mode": "test",
53    "carrier_facility": null,
54    "residential": null,
55    "federal_tax_id": null,
56    "state_tax_id": null,
57    "verifications": {}
58  },
59  "buyer_address": {
60    "id": "adr_583448c1ba4c11eebaebac1f6bc53342",
61    "object": "Address",
62    "created_at": "2024-01-24T00:05:55+00:00",
63    "updated_at": "2024-01-24T00:05:55+00:00",
64    "name": "Dr. Steve Brule",
65    "company": null,
66    "street1": "179 N Harbor Dr",
67    "street2": null,
68    "city": "Redondo Beach",
69    "state": "CA",
70    "zip": "90277",
71    "country": "US",
72    "phone": "8573875756",
73    "email": "dr_steve_brule@gmail.com",
74    "mode": "test",
75    "carrier_facility": null,
76    "residential": null,
77    "federal_tax_id": null,
78    "state_tax_id": null,
79    "verifications": {}
80  },
81  "return_address": {
82    "id": "adr_5836298bba4c11eebaecac1f6bc53342",
83    "object": "Address",
84    "created_at": "2024-01-24T00:05:55+00:00",
85    "updated_at": "2024-01-24T00:05:55+00:00",
86    "name": "EasyPost",
87    "company": null,
88    "street1": "417 Montgomery Street",
89    "street2": "5th Floor",
90    "city": "San Francisco",
91    "state": "CA",
92    "zip": "94104",
93    "country": "US",
94    "phone": "4153334445",
95    "email": "support@easypost.com",
96    "mode": "test",
97    "carrier_facility": null,
98    "residential": null,
99    "federal_tax_id": null,
100    "state_tax_id": null,
101    "verifications": {}
102  },
103  "shipments": [
104    {
105      "created_at": "2024-01-24T00:05:55Z",
106      "is_return": false,
107      "messages": [],
108      "mode": "test",
109      "options": {
110        "currency": "USD",
111        "payment": {
112          "type": "SENDER"
113        },
114        "date_advance": 0
115      },
116      "reference": null,
117      "status": "unknown",
118      "tracking_code": null,
119      "updated_at": "2024-01-24T00:05:55Z",
120      "batch_id": null,
121      "batch_status": null,
122      "batch_message": null,
123      "customs_info": null,
124      "from_address": {
125        "id": "adr_5836298bba4c11eebaecac1f6bc53342",
126        "object": "Address",
127        "created_at": "2024-01-24T00:05:55+00:00",
128        "updated_at": "2024-01-24T00:05:55+00:00",
129        "name": "EasyPost",
130        "company": null,
131        "street1": "417 Montgomery Street",
132        "street2": "5th Floor",
133        "city": "San Francisco",
134        "state": "CA",
135        "zip": "94104",
136        "country": "US",
137        "phone": "4153334445",
138        "email": "support@easypost.com",
139        "mode": "test",
140        "carrier_facility": null,
141        "residential": null,
142        "federal_tax_id": null,
143        "state_tax_id": null,
144        "verifications": {}
145      },
146      "insurance": null,
147      "order_id": "order_b567c8fffd5641608bda48f0bc58e1d6",
148      "parcel": {
149        "id": "prcl_eb7de3870d864d408017e4e5a8633b1a",
150        "object": "Parcel",
151        "created_at": "2024-01-24T00:05:55Z",
152        "updated_at": "2024-01-24T00:05:55Z",
153        "length": null,
154        "width": null,
155        "height": null,
156        "predefined_package": null,
157        "weight": 10.2,
158        "mode": "test"
159      },
160      "postage_label": null,
161      "rates": [
162        {
163          "id": "rate_46c2da4561664d5fbc7ebfca38e472d6",
164          "object": "Rate",
165          "created_at": "2024-01-24T00:05:55Z",
166          "updated_at": "2024-01-24T00:05:55Z",
167          "mode": "test",
168          "service": "Express",
169          "carrier": "USPS",
170          "rate": "33.10",
171          "currency": "USD",
172          "retail_rate": "37.90",
173          "retail_currency": "USD",
174          "list_rate": "33.10",
175          "list_currency": "USD",
176          "billing_type": "easypost",
177          "delivery_days": null,
178          "delivery_date": null,
179          "delivery_date_guaranteed": false,
180          "est_delivery_days": null,
181          "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
182          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
183        },
184        {
185          "id": "rate_5f8a285fa1094e129d121e4dfe59c314",
186          "object": "Rate",
187          "created_at": "2024-01-24T00:05:55Z",
188          "updated_at": "2024-01-24T00:05:55Z",
189          "mode": "test",
190          "service": "Priority",
191          "carrier": "USPS",
192          "rate": "6.88",
193          "currency": "USD",
194          "retail_rate": "9.80",
195          "retail_currency": "USD",
196          "list_rate": "8.25",
197          "list_currency": "USD",
198          "billing_type": "easypost",
199          "delivery_days": 2,
200          "delivery_date": null,
201          "delivery_date_guaranteed": false,
202          "est_delivery_days": 2,
203          "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
204          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
205        },
206        {
207          "id": "rate_836fd4e6359e4e40bc27bc39eff5b432",
208          "object": "Rate",
209          "created_at": "2024-01-24T00:05:55Z",
210          "updated_at": "2024-01-24T00:05:55Z",
211          "mode": "test",
212          "service": "GroundAdvantage",
213          "carrier": "USPS",
214          "rate": "5.07",
215          "currency": "USD",
216          "retail_rate": "6.70",
217          "retail_currency": "USD",
218          "list_rate": "5.07",
219          "list_currency": "USD",
220          "billing_type": "easypost",
221          "delivery_days": 3,
222          "delivery_date": null,
223          "delivery_date_guaranteed": false,
224          "est_delivery_days": 3,
225          "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
226          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
227        },
228        {
229          "id": "rate_d1fe066dc3c844c2984ac13308bf7b3e",
230          "object": "Rate",
231          "created_at": "2024-01-24T00:05:55Z",
232          "updated_at": "2024-01-24T00:05:55Z",
233          "mode": "test",
234          "service": "First",
235          "carrier": "USPS",
236          "rate": "5.07",
237          "currency": "USD",
238          "retail_rate": "6.70",
239          "retail_currency": "USD",
240          "list_rate": "5.07",
241          "list_currency": "USD",
242          "billing_type": "easypost",
243          "delivery_days": 3,
244          "delivery_date": null,
245          "delivery_date_guaranteed": false,
246          "est_delivery_days": 3,
247          "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
248          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
249        },
250        {
251          "id": "rate_3b915871b5ff4cccaec973eedde9e4bb",
252          "object": "Rate",
253          "created_at": "2024-01-24T00:05:55Z",
254          "updated_at": "2024-01-24T00:05:55Z",
255          "mode": "test",
256          "service": "ParcelSelect",
257          "carrier": "USPS",
258          "rate": "5.07",
259          "currency": "USD",
260          "retail_rate": "6.70",
261          "retail_currency": "USD",
262          "list_rate": "5.07",
263          "list_currency": "USD",
264          "billing_type": "easypost",
265          "delivery_days": 3,
266          "delivery_date": null,
267          "delivery_date_guaranteed": false,
268          "est_delivery_days": 3,
269          "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
270          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
271        }
272      ],
273      "refund_status": null,
274      "scan_form": null,
275      "selected_rate": null,
276      "tracker": null,
277      "to_address": {
278        "id": "adr_583448c1ba4c11eebaebac1f6bc53342",
279        "object": "Address",
280        "created_at": "2024-01-24T00:05:55+00:00",
281        "updated_at": "2024-01-24T00:05:55+00:00",
282        "name": "Dr. Steve Brule",
283        "company": null,
284        "street1": "179 N Harbor Dr",
285        "street2": null,
286        "city": "Redondo Beach",
287        "state": "CA",
288        "zip": "90277",
289        "country": "US",
290        "phone": "8573875756",
291        "email": "dr_steve_brule@gmail.com",
292        "mode": "test",
293        "carrier_facility": null,
294        "residential": null,
295        "federal_tax_id": null,
296        "state_tax_id": null,
297        "verifications": {}
298      },
299      "usps_zone": 4,
300      "return_address": {
301        "id": "adr_5836298bba4c11eebaecac1f6bc53342",
302        "object": "Address",
303        "created_at": "2024-01-24T00:05:55+00:00",
304        "updated_at": "2024-01-24T00:05:55+00:00",
305        "name": "EasyPost",
306        "company": null,
307        "street1": "417 Montgomery Street",
308        "street2": "5th Floor",
309        "city": "San Francisco",
310        "state": "CA",
311        "zip": "94104",
312        "country": "US",
313        "phone": "4153334445",
314        "email": "support@easypost.com",
315        "mode": "test",
316        "carrier_facility": null,
317        "residential": null,
318        "federal_tax_id": null,
319        "state_tax_id": null,
320        "verifications": {}
321      },
322      "buyer_address": {
323        "id": "adr_583448c1ba4c11eebaebac1f6bc53342",
324        "object": "Address",
325        "created_at": "2024-01-24T00:05:55+00:00",
326        "updated_at": "2024-01-24T00:05:55+00:00",
327        "name": "Dr. Steve Brule",
328        "company": null,
329        "street1": "179 N Harbor Dr",
330        "street2": null,
331        "city": "Redondo Beach",
332        "state": "CA",
333        "zip": "90277",
334        "country": "US",
335        "phone": "8573875756",
336        "email": "dr_steve_brule@gmail.com",
337        "mode": "test",
338        "carrier_facility": null,
339        "residential": null,
340        "federal_tax_id": null,
341        "state_tax_id": null,
342        "verifications": {}
343      },
344      "forms": [],
345      "fees": [],
346      "id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
347      "object": "Shipment"
348    }
349  ],
350  "rates": [
351    {
352      "id": "rate_46c2da4561664d5fbc7ebfca38e472d6",
353      "object": "Rate",
354      "created_at": null,
355      "updated_at": null,
356      "mode": "test",
357      "service": "Express",
358      "carrier": "USPS",
359      "rate": "33.10",
360      "currency": "USD",
361      "retail_rate": "37.90",
362      "retail_currency": "USD",
363      "list_rate": "33.10",
364      "list_currency": "USD",
365      "billing_type": "easypost",
366      "delivery_days": null,
367      "delivery_date": null,
368      "delivery_date_guaranteed": false,
369      "est_delivery_days": null,
370      "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
371      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
372    },
373    {
374      "id": "rate_5f8a285fa1094e129d121e4dfe59c314",
375      "object": "Rate",
376      "created_at": null,
377      "updated_at": null,
378      "mode": "test",
379      "service": "Priority",
380      "carrier": "USPS",
381      "rate": "6.88",
382      "currency": "USD",
383      "retail_rate": "9.80",
384      "retail_currency": "USD",
385      "list_rate": "8.25",
386      "list_currency": "USD",
387      "billing_type": "easypost",
388      "delivery_days": 2,
389      "delivery_date": null,
390      "delivery_date_guaranteed": false,
391      "est_delivery_days": 2,
392      "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
393      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
394    },
395    {
396      "id": "rate_836fd4e6359e4e40bc27bc39eff5b432",
397      "object": "Rate",
398      "created_at": null,
399      "updated_at": null,
400      "mode": "test",
401      "service": "GroundAdvantage",
402      "carrier": "USPS",
403      "rate": "5.07",
404      "currency": "USD",
405      "retail_rate": "6.70",
406      "retail_currency": "USD",
407      "list_rate": "5.07",
408      "list_currency": "USD",
409      "billing_type": "easypost",
410      "delivery_days": 3,
411      "delivery_date": null,
412      "delivery_date_guaranteed": false,
413      "est_delivery_days": 3,
414      "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
415      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
416    },
417    {
418      "id": "rate_d1fe066dc3c844c2984ac13308bf7b3e",
419      "object": "Rate",
420      "created_at": null,
421      "updated_at": null,
422      "mode": "test",
423      "service": "First",
424      "carrier": "USPS",
425      "rate": "5.07",
426      "currency": "USD",
427      "retail_rate": "6.70",
428      "retail_currency": "USD",
429      "list_rate": "5.07",
430      "list_currency": "USD",
431      "billing_type": "easypost",
432      "delivery_days": 3,
433      "delivery_date": null,
434      "delivery_date_guaranteed": false,
435      "est_delivery_days": 3,
436      "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
437      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
438    },
439    {
440      "id": "rate_3b915871b5ff4cccaec973eedde9e4bb",
441      "object": "Rate",
442      "created_at": null,
443      "updated_at": null,
444      "mode": "test",
445      "service": "ParcelSelect",
446      "carrier": "USPS",
447      "rate": "5.07",
448      "currency": "USD",
449      "retail_rate": "6.70",
450      "retail_currency": "USD",
451      "list_rate": "5.07",
452      "list_currency": "USD",
453      "billing_type": "easypost",
454      "delivery_days": 3,
455      "delivery_date": null,
456      "delivery_date_guaranteed": false,
457      "est_delivery_days": 3,
458      "shipment_id": "shp_1df4e5ffe3ed4909b17b23d56f532c69",
459      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
460    }
461  ],
462  "id": "order_b567c8fffd5641608bda48f0bc58e1d6",
463  "object": "Order"
464}