Explore this content on our NEW Developer Docs website.

API Documentation

Authentication

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

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

You can manage your API Keys from your account.

EasyPost Objects

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

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

Errors

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

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

Full List of Error Codes

Error Object

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

FieldError Object

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

Common HTTP Status Codes

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

Pagination

Most "retrieve all" object responses from EasyPost are paginated. The request accepts a variety of parameters which can be used to modify the scope. The has_more attribute indicates whether or not additional pages can be requested. Records are returned in descending order (most recent first). The recommended way of paginating is to use either the before_id and after_id or start_datetime and end_datetime parameters to specify where the next page begins. Alternatively, you can use the optional page_size parameter that accepts an integer of how many records you would like per page. We limit the number of records per page to 100, most endpoints default to 20. Default page sizes and support for the before_id, after_id, start_datetime, and end_datetime parameters vary by endpoint.

If you need to retrieve a successive page when the has_more key is present, make another "retrieve all" request as before and set the before_id to the ID of the last item returned. Let's look at an example. If you were retrieving a shipment and your page_size was set to 20 but you had 140 results, there would be 7 pages of 20 results each. To get to page 2, you would need to set the before_id to the response['shipments'][19]['id']. To get to the next page, you would continue to request an additional page while specifying the last ID of the previous request. If you needed all results for a particular object, you would continue retrieving pages until the has_more key returns as false, indicating that all results have been retrieved.

Request Parameters
paramexampleinfo
collectionshipmentsA collection that contains a results page
page_size30The number of records to return on each page. The maximum value is 100, and default is 20.
Example
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

// Get first page of results
$shipments = $client->shipment->all([
    'page_size' => 5,
]);

// Provide the previous results page to move onto the next page
$nextPage = $client->shipments->getNextPage($shipments);

echo $nextPage;
{
  "shipments": [
    {
      "created_at": "2024-01-24T00:07:32Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {
        "currency": "USD",
        "payment": {
          "type": "SENDER"
        },
        "date_advance": 0
      },
      "reference": null,
      "status": "delivered",
      "tracking_code": "9434600207552011812848",
      "updated_at": "2024-01-24T00:12:41Z",
      "batch_id": null,
      "batch_status": null,
      "batch_message": null,
      "customs_info": {
        "id": "cstinfo_fd42061296ef450285b451ef66f9b9d5",
        "object": "CustomsInfo",
        "created_at": "2024-01-24T00:07:32Z",
        "updated_at": "2024-01-24T00:07:32Z",
        "contents_explanation": "",
        "contents_type": "merchandise",
        "customs_certify": true,
        "customs_signer": "Steve Brule",
        "eel_pfc": "NOEEI 30.37(a)",
        "non_delivery_option": "return",
        "restriction_comments": null,
        "restriction_type": "none",
        "mode": "test",
        "declaration": null,
        "customs_items": [
          {
            "id": "cstitem_f7de527850e34f018ef41e9f69be6758",
            "object": "CustomsItem",
            "created_at": "2024-01-24T00:07:32Z",
            "updated_at": "2024-01-24T00:07:32Z",
            "description": "T-shirt",
            "hs_tariff_number": "123456",
            "origin_country": "US",
            "quantity": 1,
            "value": "10.0",
            "weight": 5.0,
            "code": "123",
            "mode": "test",
            "manufacturer": null,
            "currency": null,
            "eccn": null,
            "printed_commodity_identifier": null
          }
        ]
      },
      "from_address": {
        "id": "adr_91fa95f1ba4c11ee8c59ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:32+00:00",
        "updated_at": "2024-01-24T00:07:32+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": "249.99",
      "order_id": null,
      "parcel": {
        "id": "prcl_a5e317e47ac9442988d338cb2a0fde17",
        "object": "Parcel",
        "created_at": "2024-01-24T00:07:32Z",
        "updated_at": "2024-01-24T00:07:32Z",
        "length": 20.2,
        "width": 10.9,
        "height": 5.0,
        "predefined_package": null,
        "weight": 65.9,
        "mode": "test"
      },
      "postage_label": {
        "object": "PostageLabel",
        "id": "pl_51b80cc8523d4fc28c4ab710594e0913",
        "created_at": "2024-01-24T00:07:33Z",
        "updated_at": "2024-01-24T00:07:33Z",
        "date_advance": 0,
        "integrated_form": "none",
        "label_date": "2024-01-24T00:07:33Z",
        "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/e81cecd85b82d749a19cf38dae0e30fc53.png",
        "label_pdf_url": null,
        "label_zpl_url": null,
        "label_epl2_url": null,
        "label_file": null
      },
      "rates": [
        {
          "id": "rate_6366c70cbea94c60b8d282ccf0f60ce0",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:32Z",
          "updated_at": "2024-01-24T00:07:32Z",
          "mode": "test",
          "service": "GroundAdvantage",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_7dd1fb53702d473bbb9eeaf53d7a72d7",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:32Z",
          "updated_at": "2024-01-24T00:07:32Z",
          "mode": "test",
          "service": "First",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_263930dcc1ef4331b9a16313f55c47d6",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:32Z",
          "updated_at": "2024-01-24T00:07:32Z",
          "mode": "test",
          "service": "ParcelSelect",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_bd7a2aa312224b43b15d56b2e818e946",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:32Z",
          "updated_at": "2024-01-24T00:07:32Z",
          "mode": "test",
          "service": "Express",
          "carrier": "USPS",
          "rate": "49.60",
          "currency": "USD",
          "retail_rate": "57.40",
          "retail_currency": "USD",
          "list_rate": "49.60",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": null,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_6ec39e90cf6b4f2d97aab43d7c946559",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:32Z",
          "updated_at": "2024-01-24T00:07:32Z",
          "mode": "test",
          "service": "Priority",
          "carrier": "USPS",
          "rate": "7.33",
          "currency": "USD",
          "retail_rate": "15.20",
          "retail_currency": "USD",
          "list_rate": "10.89",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 2,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 2,
          "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        }
      ],
      "refund_status": null,
      "scan_form": null,
      "selected_rate": {
        "id": "rate_6366c70cbea94c60b8d282ccf0f60ce0",
        "object": "Rate",
        "created_at": "2024-01-24T00:07:33Z",
        "updated_at": "2024-01-24T00:07:33Z",
        "mode": "test",
        "service": "GroundAdvantage",
        "carrier": "USPS",
        "rate": "6.79",
        "currency": "USD",
        "retail_rate": "13.15",
        "retail_currency": "USD",
        "list_rate": "9.41",
        "list_currency": "USD",
        "billing_type": "easypost",
        "delivery_days": 3,
        "delivery_date": null,
        "delivery_date_guaranteed": false,
        "est_delivery_days": 3,
        "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
      },
      "tracker": {
        "id": "trk_814a807c3fae4203a4d61293b2b0b3dc",
        "object": "Tracker",
        "mode": "test",
        "tracking_code": "9434600207552011812848",
        "status": "delivered",
        "status_detail": "arrived_at_destination",
        "created_at": "2024-01-24T00:07:34Z",
        "updated_at": "2024-01-24T00:10:34Z",
        "signed_by": "John Tester",
        "weight": null,
        "est_delivery_date": "2024-01-24T00:10:34Z",
        "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
        "carrier": "USPS",
        "tracking_details": [
          {
            "object": "TrackingDetail",
            "message": "Pre-Shipment Info Sent to USPS",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T00:10:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": null,
              "state": null,
              "country": null,
              "zip": null
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Shipping Label Created",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T12:47:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77063"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Origin Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-24T22:52:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "NORTH HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77315"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T00:28:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "COLUMBIA",
              "state": "SC",
              "country": null,
              "zip": "29201"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at Post Office",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T03:19:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Sorting Complete",
            "description": "",
            "status": "in_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-26T08:59:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Out for Delivery",
            "description": "",
            "status": "out_for_delivery",
            "status_detail": "out_for_delivery",
            "datetime": "2023-12-26T09:09:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Delivered",
            "description": "",
            "status": "delivered",
            "status_detail": "arrived_at_destination",
            "datetime": "2023-12-26T14:01:34Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          }
        ],
        "fees": [],
        "carrier_detail": {
          "object": "CarrierDetail",
          "service": "First-Class Package Service",
          "container_type": null,
          "est_delivery_date_local": null,
          "est_delivery_time_local": null,
          "origin_location": "HOUSTON TX, 77001",
          "origin_tracking_location": {
            "object": "TrackingLocation",
            "city": "NORTH HOUSTON",
            "state": "TX",
            "country": null,
            "zip": "77315"
          },
          "destination_location": "CHARLESTON SC, 29401",
          "destination_tracking_location": {
            "object": "TrackingLocation",
            "city": "CHARLESTON",
            "state": "SC",
            "country": null,
            "zip": "29407"
          },
          "guaranteed_delivery_date": null,
          "alternate_identifier": null,
          "initial_delivery_attempt": "2023-12-26T14:01:34Z"
        },
        "public_url": "https://track.easypost.com/djE6dHJrXzgxNGE4MDdjM2ZhZTQyMDNhNGQ2MTI5M2IyYjBiM2Rj"
      },
      "to_address": {
        "id": "adr_91f7ca0fba4c11eeb731ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:07:32+00:00",
        "updated_at": "2024-01-24T00:07:33+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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_91fa95f1ba4c11ee8c59ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:32+00:00",
        "updated_at": "2024-01-24T00:07:32+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_91f7ca0fba4c11eeb731ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:07:32+00:00",
        "updated_at": "2024-01-24T00:07:33+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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": "6.79000",
          "charged": true,
          "refunded": false
        },
        {
          "object": "Fee",
          "type": "InsuranceFee",
          "amount": "1.24995",
          "charged": true,
          "refunded": false
        }
      ],
      "id": "shp_56b10c708daa4c25b5895c5354758aaf",
      "object": "Shipment"
    },
    {
      "created_at": "2024-01-24T00:07:28Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {
        "currency": "USD",
        "payment": {
          "type": "SENDER"
        },
        "date_advance": 0
      },
      "reference": null,
      "status": "delivered",
      "tracking_code": "9405500207552011812825",
      "updated_at": "2024-01-24T00:12:32Z",
      "batch_id": "batch_83009a1272fa48ffb1a3d29074a16960",
      "batch_status": "postage_purchased",
      "batch_message": null,
      "customs_info": {
        "id": "cstinfo_916710a3039140c5a6e7f2f812ef83d7",
        "object": "CustomsInfo",
        "created_at": "2024-01-24T00:07:28Z",
        "updated_at": "2024-01-24T00:07:28Z",
        "contents_explanation": "",
        "contents_type": "merchandise",
        "customs_certify": true,
        "customs_signer": "Steve Brule",
        "eel_pfc": "NOEEI 30.37(a)",
        "non_delivery_option": "return",
        "restriction_comments": null,
        "restriction_type": "none",
        "mode": "test",
        "declaration": null,
        "customs_items": [
          {
            "id": "cstitem_eead7973a2d644189ebd7c8f11f9647a",
            "object": "CustomsItem",
            "created_at": "2024-01-24T00:07:28Z",
            "updated_at": "2024-01-24T00:07:28Z",
            "description": "T-shirt",
            "hs_tariff_number": "123456",
            "origin_country": "US",
            "quantity": 1,
            "value": "10.0",
            "weight": 5.0,
            "code": "123",
            "mode": "test",
            "manufacturer": null,
            "currency": null,
            "eccn": null,
            "printed_commodity_identifier": null
          }
        ]
      },
      "from_address": {
        "id": "adr_8f5e7e74ba4c11ee8bd0ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:28+00:00",
        "updated_at": "2024-01-24T00:07:28+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": null,
      "parcel": {
        "id": "prcl_bba0f7cc48d64a299938fef3a3e0b9a0",
        "object": "Parcel",
        "created_at": "2024-01-24T00:07:28Z",
        "updated_at": "2024-01-24T00:07:28Z",
        "length": 20.2,
        "width": 10.9,
        "height": 5.0,
        "predefined_package": null,
        "weight": 65.9,
        "mode": "test"
      },
      "postage_label": {
        "object": "PostageLabel",
        "id": "pl_9562571fa39b4e49892a8c60f12be255",
        "created_at": "2024-01-24T00:07:28Z",
        "updated_at": "2024-01-24T00:07:28Z",
        "date_advance": 0,
        "integrated_form": "none",
        "label_date": "2024-01-24T00:07:28Z",
        "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/e8a95864fe9ec34eeabf5fc2ad415fda5d.png",
        "label_pdf_url": null,
        "label_zpl_url": null,
        "label_epl2_url": null,
        "label_file": null
      },
      "rates": [
        {
          "id": "rate_15a03f25e00d49a098da8d40c8e1719e",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:28Z",
          "updated_at": "2024-01-24T00:07:28Z",
          "mode": "test",
          "service": "Express",
          "carrier": "USPS",
          "rate": "49.60",
          "currency": "USD",
          "retail_rate": "57.40",
          "retail_currency": "USD",
          "list_rate": "49.60",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": null,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_edd7e3cedd9d4aa9bd21eb23a740af7d",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:28Z",
          "updated_at": "2024-01-24T00:07:28Z",
          "mode": "test",
          "service": "Priority",
          "carrier": "USPS",
          "rate": "7.33",
          "currency": "USD",
          "retail_rate": "15.20",
          "retail_currency": "USD",
          "list_rate": "10.89",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 2,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 2,
          "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_bc0979e7fa314d2b935d8fee9312c766",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:28Z",
          "updated_at": "2024-01-24T00:07:28Z",
          "mode": "test",
          "service": "GroundAdvantage",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_418622e2edeb4015b8bbd72fbe2d3ff6",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:28Z",
          "updated_at": "2024-01-24T00:07:28Z",
          "mode": "test",
          "service": "First",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_699f9b847989489891a0db1489c6c0f2",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:28Z",
          "updated_at": "2024-01-24T00:07:28Z",
          "mode": "test",
          "service": "ParcelSelect",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        }
      ],
      "refund_status": null,
      "scan_form": {
        "id": "sf_589e52186e9249669c7806912a6ab766",
        "object": "ScanForm",
        "created_at": "2024-01-24T00:07:29Z",
        "updated_at": "2024-01-24T00:07:29Z",
        "tracking_codes": ["9405500207552011812825"],
        "address": {
          "id": "adr_8f5e7e74ba4c11ee8bd0ac1f6bc53342",
          "object": "Address",
          "created_at": "2024-01-24T00:07:28+00:00",
          "updated_at": "2024-01-24T00:07:28+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": {}
        },
        "status": "created",
        "message": null,
        "form_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/scan_form/20240124/e82a4cb71096604dc7bd773b1285d7e9db.pdf",
        "form_file_type": null,
        "batch_id": "batch_83009a1272fa48ffb1a3d29074a16960",
        "confirmation": null
      },
      "selected_rate": {
        "id": "rate_edd7e3cedd9d4aa9bd21eb23a740af7d",
        "object": "Rate",
        "created_at": "2024-01-24T00:07:28Z",
        "updated_at": "2024-01-24T00:07:28Z",
        "mode": "test",
        "service": "Priority",
        "carrier": "USPS",
        "rate": "7.33",
        "currency": "USD",
        "retail_rate": "15.20",
        "retail_currency": "USD",
        "list_rate": "10.89",
        "list_currency": "USD",
        "billing_type": "easypost",
        "delivery_days": 2,
        "delivery_date": null,
        "delivery_date_guaranteed": false,
        "est_delivery_days": 2,
        "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
      },
      "tracker": {
        "id": "trk_c64aa4ee22804cceab41586397c4b833",
        "object": "Tracker",
        "mode": "test",
        "tracking_code": "9405500207552011812825",
        "status": "delivered",
        "status_detail": "arrived_at_destination",
        "created_at": "2024-01-24T00:07:28Z",
        "updated_at": "2024-01-24T00:10:29Z",
        "signed_by": "John Tester",
        "weight": null,
        "est_delivery_date": "2024-01-24T00:10:29Z",
        "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
        "carrier": "USPS",
        "tracking_details": [
          {
            "object": "TrackingDetail",
            "message": "Pre-Shipment Info Sent to USPS",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T00:10:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": null,
              "state": null,
              "country": null,
              "zip": null
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Shipping Label Created",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T12:47:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77063"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Origin Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-24T22:52:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "NORTH HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77315"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T00:28:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "COLUMBIA",
              "state": "SC",
              "country": null,
              "zip": "29201"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at Post Office",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T03:19:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Sorting Complete",
            "description": "",
            "status": "in_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-26T08:59:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Out for Delivery",
            "description": "",
            "status": "out_for_delivery",
            "status_detail": "out_for_delivery",
            "datetime": "2023-12-26T09:09:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Delivered",
            "description": "",
            "status": "delivered",
            "status_detail": "arrived_at_destination",
            "datetime": "2023-12-26T14:01:29Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          }
        ],
        "fees": [],
        "carrier_detail": {
          "object": "CarrierDetail",
          "service": "First-Class Package Service",
          "container_type": null,
          "est_delivery_date_local": null,
          "est_delivery_time_local": null,
          "origin_location": "HOUSTON TX, 77001",
          "origin_tracking_location": {
            "object": "TrackingLocation",
            "city": "NORTH HOUSTON",
            "state": "TX",
            "country": null,
            "zip": "77315"
          },
          "destination_location": "CHARLESTON SC, 29401",
          "destination_tracking_location": {
            "object": "TrackingLocation",
            "city": "CHARLESTON",
            "state": "SC",
            "country": null,
            "zip": "29407"
          },
          "guaranteed_delivery_date": null,
          "alternate_identifier": null,
          "initial_delivery_attempt": "2023-12-26T14:01:29Z"
        },
        "public_url": "https://track.easypost.com/djE6dHJrX2M2NGFhNGVlMjI4MDRjY2VhYjQxNTg2Mzk3YzRiODMz"
      },
      "to_address": {
        "id": "adr_8f5bb1f5ba4c11eeb6a1ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:07:28+00:00",
        "updated_at": "2024-01-24T00:07:28+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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_8f5e7e74ba4c11ee8bd0ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:28+00:00",
        "updated_at": "2024-01-24T00:07:28+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_8f5bb1f5ba4c11eeb6a1ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:07:28+00:00",
        "updated_at": "2024-01-24T00:07:28+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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": "7.33000",
          "charged": true,
          "refunded": false
        }
      ],
      "id": "shp_8631f00640ba4d62b9131da3852a26e4",
      "object": "Shipment"
    },
    {
      "created_at": "2024-01-24T00:07:26Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {
        "currency": "USD",
        "payment": {
          "type": "SENDER"
        },
        "date_advance": 0
      },
      "reference": null,
      "status": "delivered",
      "tracking_code": "9405500207552011812801",
      "updated_at": "2024-01-24T00:12:47Z",
      "batch_id": "batch_78507c9db0574b02813cf08bd52357b5",
      "batch_status": "postage_purchased",
      "batch_message": null,
      "customs_info": {
        "id": "cstinfo_69ebc90449834b8eb70fa2e37fa35616",
        "object": "CustomsInfo",
        "created_at": "2024-01-24T00:07:25Z",
        "updated_at": "2024-01-24T00:07:25Z",
        "contents_explanation": "",
        "contents_type": "merchandise",
        "customs_certify": true,
        "customs_signer": "Steve Brule",
        "eel_pfc": "NOEEI 30.37(a)",
        "non_delivery_option": "return",
        "restriction_comments": null,
        "restriction_type": "none",
        "mode": "test",
        "declaration": null,
        "customs_items": [
          {
            "id": "cstitem_bde92ba44c8a4287ac0fc973f210924d",
            "object": "CustomsItem",
            "created_at": "2024-01-24T00:07:25Z",
            "updated_at": "2024-01-24T00:07:25Z",
            "description": "T-shirt",
            "hs_tariff_number": "123456",
            "origin_country": "US",
            "quantity": 1,
            "value": "10.0",
            "weight": 5.0,
            "code": "123",
            "mode": "test",
            "manufacturer": null,
            "currency": null,
            "eccn": null,
            "printed_commodity_identifier": null
          }
        ]
      },
      "from_address": {
        "id": "adr_8e182c46ba4c11ee8b51ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:25+00:00",
        "updated_at": "2024-01-24T00:07:25+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": null,
      "parcel": {
        "id": "prcl_8947f119938944beab9e38a20bf28065",
        "object": "Parcel",
        "created_at": "2024-01-24T00:07:25Z",
        "updated_at": "2024-01-24T00:07:25Z",
        "length": 20.2,
        "width": 10.9,
        "height": 5.0,
        "predefined_package": null,
        "weight": 65.9,
        "mode": "test"
      },
      "postage_label": {
        "object": "PostageLabel",
        "id": "pl_a659d7cf76ca4355afc44434e33f05d3",
        "created_at": "2024-01-24T00:07:26Z",
        "updated_at": "2024-01-24T00:07:26Z",
        "date_advance": 0,
        "integrated_form": "none",
        "label_date": "2024-01-24T00:07:26Z",
        "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/e8cad15c8172b44e2e980a0516615cfba9.png",
        "label_pdf_url": null,
        "label_zpl_url": null,
        "label_epl2_url": null,
        "label_file": null
      },
      "rates": [
        {
          "id": "rate_c714eae3a1fc48a1bd85e49c3f96c005",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:26Z",
          "updated_at": "2024-01-24T00:07:26Z",
          "mode": "test",
          "service": "Express",
          "carrier": "USPS",
          "rate": "49.60",
          "currency": "USD",
          "retail_rate": "57.40",
          "retail_currency": "USD",
          "list_rate": "49.60",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": null,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_0b93175feadd47039abe963dde90444b",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:26Z",
          "updated_at": "2024-01-24T00:07:26Z",
          "mode": "test",
          "service": "Priority",
          "carrier": "USPS",
          "rate": "7.33",
          "currency": "USD",
          "retail_rate": "15.20",
          "retail_currency": "USD",
          "list_rate": "10.89",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 2,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 2,
          "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_1e8880da5f074d6ca2dfcf7bc0c1e5e6",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:26Z",
          "updated_at": "2024-01-24T00:07:26Z",
          "mode": "test",
          "service": "GroundAdvantage",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_4d551632239948f0abd18400a5c65452",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:26Z",
          "updated_at": "2024-01-24T00:07:26Z",
          "mode": "test",
          "service": "First",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_d0d1de3a02ad419fa6079eb2dfb48e27",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:26Z",
          "updated_at": "2024-01-24T00:07:26Z",
          "mode": "test",
          "service": "ParcelSelect",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        }
      ],
      "refund_status": null,
      "scan_form": {
        "id": "sf_e79db685aecd4c7286471ff06a27a121",
        "object": "ScanForm",
        "created_at": "2024-01-24T00:07:27Z",
        "updated_at": "2024-01-24T00:07:27Z",
        "tracking_codes": ["9405500207552011812801"],
        "address": {
          "id": "adr_8e182c46ba4c11ee8b51ac1f6bc53342",
          "object": "Address",
          "created_at": "2024-01-24T00:07:25+00:00",
          "updated_at": "2024-01-24T00:07:25+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": {}
        },
        "status": "created",
        "message": null,
        "form_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/scan_form/20240124/e872ec72373078434880f49a17e5788dcc.pdf",
        "form_file_type": null,
        "batch_id": "batch_78507c9db0574b02813cf08bd52357b5",
        "confirmation": null
      },
      "selected_rate": {
        "id": "rate_0b93175feadd47039abe963dde90444b",
        "object": "Rate",
        "created_at": "2024-01-24T00:07:26Z",
        "updated_at": "2024-01-24T00:07:26Z",
        "mode": "test",
        "service": "Priority",
        "carrier": "USPS",
        "rate": "7.33",
        "currency": "USD",
        "retail_rate": "15.20",
        "retail_currency": "USD",
        "list_rate": "10.89",
        "list_currency": "USD",
        "billing_type": "easypost",
        "delivery_days": 2,
        "delivery_date": null,
        "delivery_date_guaranteed": false,
        "est_delivery_days": 2,
        "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
      },
      "tracker": {
        "id": "trk_93626d9d84f949588508785ad04af706",
        "object": "Tracker",
        "mode": "test",
        "tracking_code": "9405500207552011812801",
        "status": "delivered",
        "status_detail": "arrived_at_destination",
        "created_at": "2024-01-24T00:07:27Z",
        "updated_at": "2024-01-24T00:10:27Z",
        "signed_by": "John Tester",
        "weight": null,
        "est_delivery_date": "2024-01-24T00:10:27Z",
        "shipment_id": "shp_208d189a9f1f4295887b82aaa7b109e9",
        "carrier": "USPS",
        "tracking_details": [
          {
            "object": "TrackingDetail",
            "message": "Pre-Shipment Info Sent to USPS",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T00:10:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": null,
              "state": null,
              "country": null,
              "zip": null
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Shipping Label Created",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T12:47:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77063"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Origin Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-24T22:52:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "NORTH HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77315"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T00:28:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "COLUMBIA",
              "state": "SC",
              "country": null,
              "zip": "29201"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at Post Office",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T03:19:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Sorting Complete",
            "description": "",
            "status": "in_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-26T08:59:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Out for Delivery",
            "description": "",
            "status": "out_for_delivery",
            "status_detail": "out_for_delivery",
            "datetime": "2023-12-26T09:09:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Delivered",
            "description": "",
            "status": "delivered",
            "status_detail": "arrived_at_destination",
            "datetime": "2023-12-26T14:01:27Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          }
        ],
        "fees": [],
        "carrier_detail": {
          "object": "CarrierDetail",
          "service": "First-Class Package Service",
          "container_type": null,
          "est_delivery_date_local": null,
          "est_delivery_time_local": null,
          "origin_location": "HOUSTON TX, 77001",
          "origin_tracking_location": {
            "object": "TrackingLocation",
            "city": "NORTH HOUSTON",
            "state": "TX",
            "country": null,
            "zip": "77315"
          },
          "destination_location": "CHARLESTON SC, 29401",
          "destination_tracking_location": {
            "object": "TrackingLocation",
            "city": "CHARLESTON",
            "state": "SC",
            "country": null,
            "zip": "29407"
          },
          "guaranteed_delivery_date": null,
          "alternate_identifier": null,
          "initial_delivery_attempt": "2023-12-26T14:01:27Z"
        },
        "public_url": "https://track.easypost.com/djE6dHJrXzkzNjI2ZDlkODRmOTQ5NTg4NTA4Nzg1YWQwNGFmNzA2"
      },
      "to_address": {
        "id": "adr_8e15a60dba4c11ee8b50ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:25+00:00",
        "updated_at": "2024-01-24T00:07:26+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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_8e182c46ba4c11ee8b51ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:25+00:00",
        "updated_at": "2024-01-24T00:07:25+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_8e15a60dba4c11ee8b50ac1f6bc53342",
        "object": "Address",
        "created_at": "2024-01-24T00:07:25+00:00",
        "updated_at": "2024-01-24T00:07:26+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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": "7.33000",
          "charged": true,
          "refunded": false
        }
      ],
      "id": "shp_208d189a9f1f4295887b82aaa7b109e9",
      "object": "Shipment"
    },
    {
      "created_at": "2024-01-24T00:07:21Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {
        "currency": "USD",
        "payment": {
          "type": "SENDER"
        },
        "date_advance": 0
      },
      "reference": null,
      "status": "delivered",
      "tracking_code": "9405500207552011812764",
      "updated_at": "2024-01-24T00:12:37Z",
      "batch_id": null,
      "batch_status": null,
      "batch_message": null,
      "customs_info": {
        "id": "cstinfo_a44c00ad084a4e49b36a578c7ad12b3c",
        "object": "CustomsInfo",
        "created_at": "2024-01-24T00:07:21Z",
        "updated_at": "2024-01-24T00:07:21Z",
        "contents_explanation": "",
        "contents_type": "merchandise",
        "customs_certify": true,
        "customs_signer": "Steve Brule",
        "eel_pfc": "NOEEI 30.37(a)",
        "non_delivery_option": "return",
        "restriction_comments": null,
        "restriction_type": "none",
        "mode": "test",
        "declaration": null,
        "customs_items": [
          {
            "id": "cstitem_b649f3eb9b274f258949128a27f09216",
            "object": "CustomsItem",
            "created_at": "2024-01-24T00:07:21Z",
            "updated_at": "2024-01-24T00:07:21Z",
            "description": "T-shirt",
            "hs_tariff_number": "123456",
            "origin_country": "US",
            "quantity": 1,
            "value": "10.0",
            "weight": 5.0,
            "code": "123",
            "mode": "test",
            "manufacturer": null,
            "currency": null,
            "eccn": null,
            "printed_commodity_identifier": null
          }
        ]
      },
      "from_address": {
        "id": "adr_8b3ce1a8ba4c11ee9cceac1f6bc539ae",
        "object": "Address",
        "created_at": "2024-01-24T00:07:21+00:00",
        "updated_at": "2024-01-24T00:07:21+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": null,
      "parcel": {
        "id": "prcl_87da9db943434645bf7ea1610147ac67",
        "object": "Parcel",
        "created_at": "2024-01-24T00:07:21Z",
        "updated_at": "2024-01-24T00:07:21Z",
        "length": 20.2,
        "width": 10.9,
        "height": 5.0,
        "predefined_package": null,
        "weight": 65.9,
        "mode": "test"
      },
      "postage_label": {
        "object": "PostageLabel",
        "id": "pl_34135cc591ac4f1a808376739352bc39",
        "created_at": "2024-01-24T00:07:21Z",
        "updated_at": "2024-01-24T00:07:22Z",
        "date_advance": 0,
        "integrated_form": "none",
        "label_date": "2024-01-24T00:07:21Z",
        "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/e889e96a35fb8f4ae5adfbf0be34ed5540.png",
        "label_pdf_url": null,
        "label_zpl_url": null,
        "label_epl2_url": null,
        "label_file": null
      },
      "rates": [
        {
          "id": "rate_0c0663b91d934929996da5f9f28b746a",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:21Z",
          "updated_at": "2024-01-24T00:07:21Z",
          "mode": "test",
          "service": "Priority",
          "carrier": "USPS",
          "rate": "7.33",
          "currency": "USD",
          "retail_rate": "15.20",
          "retail_currency": "USD",
          "list_rate": "10.89",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 2,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 2,
          "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_4ba349e49b554887af64f77dbb11a7ed",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:21Z",
          "updated_at": "2024-01-24T00:07:21Z",
          "mode": "test",
          "service": "GroundAdvantage",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_0836612f559b43c0b6a10953d9ba6cf1",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:21Z",
          "updated_at": "2024-01-24T00:07:21Z",
          "mode": "test",
          "service": "First",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_8491f22e06134c738c6f596f40c73f55",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:21Z",
          "updated_at": "2024-01-24T00:07:21Z",
          "mode": "test",
          "service": "ParcelSelect",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_378eb83c9ae54608990f4e048377f2c2",
          "object": "Rate",
          "created_at": "2024-01-24T00:07:21Z",
          "updated_at": "2024-01-24T00:07:21Z",
          "mode": "test",
          "service": "Express",
          "carrier": "USPS",
          "rate": "49.60",
          "currency": "USD",
          "retail_rate": "57.40",
          "retail_currency": "USD",
          "list_rate": "49.60",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": null,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        }
      ],
      "refund_status": "submitted",
      "scan_form": null,
      "selected_rate": {
        "id": "rate_0c0663b91d934929996da5f9f28b746a",
        "object": "Rate",
        "created_at": "2024-01-24T00:07:21Z",
        "updated_at": "2024-01-24T00:07:21Z",
        "mode": "test",
        "service": "Priority",
        "carrier": "USPS",
        "rate": "7.33",
        "currency": "USD",
        "retail_rate": "15.20",
        "retail_currency": "USD",
        "list_rate": "10.89",
        "list_currency": "USD",
        "billing_type": "easypost",
        "delivery_days": 2,
        "delivery_date": null,
        "delivery_date_guaranteed": false,
        "est_delivery_days": 2,
        "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
      },
      "tracker": {
        "id": "trk_81d0206395de4e288057266dd3870591",
        "object": "Tracker",
        "mode": "test",
        "tracking_code": "9405500207552011812764",
        "status": "delivered",
        "status_detail": "arrived_at_destination",
        "created_at": "2024-01-24T00:07:22Z",
        "updated_at": "2024-01-24T00:10:22Z",
        "signed_by": "John Tester",
        "weight": null,
        "est_delivery_date": "2024-01-24T00:10:22Z",
        "shipment_id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
        "carrier": "USPS",
        "tracking_details": [
          {
            "object": "TrackingDetail",
            "message": "Pre-Shipment Info Sent to USPS",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T00:10:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": null,
              "state": null,
              "country": null,
              "zip": null
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Shipping Label Created",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T12:47:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77063"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Origin Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-24T22:52:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "NORTH HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77315"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T00:28:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "COLUMBIA",
              "state": "SC",
              "country": null,
              "zip": "29201"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at Post Office",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T03:19:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Sorting Complete",
            "description": "",
            "status": "in_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-26T08:59:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Out for Delivery",
            "description": "",
            "status": "out_for_delivery",
            "status_detail": "out_for_delivery",
            "datetime": "2023-12-26T09:09:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Delivered",
            "description": "",
            "status": "delivered",
            "status_detail": "arrived_at_destination",
            "datetime": "2023-12-26T14:01:22Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          }
        ],
        "fees": [],
        "carrier_detail": {
          "object": "CarrierDetail",
          "service": "First-Class Package Service",
          "container_type": null,
          "est_delivery_date_local": null,
          "est_delivery_time_local": null,
          "origin_location": "HOUSTON TX, 77001",
          "origin_tracking_location": {
            "object": "TrackingLocation",
            "city": "NORTH HOUSTON",
            "state": "TX",
            "country": null,
            "zip": "77315"
          },
          "destination_location": "CHARLESTON SC, 29401",
          "destination_tracking_location": {
            "object": "TrackingLocation",
            "city": "CHARLESTON",
            "state": "SC",
            "country": null,
            "zip": "29407"
          },
          "guaranteed_delivery_date": null,
          "alternate_identifier": null,
          "initial_delivery_attempt": "2023-12-26T14:01:22Z"
        },
        "public_url": "https://track.easypost.com/djE6dHJrXzgxZDAyMDYzOTVkZTRlMjg4MDU3MjY2ZGQzODcwNTkx"
      },
      "to_address": {
        "id": "adr_8b3a39beba4c11eeb55cac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:07:21+00:00",
        "updated_at": "2024-01-24T00:07:21+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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_8b3ce1a8ba4c11ee9cceac1f6bc539ae",
        "object": "Address",
        "created_at": "2024-01-24T00:07:21+00:00",
        "updated_at": "2024-01-24T00:07:21+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_8b3a39beba4c11eeb55cac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:07:21+00:00",
        "updated_at": "2024-01-24T00:07:21+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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": "7.33000",
          "charged": true,
          "refunded": false
        }
      ],
      "id": "shp_c3b0a61f204b4593a1ed98a3026dc4dc",
      "object": "Shipment"
    },
    {
      "created_at": "2024-01-24T00:06:31Z",
      "is_return": false,
      "messages": [],
      "mode": "test",
      "options": {
        "currency": "USD",
        "payment": {
          "type": "SENDER"
        },
        "date_advance": 0
      },
      "reference": null,
      "status": "delivered",
      "tracking_code": "9405500207552011812689",
      "updated_at": "2024-01-24T00:11:52Z",
      "batch_id": "batch_98bf92c4f230400d93a24fa4298cc025",
      "batch_status": "postage_purchased",
      "batch_message": null,
      "customs_info": {
        "id": "cstinfo_b9b6f403171a449a9700bb4ff5171578",
        "object": "CustomsInfo",
        "created_at": "2024-01-24T00:06:31Z",
        "updated_at": "2024-01-24T00:06:31Z",
        "contents_explanation": "",
        "contents_type": "merchandise",
        "customs_certify": true,
        "customs_signer": "Steve Brule",
        "eel_pfc": "NOEEI 30.37(a)",
        "non_delivery_option": "return",
        "restriction_comments": null,
        "restriction_type": "none",
        "mode": "test",
        "declaration": null,
        "customs_items": [
          {
            "id": "cstitem_b67e595b6cea459a9b8e7aeafd4b0edd",
            "object": "CustomsItem",
            "created_at": "2024-01-24T00:06:31Z",
            "updated_at": "2024-01-24T00:06:31Z",
            "description": "T-shirt",
            "hs_tariff_number": "123456",
            "origin_country": "US",
            "quantity": 1,
            "value": "10.0",
            "weight": 5.0,
            "code": "123",
            "mode": "test",
            "manufacturer": null,
            "currency": null,
            "eccn": null,
            "printed_commodity_identifier": null
          }
        ]
      },
      "from_address": {
        "id": "adr_6d94f4a7ba4c11eeacf7ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:06:31+00:00",
        "updated_at": "2024-01-24T00:06:31+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": null,
      "parcel": {
        "id": "prcl_c5968ce204d445acbe344bc4d6dc34ce",
        "object": "Parcel",
        "created_at": "2024-01-24T00:06:31Z",
        "updated_at": "2024-01-24T00:06:31Z",
        "length": 20.2,
        "width": 10.9,
        "height": 5.0,
        "predefined_package": null,
        "weight": 65.9,
        "mode": "test"
      },
      "postage_label": {
        "object": "PostageLabel",
        "id": "pl_49ea349da25e40e7b870e8f8dac5fa6e",
        "created_at": "2024-01-24T00:06:31Z",
        "updated_at": "2024-01-24T00:06:32Z",
        "date_advance": 0,
        "integrated_form": "none",
        "label_date": "2024-01-24T00:06:31Z",
        "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/e8be1ac5443dae47fb8321d0a5e3494b81.png",
        "label_pdf_url": null,
        "label_zpl_url": null,
        "label_epl2_url": null,
        "label_file": null
      },
      "rates": [
        {
          "id": "rate_e5722f0f792e4866b366ed45364bd485",
          "object": "Rate",
          "created_at": "2024-01-24T00:06:31Z",
          "updated_at": "2024-01-24T00:06:31Z",
          "mode": "test",
          "service": "Priority",
          "carrier": "USPS",
          "rate": "7.33",
          "currency": "USD",
          "retail_rate": "15.20",
          "retail_currency": "USD",
          "list_rate": "10.89",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 2,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 2,
          "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_cb7874a83d4745908619c1b51a1eeb0e",
          "object": "Rate",
          "created_at": "2024-01-24T00:06:31Z",
          "updated_at": "2024-01-24T00:06:31Z",
          "mode": "test",
          "service": "GroundAdvantage",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_0de7dcafef7f40d0a1669140ab42d952",
          "object": "Rate",
          "created_at": "2024-01-24T00:06:31Z",
          "updated_at": "2024-01-24T00:06:31Z",
          "mode": "test",
          "service": "First",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_314fe5c039f84dfeba7d8fe218d771f6",
          "object": "Rate",
          "created_at": "2024-01-24T00:06:31Z",
          "updated_at": "2024-01-24T00:06:31Z",
          "mode": "test",
          "service": "ParcelSelect",
          "carrier": "USPS",
          "rate": "6.79",
          "currency": "USD",
          "retail_rate": "13.15",
          "retail_currency": "USD",
          "list_rate": "9.41",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": 3,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": 3,
          "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        },
        {
          "id": "rate_bbee837039494bccb186b3f2eb9bc0e7",
          "object": "Rate",
          "created_at": "2024-01-24T00:06:31Z",
          "updated_at": "2024-01-24T00:06:31Z",
          "mode": "test",
          "service": "Express",
          "carrier": "USPS",
          "rate": "49.60",
          "currency": "USD",
          "retail_rate": "57.40",
          "retail_currency": "USD",
          "list_rate": "49.60",
          "list_currency": "USD",
          "billing_type": "easypost",
          "delivery_days": null,
          "delivery_date": null,
          "delivery_date_guaranteed": false,
          "est_delivery_days": null,
          "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
        }
      ],
      "refund_status": null,
      "scan_form": null,
      "selected_rate": {
        "id": "rate_e5722f0f792e4866b366ed45364bd485",
        "object": "Rate",
        "created_at": "2024-01-24T00:06:32Z",
        "updated_at": "2024-01-24T00:06:32Z",
        "mode": "test",
        "service": "Priority",
        "carrier": "USPS",
        "rate": "7.33",
        "currency": "USD",
        "retail_rate": "15.20",
        "retail_currency": "USD",
        "list_rate": "10.89",
        "list_currency": "USD",
        "billing_type": "easypost",
        "delivery_days": 2,
        "delivery_date": null,
        "delivery_date_guaranteed": false,
        "est_delivery_days": 2,
        "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
      },
      "tracker": {
        "id": "trk_10e194da76924301a4f3ce47056db085",
        "object": "Tracker",
        "mode": "test",
        "tracking_code": "9405500207552011812689",
        "status": "delivered",
        "status_detail": "arrived_at_destination",
        "created_at": "2024-01-24T00:06:32Z",
        "updated_at": "2024-01-24T00:09:32Z",
        "signed_by": "John Tester",
        "weight": null,
        "est_delivery_date": "2024-01-24T00:09:32Z",
        "shipment_id": "shp_436a1adad9ac4a0d888b27f82b284dee",
        "carrier": "USPS",
        "tracking_details": [
          {
            "object": "TrackingDetail",
            "message": "Pre-Shipment Info Sent to USPS",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T00:09:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": null,
              "state": null,
              "country": null,
              "zip": null
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Shipping Label Created",
            "description": "",
            "status": "pre_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-24T12:46:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77063"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Origin Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-24T22:51:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "NORTH HOUSTON",
              "state": "TX",
              "country": null,
              "zip": "77315"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at USPS Facility",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T00:27:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "COLUMBIA",
              "state": "SC",
              "country": null,
              "zip": "29201"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Arrived at Post Office",
            "description": "",
            "status": "in_transit",
            "status_detail": "arrived_at_facility",
            "datetime": "2023-12-26T03:18:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Sorting Complete",
            "description": "",
            "status": "in_transit",
            "status_detail": "status_update",
            "datetime": "2023-12-26T08:58:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Out for Delivery",
            "description": "",
            "status": "out_for_delivery",
            "status_detail": "out_for_delivery",
            "datetime": "2023-12-26T09:08:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          },
          {
            "object": "TrackingDetail",
            "message": "Delivered",
            "description": "",
            "status": "delivered",
            "status_detail": "arrived_at_destination",
            "datetime": "2023-12-26T14:00:32Z",
            "source": "USPS",
            "carrier_code": "",
            "tracking_location": {
              "object": "TrackingLocation",
              "city": "CHARLESTON",
              "state": "SC",
              "country": null,
              "zip": "29407"
            }
          }
        ],
        "fees": [],
        "carrier_detail": {
          "object": "CarrierDetail",
          "service": "First-Class Package Service",
          "container_type": null,
          "est_delivery_date_local": null,
          "est_delivery_time_local": null,
          "origin_location": "HOUSTON TX, 77001",
          "origin_tracking_location": {
            "object": "TrackingLocation",
            "city": "NORTH HOUSTON",
            "state": "TX",
            "country": null,
            "zip": "77315"
          },
          "destination_location": "CHARLESTON SC, 29401",
          "destination_tracking_location": {
            "object": "TrackingLocation",
            "city": "CHARLESTON",
            "state": "SC",
            "country": null,
            "zip": "29407"
          },
          "guaranteed_delivery_date": null,
          "alternate_identifier": null,
          "initial_delivery_attempt": "2023-12-26T14:00:32Z"
        },
        "public_url": "https://track.easypost.com/djE6dHJrXzEwZTE5NGRhNzY5MjQzMDFhNGYzY2U0NzA1NmRiMDg1"
      },
      "to_address": {
        "id": "adr_6d931952ba4c11eeacf5ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:06:31+00:00",
        "updated_at": "2024-01-24T00:06:31+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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_6d94f4a7ba4c11eeacf7ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:06:31+00:00",
        "updated_at": "2024-01-24T00:06:31+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_6d931952ba4c11eeacf5ac1f6bc539aa",
        "object": "Address",
        "created_at": "2024-01-24T00:06:31+00:00",
        "updated_at": "2024-01-24T00:06:31+00:00",
        "name": "DR. STEVE BRULE",
        "company": null,
        "street1": "179 N HARBOR DR",
        "street2": null,
        "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": "7.33000",
          "charged": true,
          "refunded": false
        }
      ],
      "id": "shp_436a1adad9ac4a0d888b27f82b284dee",
      "object": "Shipment"
    }
  ],
  "has_more": true
}

Addresses

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

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

Address Object

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

Verifications Object

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

Verification Object

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

VerificationDetails Object

attributetypespecification
latitudenumberThe latitude
longitudenumberThe longitude
time_zoneTZ(string)The time zone the address is located in, IE: America/Los_Angeles

Address Verification by Country

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

Full List of Countries & Levels

POST/addresses

Create and Verify Addresses

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

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

Verify an Address

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

Creating a verified Address is as simple as providing verify or verify_strict in the parameters. If any of the strict verification checks fail, an error will be returned from the API. The example below demonstrates verifying delivery, which checks that the address is deliverable and sets its residential delivery indicator.

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

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

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->create([
    'street1' => '417 MONTGOMERY ST',
    'street2' => 'FLOOR 5',
    'city'    => 'San Francisco',
    'state'   => 'CA',
    'zip'     => '94104',
    'country' => 'US',
    'company' => 'EasyPost',
    'phone'   => '415-123-4567'
]);

echo $address;
{
  "id": "adr_3a2086e3bafa11eeb8d4ac1f6bc539ae",
  "object": "Address",
  "created_at": "2024-01-24T20:50:37+00:00",
  "updated_at": "2024-01-24T20:50:37+00:00",
  "name": null,
  "company": "EasyPost",
  "street1": "417 MONTGOMERY ST",
  "street2": "FLOOR 5",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {}
}
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->createAndVerify([
    'street1' => '000 unknown street',
    'city'    => 'Not a City',
    'state'   => 'ZZ',
    'zip'     => '00001',
    'country' => 'US',
    'email' => 'test@example.com',
    'phone'   => '5555555555',
]);

echo $address;
{
  "error": {
    "code": "ADDRESS.VERIFY.FAILURE",
    "message": "Unable to verify address.",
    "errors": [
      {
        "code": "E.ADDRESS.NOT_FOUND",
        "field": "address",
        "message": "Address not found",
        "suggestion": null
      }
    ]
  }
}
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->create([
    'verify'  => true,
    'street1' => '000 unknown street',
    'city'    => 'Not a City',
    'state'   => 'ZZ',
    'zip'     => '00001',
    'country' => 'US',
    'email' => 'test@example.com',
    'phone'   => '5555555555',
]);

echo $address;
{
  "id": "adr_3a98ffc7bafa11eeb8fcac1f6bc539ae",
  "object": "Address",
  "created_at": "2024-01-24T20:50:38+00:00",
  "updated_at": "2024-01-24T20:50:38+00:00",
  "name": null,
  "company": "EasyPost",
  "street1": "000 unknown street",
  "street2": null,
  "city": "Not A City",
  "state": "ZZ",
  "zip": "00001",
  "country": "US",
  "phone": "5555555555",
  "email": "test@example.com",
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "zip4": {
      "success": false,
      "errors": [
        {
          "code": "E.ADDRESS.NOT_FOUND",
          "field": "address",
          "message": "Address not found",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": false,
      "errors": [
        {
          "code": "E.ADDRESS.NOT_FOUND",
          "field": "address",
          "message": "Address not found",
          "suggestion": null
        }
      ],
      "details": {}
    }
  }
}
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->create([
    'street1' => '000 unknown street',
    'city'    => 'Not a City',
    'state'   => 'ZZ',
    'zip'     => '00001',
    'country' => 'US',
    'email' => 'test@example.com',
    'phone'   => '5555555555',
]);

echo $address;
{
  "error": {
    "code": "ADDRESS.VERIFY.FAILURE",
    "message": "Unable to verify address.",
    "errors": [
      {
        "code": "E.ADDRESS.NOT_FOUND",
        "field": "address",
        "message": "Address not found",
        "suggestion": null
      }
    ]
  }
}
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->create([
    'verify_strict'  => true,
    'street1' => '000 unknown street',
    'city'    => 'Not a City',
    'state'   => 'ZZ',
    'zip'     => '00001',
    'country' => 'US',
    'email' => 'test@example.com',
    'phone'   => '5555555555',
]);

echo $address;
{
  "error": {
    "code": "ADDRESS.VERIFY.FAILURE",
    "message": "Unable to verify address.",
    "errors": [
      {
        "code": "E.ADDRESS.NOT_FOUND",
        "field": "address",
        "message": "Address not found",
        "suggestion": null
      }
    ]
  }
}
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->create([
    'street1' => '417 montgomery streat',
    'street2' => 'FL 5',
    'city'    => 'San Francisco',
    'state'   => 'CA',
    'zip'     => '94104',
    'country' => 'US',
    'company' => 'EasyPost',
    'phone'   => '415-123-4567'
]);

$verifiedAddress = $client->address->verify($address->id);

echo $verifiedAddress;
{
  "address": {
    "id": "adr_3b15ed39bafa11ee83ed3cecef1b359e",
    "object": "Address",
    "created_at": "2024-01-24T20:50:39+00:00",
    "updated_at": "2024-01-24T20:50:39+00:00",
    "name": null,
    "company": "EASYPOST",
    "street1": "417 MONTGOMERY ST FL 5",
    "street2": "",
    "city": "SAN FRANCISCO",
    "state": "CA",
    "zip": "94104-1129",
    "country": "US",
    "phone": "4151234567",
    "email": null,
    "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": 37.79342,
          "longitude": -122.40288,
          "time_zone": "America/Los_Angeles"
        }
      }
    }
  }
}
GET/addresses

Retrieve a list of Addresses

The Address List is a paginated list of all Address objects associated with the given API Key. See the Pagination section of our docs for more details on retrieving all records when multiple pages are available.

Request Parameters
paramexampleinfo
before_idadr_...Optional pagination parameter. Only addresses created before the given ID will be included. May not be used with after_id
after_idadr_...Optional pagination parameter. Only addresses created after the given ID will be included. May not be used with before_id
page_size30The number of addresses to return on each page. The maximum value is 100, and default is 20.
Example
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$addresses = $client->address->all([
    'page_size' => 5
]);

echo $addresses;
{
  "addresses": [
    {
      "id": "adr_3b7de31bbafa11eeb947ac1f6bc539ae",
      "object": "Address",
      "created_at": "2024-01-24T20:50:39+00:00",
      "updated_at": "2024-01-24T20:50:39+00:00",
      "name": null,
      "company": "EasyPost",
      "street1": "417 MONTGOMERY ST",
      "street2": "FLOOR 5",
      "city": "SAN FRANCISCO",
      "state": "CA",
      "zip": "94104",
      "country": "US",
      "phone": "4151234567",
      "email": null,
      "mode": "test",
      "carrier_facility": null,
      "residential": null,
      "federal_tax_id": null,
      "state_tax_id": null,
      "verifications": {}
    }
  ],
  "has_more": true
}
GET/addresses/:id

Retrieve an Address

An Address can be retrieved by its id.

Example
<?php

$client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');

$address = $client->address->retrieve('adr_...');

echo $address;
{
  "id": "adr_3b7de31bbafa11eeb947ac1f6bc539ae",
  "object": "Address",
  "created_at": "2024-01-24T20:50:39+00:00",
  "updated_at": "2024-01-24T20:50:39+00:00",
  "name": null,
  "company": "EasyPost",
  "street1": "417 MONTGOMERY ST",
  "street2": "FLOOR 5",
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {}
}

Parcels

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

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

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

Parcel Object

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

Predefined Packages

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

For most predefined_packages it is not necessary to specify parcel dimensions, only weight.

Accurate

No predefined packages for Accurate.

    Amazon MWS

    No predefined packages for Amazon MWS.

      APC

      No predefined packages for APC.

        Asendia USA

        No predefined packages for Asendia USA.

          Australia Post
          • CARTON
          • PALLET
          • SATCHEL
          • BAG
          • ENVELOPE
          • ITEM
          • JIFFYBAG
          • SKID
          Better Trucks

          No predefined packages for Better Trucks.

            Canada Post

            No predefined packages for Canada Post.

              Canpar

              No predefined packages for Canpar.

                CDL Last Mile Solutions

                No predefined packages for CDL Last Mile Solutions.

                  Chronopost

                  No predefined packages for Chronopost.

                    Cirro E-Commerce

                    No predefined packages for Cirro E-Commerce.

                      CloudSort

                      No predefined packages for CloudSort.

                        Courier Express

                        No predefined packages for Courier Express.

                          Couriers Please

                          No predefined packages for Couriers Please.

                            CSLogistics

                            No predefined packages for CSLogistics.

                              DAI Post

                              No predefined packages for DAI Post.

                                Deliver-It

                                No predefined packages for Deliver-It.

                                  Deutsche Post

                                  No predefined packages for Deutsche Post.

                                    Deutsche Post UK

                                    No predefined packages for Deutsche Post UK.

                                      DHL eCommerce Solutions

                                      No predefined packages for DHL eCommerce Solutions.

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

                                        No predefined packages for DHL Paket.

                                          DoorDash

                                          No predefined packages for DoorDash.

                                            DPD

                                            No predefined packages for DPD.

                                              DPD NL

                                              No predefined packages for DPD NL.

                                                DPD UK
                                                • Parcel
                                                • Pallet
                                                • ExpressPak
                                                • FreightParcel
                                                • Freight
                                                ePostGlobal

                                                No predefined packages for ePostGlobal.

                                                  Estafeta
                                                  • ENVELOPE
                                                  • PARCEL
                                                  Evri

                                                  No predefined packages for Evri.

                                                    Fastway
                                                    • Parcel
                                                    • A2
                                                    • A3
                                                    • A4
                                                    • A5
                                                    • BOXSML
                                                    • BOXMED
                                                    • BOXLRG
                                                    FedEx
                                                    • FedExEnvelope
                                                    • FedExBox
                                                    • FedExPak
                                                    • FedExTube
                                                    • FedEx10kgBox
                                                    • FedEx25kgBox
                                                    • FedExSmallBox
                                                    • FedExMediumBox
                                                    • FedExLargeBox
                                                    • FedExExtraLargeBox
                                                    FedEx Ground Economy

                                                    No predefined packages for FedEx Ground Economy.

                                                      First Choice

                                                      No predefined packages for First Choice.

                                                        First Mile

                                                        No predefined packages for First Mile.

                                                          Flexport

                                                          No predefined packages for Flexport.

                                                            Gio

                                                            No predefined packages for Gio.

                                                              GSO

                                                              No predefined packages for GSO.

                                                                Hailify

                                                                No predefined packages for Hailify.

                                                                  Interlink Express
                                                                  • Parcel
                                                                  • Pallet
                                                                  • ExpressPak
                                                                  • FreightParcel
                                                                  • Freight
                                                                  Jet

                                                                  No predefined packages for Jet.

                                                                    Jitsu

                                                                    No predefined packages for Jitsu.

                                                                      JP Post

                                                                      No predefined packages for JP Post.

                                                                        Kuroneko Yamato

                                                                        No predefined packages for Kuroneko Yamato.

                                                                          La Poste

                                                                          No predefined packages for La Poste.

                                                                            LaserShip
                                                                            • Envelope
                                                                            • Custom
                                                                            Loomis Express

                                                                            No predefined packages for Loomis Express.

                                                                              LSO

                                                                              No predefined packages for LSO.

                                                                                Maergo

                                                                                No predefined packages for Maergo.

                                                                                  Newgistics

                                                                                  No predefined packages for Newgistics.

                                                                                    Ontrac
                                                                                    • Letter
                                                                                    Optima

                                                                                    No predefined packages for Optima.

                                                                                      OSM Worldwide
                                                                                      • parcel
                                                                                      • irregularparcel
                                                                                      • softpack
                                                                                      Pandion

                                                                                      No predefined packages for Pandion.

                                                                                        Parcelforce

                                                                                        No predefined packages for Parcelforce.

                                                                                          Passport

                                                                                          No predefined packages for Passport.

                                                                                            PostNL

                                                                                            No predefined packages for PostNL.

                                                                                              Purolator
                                                                                              • CUSTOMERPACKAGING
                                                                                              • EXPRESSPACK
                                                                                              • EXPRESSBOX
                                                                                              • EXPRESSENVELOPE
                                                                                              Quick

                                                                                              No predefined packages for Quick.

                                                                                                Royal Mail
                                                                                                • LARGELETTER
                                                                                                • SMALLPARCEL
                                                                                                • MEDIUMPARCEL
                                                                                                • LETTER
                                                                                                • PRINTEDPAPER
                                                                                                SEKO OmniParcel
                                                                                                • Bag
                                                                                                • Box
                                                                                                • Carton
                                                                                                • Container
                                                                                                • Crate
                                                                                                • Envelope
                                                                                                • Pail
                                                                                                • Pallet
                                                                                                • Satchel
                                                                                                • Tub
                                                                                                Sendle

                                                                                                No predefined packages for Sendle.

                                                                                                  SF Express

                                                                                                  No predefined packages for SF Express.

                                                                                                    SmartKargo

                                                                                                    No predefined packages for SmartKargo.

                                                                                                      Sonic

                                                                                                      No predefined packages for Sonic.

                                                                                                        Spee-Dee

                                                                                                        No predefined packages for Spee-Dee.

                                                                                                          Swyft

                                                                                                          No predefined packages for Swyft.

                                                                                                            TForce Logistics

                                                                                                            No predefined packages for TForce Logistics.

                                                                                                              Toll

                                                                                                              No predefined packages for Toll.

                                                                                                                UDS

                                                                                                                No predefined packages for UDS.

                                                                                                                  UPS
                                                                                                                  • UPSLetter
                                                                                                                  • UPSExpressBox
                                                                                                                  • UPS25kgBox
                                                                                                                  • UPS10kgBox
                                                                                                                  • Tube
                                                                                                                  • Pak
                                                                                                                  • SmallExpressBox
                                                                                                                  • MediumExpressBox
                                                                                                                  • LargeExpressBox
                                                                                                                  UPS iParcel

                                                                                                                  No predefined packages for UPS iParcel.

                                                                                                                    UPS Mail Innovations

                                                                                                                    No predefined packages for UPS Mail Innovations.

                                                                                                                      USPS

                                                                                                                      USPS Flat Rate MappingUSPS Package Restrictions

                                                                                                                      • Card
                                                                                                                      • Letter
                                                                                                                      • Flat
                                                                                                                      • FlatRateEnvelope
                                                                                                                      • FlatRateLegalEnvelope
                                                                                                                      • FlatRatePaddedEnvelope
                                                                                                                      • FlatRateWindowEnvelope
                                                                                                                      • FlatRateCardboardEnvelope
                                                                                                                      • SmallFlatRateEnvelope
                                                                                                                      • Parcel
                                                                                                                      • SoftPack
                                                                                                                      • SmallFlatRateBox
                                                                                                                      • MediumFlatRateBox
                                                                                                                      • LargeFlatRateBox
                                                                                                                      • LargeFlatRateBoxAPOFPO
                                                                                                                      • FlatTubTrayBox
                                                                                                                      • EMMTrayBox
                                                                                                                      • FullTrayBox
                                                                                                                      • HalfTrayBox
                                                                                                                      • PMODSack
                                                                                                                      Veho

                                                                                                                      No predefined packages for Veho.

                                                                                                                        Yanwen

                                                                                                                        No predefined packages for Yanwen.

                                                                                                                          POST/parcels

                                                                                                                          Create a Parcel

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

                                                                                                                          Request Parameters
                                                                                                                          paramexample
                                                                                                                          length20.2
                                                                                                                          width10.9
                                                                                                                          height5
                                                                                                                          weight65.9
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $parcel = $client->parcel->create([
                                                                                                                              'length' => 20.2,
                                                                                                                              'width' => 10.9,
                                                                                                                              'height' => 5,
                                                                                                                              'weight' => 65.9
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $parcel;
                                                                                                                          {
                                                                                                                            "id": "prcl_b35e1e715f30402b9eed234372505f7c",
                                                                                                                            "object": "Parcel",
                                                                                                                            "created_at": "2024-01-24T00:06:01Z",
                                                                                                                            "updated_at": "2024-01-24T00:06:01Z",
                                                                                                                            "length": 20.2,
                                                                                                                            "width": 10.9,
                                                                                                                            "height": 5.0,
                                                                                                                            "predefined_package": null,
                                                                                                                            "weight": 65.9,
                                                                                                                            "mode": "test"
                                                                                                                          }
                                                                                                                          GET/parcels/:id

                                                                                                                          Retrieve a Parcel

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

                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $parcel = $client->parcel->retrieve('prcl_...');
                                                                                                                          
                                                                                                                          echo $parcel;
                                                                                                                          {
                                                                                                                            "id": "prcl_85acf9cc4cb54eeabebda7e6f7a18e99",
                                                                                                                            "object": "Parcel",
                                                                                                                            "created_at": "2024-01-24T00:06:01Z",
                                                                                                                            "updated_at": "2024-01-24T00:06:01Z",
                                                                                                                            "length": 20.2,
                                                                                                                            "width": 10.9,
                                                                                                                            "height": 5.0,
                                                                                                                            "predefined_package": null,
                                                                                                                            "weight": 65.9,
                                                                                                                            "mode": "test"
                                                                                                                          }

                                                                                                                          Insurances

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

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

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

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

                                                                                                                          Insurance Object

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

                                                                                                                          Create an Insurance

                                                                                                                          An Insurance created via this endpoint must belong to a shipment purchased outside of EasyPost. Insurance for Shipments created within EasyPost must be created via the Shipment Buy or Insure endpoints. When creating Insurance for a non-EasyPost shipment, you must provide tracking_code, carrier, and amount information.

                                                                                                                          Customers must have their own FedEx account to insure FedEx packages.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          to_addressAddressThe destination of the package to be insured (optional).
                                                                                                                          from_addressAddressThe origin of the package to be insured (optional).
                                                                                                                          tracking_code9400110898825022579493The tracking code associated with the non-EasyPost-purchased package you'd like to insure.
                                                                                                                          referenceexternal-order-493An optional value that may be used in place of ID when doing Retrieve calls for this insurance.
                                                                                                                          amount"$100.00"The USD value of contents you would like to insure. Currently the maximum is $5000.
                                                                                                                          carrierUSPSThe carrier associated with the tracking_code you provided. The carrier will get auto-detected if none is provided.
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $insurance = $client->insurance->create([
                                                                                                                              'to_address' => ['id' => 'adr_...'],
                                                                                                                              'from_address' => ['id' => 'adr_...'],
                                                                                                                              'tracking_code' => '9400110898825022579493',
                                                                                                                              'carrier' => 'USPS',
                                                                                                                              'amount' => '100.00',
                                                                                                                              'reference' => 'insuranceRef1'
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $insurance;
                                                                                                                          {
                                                                                                                            "id": "ins_2500e29183a64136b84a1e44ff08905f",
                                                                                                                            "object": "Insurance",
                                                                                                                            "mode": "test",
                                                                                                                            "reference": null,
                                                                                                                            "status": "pending",
                                                                                                                            "amount": "100.00000",
                                                                                                                            "provider": "easypost",
                                                                                                                            "provider_id": null,
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_568c1ebcba4c11ee96cd3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:52+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"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_56912a8aba4c11ee96cf3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "name": "EASYPOST",
                                                                                                                              "company": null,
                                                                                                                              "street1": "417 MONTGOMERY ST # 5",
                                                                                                                              "street2": "",
                                                                                                                              "city": "SAN FRANCISCO",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "94104-1129",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "4153334445",
                                                                                                                              "email": "SUPPORT@EASYPOST.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": 37.79342,
                                                                                                                                    "longitude": -122.40288,
                                                                                                                                    "time_zone": "America/Los_Angeles"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            },
                                                                                                                            "shipment_id": null,
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_0ecad8116b424f00b9acdb15f66867bf",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9400110898825022579493",
                                                                                                                              "status": "error",
                                                                                                                              "status_detail": null,
                                                                                                                              "created_at": "2024-01-23T23:57:03Z",
                                                                                                                              "updated_at": "2024-01-23T23:57:03Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": null,
                                                                                                                              "shipment_id": null,
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "In test mode, only test tracking numbers are valid. Test tracking numbers are EZ1000000001, EZ2000000002, ... , EZ7000000007",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "error",
                                                                                                                                  "status_detail": null,
                                                                                                                                  "datetime": "2024-01-23T23:57:03Z",
                                                                                                                                  "source": "ProcessingError",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": null,
                                                                                                                                    "state": null,
                                                                                                                                    "country": null,
                                                                                                                                    "zip": null
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              ],
                                                                                                                              "carrier_detail": null,
                                                                                                                              "finalized": true,
                                                                                                                              "is_return": false,
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrXzBlY2FkODExNmI0MjRmMDBiOWFjZGIxNWY2Njg2N2Jm",
                                                                                                                              "fees": []
                                                                                                                            },
                                                                                                                            "tracking_code": "9400110898825022579493",
                                                                                                                            "fee": {
                                                                                                                              "object": "Fee",
                                                                                                                              "type": "InsuranceFee",
                                                                                                                              "amount": "0.50000",
                                                                                                                              "charged": true,
                                                                                                                              "refunded": false
                                                                                                                            },
                                                                                                                            "messages": [],
                                                                                                                            "created_at": "2024-01-24T00:05:52Z",
                                                                                                                            "updated_at": "2024-01-24T00:05:52Z"
                                                                                                                          }
                                                                                                                          GET/insurances

                                                                                                                          Retrieve a list of Insurances

                                                                                                                          The Insurance List is a paginated list of all Insurance objects associated with the given API Key. See the Pagination section of our docs for more details on retrieving all records when multiple pages are available.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          before_idins_...Optional pagination parameter. Only records created before the given ID will be included. May not be used with after_id
                                                                                                                          after_idins_...Optional pagination parameter. Only records created after the given ID will be included. May not be used with before_id
                                                                                                                          start_datetime2016-01-02T00:00:00ZOnly return records created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
                                                                                                                          end_datetime2016-01-02T00:00:00ZOnly return records created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
                                                                                                                          page_size30The number of records to return on each page. The maximum value is 100, and default is 20.
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $insurances = $client->insurance->all([
                                                                                                                              'page_size' => 5,
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $insurances;
                                                                                                                          {
                                                                                                                            "insurances": [
                                                                                                                              {
                                                                                                                                "id": "ins_2500e29183a64136b84a1e44ff08905f",
                                                                                                                                "object": "Insurance",
                                                                                                                                "mode": "test",
                                                                                                                                "reference": null,
                                                                                                                                "status": "pending",
                                                                                                                                "amount": "100.00000",
                                                                                                                                "provider": "easypost",
                                                                                                                                "provider_id": null,
                                                                                                                                "to_address": {
                                                                                                                                  "id": "adr_568c1ebcba4c11ee96cd3cecef1b359e",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                                  "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                                  "name": "DR. STEVE BRULE",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N HARBOR DR",
                                                                                                                                  "street2": null,
                                                                                                                                  "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"
                                                                                                                                      }
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "id": "adr_56912a8aba4c11ee96cf3cecef1b359e",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                                  "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                                  "name": "EASYPOST",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "417 MONTGOMERY ST # 5",
                                                                                                                                  "street2": null,
                                                                                                                                  "city": "SAN FRANCISCO",
                                                                                                                                  "state": "CA",
                                                                                                                                  "zip": "94104-1129",
                                                                                                                                  "country": "US",
                                                                                                                                  "phone": "4153334445",
                                                                                                                                  "email": "SUPPORT@EASYPOST.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": 37.79342,
                                                                                                                                        "longitude": -122.40288,
                                                                                                                                        "time_zone": "America/Los_Angeles"
                                                                                                                                      }
                                                                                                                                    }
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                "shipment_id": null,
                                                                                                                                "tracker": {
                                                                                                                                  "id": "trk_48fb9b6e8270488397cabd1ee6feccd6",
                                                                                                                                  "object": "Tracker",
                                                                                                                                  "mode": "test",
                                                                                                                                  "tracking_code": "9400110898825022579493",
                                                                                                                                  "status": "error",
                                                                                                                                  "status_detail": null,
                                                                                                                                  "created_at": "2024-01-24T00:05:52Z",
                                                                                                                                  "updated_at": "2024-01-24T00:05:52Z",
                                                                                                                                  "signed_by": null,
                                                                                                                                  "weight": null,
                                                                                                                                  "est_delivery_date": null,
                                                                                                                                  "shipment_id": null,
                                                                                                                                  "carrier": "USPS",
                                                                                                                                  "tracking_details": [
                                                                                                                                    {
                                                                                                                                      "object": "TrackingDetail",
                                                                                                                                      "message": "In test mode, only test tracking numbers are valid. Test tracking numbers are EZ1000000001, EZ2000000002, ... , EZ7000000007",
                                                                                                                                      "description": "",
                                                                                                                                      "status": "error",
                                                                                                                                      "status_detail": null,
                                                                                                                                      "datetime": "2024-01-24T00:05:52Z",
                                                                                                                                      "source": "ProcessingError",
                                                                                                                                      "carrier_code": "",
                                                                                                                                      "tracking_location": {
                                                                                                                                        "object": "TrackingLocation",
                                                                                                                                        "city": null,
                                                                                                                                        "state": null,
                                                                                                                                        "country": null,
                                                                                                                                        "zip": null
                                                                                                                                      }
                                                                                                                                    }
                                                                                                                                  ],
                                                                                                                                  "carrier_detail": null,
                                                                                                                                  "finalized": true,
                                                                                                                                  "is_return": false,
                                                                                                                                  "public_url": "https://track.easypost.com/djE6dHJrXzQ4ZmI5YjZlODI3MDQ4ODM5N2NhYmQxZWU2ZmVjY2Q2",
                                                                                                                                  "fees": []
                                                                                                                                },
                                                                                                                                "tracking_code": "9400110898825022579493",
                                                                                                                                "fee": {
                                                                                                                                  "object": "Fee",
                                                                                                                                  "type": "InsuranceFee",
                                                                                                                                  "amount": "0.50000",
                                                                                                                                  "charged": true,
                                                                                                                                  "refunded": false
                                                                                                                                },
                                                                                                                                "messages": [],
                                                                                                                                "created_at": "2024-01-24T00:05:52Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:52Z"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "has_more": true
                                                                                                                          }
                                                                                                                          GET/insurances/:id

                                                                                                                          Retrieve an Insurance

                                                                                                                          Retrieve an Insurance by id.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          idins_...Unique, starts with "ins_"
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $insurance = $client->insurance->retrieve('ins_...');
                                                                                                                          
                                                                                                                          echo $insurance;
                                                                                                                          {
                                                                                                                            "id": "ins_2500e29183a64136b84a1e44ff08905f",
                                                                                                                            "object": "Insurance",
                                                                                                                            "mode": "test",
                                                                                                                            "reference": null,
                                                                                                                            "status": "pending",
                                                                                                                            "amount": "100.00000",
                                                                                                                            "provider": "easypost",
                                                                                                                            "provider_id": null,
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_568c1ebcba4c11ee96cd3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "name": "DR. STEVE BRULE",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N HARBOR DR",
                                                                                                                              "street2": null,
                                                                                                                              "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"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_56912a8aba4c11ee96cf3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "name": "EASYPOST",
                                                                                                                              "company": null,
                                                                                                                              "street1": "417 MONTGOMERY ST # 5",
                                                                                                                              "street2": null,
                                                                                                                              "city": "SAN FRANCISCO",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "94104-1129",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "4153334445",
                                                                                                                              "email": "SUPPORT@EASYPOST.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": 37.79342,
                                                                                                                                    "longitude": -122.40288,
                                                                                                                                    "time_zone": "America/Los_Angeles"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            },
                                                                                                                            "shipment_id": null,
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_48fb9b6e8270488397cabd1ee6feccd6",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9400110898825022579493",
                                                                                                                              "status": "error",
                                                                                                                              "status_detail": null,
                                                                                                                              "created_at": "2024-01-24T00:05:52Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:52Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": null,
                                                                                                                              "shipment_id": null,
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "In test mode, only test tracking numbers are valid. Test tracking numbers are EZ1000000001, EZ2000000002, ... , EZ7000000007",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "error",
                                                                                                                                  "status_detail": null,
                                                                                                                                  "datetime": "2024-01-24T00:05:52Z",
                                                                                                                                  "source": "ProcessingError",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": null,
                                                                                                                                    "state": null,
                                                                                                                                    "country": null,
                                                                                                                                    "zip": null
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              ],
                                                                                                                              "carrier_detail": null,
                                                                                                                              "finalized": true,
                                                                                                                              "is_return": false,
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrXzQ4ZmI5YjZlODI3MDQ4ODM5N2NhYmQxZWU2ZmVjY2Q2",
                                                                                                                              "fees": []
                                                                                                                            },
                                                                                                                            "tracking_code": "9400110898825022579493",
                                                                                                                            "fee": {
                                                                                                                              "object": "Fee",
                                                                                                                              "type": "InsuranceFee",
                                                                                                                              "amount": "0.50000",
                                                                                                                              "charged": true,
                                                                                                                              "refunded": false
                                                                                                                            },
                                                                                                                            "messages": [],
                                                                                                                            "created_at": "2024-01-24T00:05:52Z",
                                                                                                                            "updated_at": "2024-01-24T00:05:52Z"
                                                                                                                          }
                                                                                                                          POST/insurances/:id/refund

                                                                                                                          Refund an Insurance

                                                                                                                          Refunding Insurance is only available for standalone insurance purchased through EasyPost. The tracking status for the insurance must be either pre_transit, cancelled, or unknown in order to be eligible.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          idins_...Unique, starts with "ins_"
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $insurance = $client->insurance->refund('ins_...');
                                                                                                                          
                                                                                                                          echo $insurance;
                                                                                                                          {
                                                                                                                            "id": "ins_2500e29183a64136b84a1e44ff08905f",
                                                                                                                            "object": "Insurance",
                                                                                                                            "mode": "test",
                                                                                                                            "reference": null,
                                                                                                                            "status": "cancelled",
                                                                                                                            "amount": "100.00000",
                                                                                                                            "provider": "easypost",
                                                                                                                            "provider_id": null,
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_568c1ebcba4c11ee96cd3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "name": "DR. STEVE BRULE",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N HARBOR DR",
                                                                                                                              "street2": null,
                                                                                                                              "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"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_56912a8aba4c11ee96cf3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:52+00:00",
                                                                                                                              "name": "EASYPOST",
                                                                                                                              "company": null,
                                                                                                                              "street1": "417 MONTGOMERY ST # 5",
                                                                                                                              "street2": null,
                                                                                                                              "city": "SAN FRANCISCO",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "94104-1129",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "4153334445",
                                                                                                                              "email": "SUPPORT@EASYPOST.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": 37.79342,
                                                                                                                                    "longitude": -122.40288,
                                                                                                                                    "time_zone": "America/Los_Angeles"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              }
                                                                                                                            },
                                                                                                                            "shipment_id": null,
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_48fb9b6e8270488397cabd1ee6feccd6",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9400110898825022579493",
                                                                                                                              "status": "error",
                                                                                                                              "status_detail": null,
                                                                                                                              "created_at": "2024-01-24T00:05:52Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:52Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": null,
                                                                                                                              "shipment_id": null,
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "In test mode, only test tracking numbers are valid. Test tracking numbers are EZ1000000001, EZ2000000002, ... , EZ7000000007",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "error",
                                                                                                                                  "status_detail": null,
                                                                                                                                  "datetime": "2024-01-24T00:05:52Z",
                                                                                                                                  "source": "ProcessingError",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": null,
                                                                                                                                    "state": null,
                                                                                                                                    "country": null,
                                                                                                                                    "zip": null
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              ],
                                                                                                                              "carrier_detail": null,
                                                                                                                              "finalized": true,
                                                                                                                              "is_return": false,
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrXzQ4ZmI5YjZlODI3MDQ4ODM5N2NhYmQxZWU2ZmVjY2Q2",
                                                                                                                              "fees": []
                                                                                                                            },
                                                                                                                            "tracking_code": "9400110898825022579493",
                                                                                                                            "fee": {
                                                                                                                              "object": "Fee",
                                                                                                                              "type": "InsuranceFee",
                                                                                                                              "amount": "0.50000",
                                                                                                                              "charged": true,
                                                                                                                              "refunded": false
                                                                                                                            },
                                                                                                                            "messages": ["Insurance was cancelled by the user."],
                                                                                                                            "created_at": "2024-01-24T00:05:52Z",
                                                                                                                            "updated_at": "2024-01-24T00:05:52Z"
                                                                                                                          }

                                                                                                                          Shipments

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

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

                                                                                                                          Shipment Object

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

                                                                                                                          Form Object

                                                                                                                          attributetypespecification
                                                                                                                          idstringUnique, begins with "form_"
                                                                                                                          objectstring"Form"
                                                                                                                          modestring"test" or "production"
                                                                                                                          form_typestringThe type of form that we returned, can be one of "high_value_report", "commercial_invoice", "cod_return_label", "order_summary", "cn22"
                                                                                                                          form_urlstringThe address we return the form back at
                                                                                                                          submitted_electronicallybooleanIf we have submitted the form to the carrier on behalf of the customer
                                                                                                                          created_atdatetime
                                                                                                                          updated_atdatetime

                                                                                                                          PostageLabel Object

                                                                                                                          attributetypespecification
                                                                                                                          idstringUnique, begins with "pl_"
                                                                                                                          objectstring"PostageLabel"
                                                                                                                          label_datedatetimeThe date that appears on the postage label
                                                                                                                          label_epl2_urlstringThe URL of the EPL2 label file
                                                                                                                          label_file_typestringFile type of the label
                                                                                                                          label_pdf_urlstringThe URL of the PDF label file
                                                                                                                          label_resolutionintegerThe resolution of the label
                                                                                                                          label_sizestringThe size of the label
                                                                                                                          label_typestringThe type of the label
                                                                                                                          label_urlstringThe URL of the label file
                                                                                                                          label_zpl_urlstringThe URL of the ZPL label file
                                                                                                                          created_atdatetime
                                                                                                                          updated_atdatetime
                                                                                                                          POST/shipments

                                                                                                                          Create a Shipment

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

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

                                                                                                                          You can limit the CarrierAccounts to use for rating by passing the carrier_accounts parameter. If the CarrierAccount IDs provided are invalid or disabled, the shipment creation call will result in an error.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          reference"my-reference"An optional field that may be used in place of id in other API endpoints
                                                                                                                          to_address<Address>Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
                                                                                                                          from_address<Address>Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
                                                                                                                          parcel<Parcel>The dimensions and weight of the package
                                                                                                                          carrier_accounts["ca_...", ...]List of carrier accounts
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->create([
                                                                                                                              'to_address' => [
                                                                                                                                  'name' => 'Dr. Steve Brule',
                                                                                                                                  'street1' => '179 N Harbor Dr',
                                                                                                                                  'city' => 'Redondo Beach',
                                                                                                                                  'state' => 'CA',
                                                                                                                                  'zip' => '90277',
                                                                                                                                  'country' => 'US',
                                                                                                                                  'phone' => '3331114444',
                                                                                                                                  'email' => 'dr_steve_brule@gmail.com'
                                                                                                                              ],
                                                                                                                              'from_address' => [
                                                                                                                                  'name' => 'EasyPost',
                                                                                                                                  'street1' => '417 Montgomery Street',
                                                                                                                                  'street2' => '5th Floor',
                                                                                                                                  'city' => 'San Francisco',
                                                                                                                                  'state' => 'CA',
                                                                                                                                  'zip' => '94104',
                                                                                                                                  'country' => 'US',
                                                                                                                                  'phone' => '3331114444',
                                                                                                                                  'email' => 'support@easypost.com'
                                                                                                                              ],
                                                                                                                              'parcel' => [
                                                                                                                                  'length' => 20.2,
                                                                                                                                  'width' => 10.9,
                                                                                                                                  'height' => 5,
                                                                                                                                  'weight' => 65.9
                                                                                                                              ]
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $shipment;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:07:30Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "currency": "USD",
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": null,
                                                                                                                            "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_657b430669ef456584bc4b82b3271084",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:07:30Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_046758e6b61847f99623c4d2290a26bd",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:07:30Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_90e0406bba4c11eea7d53cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:30+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:30+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": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_4dde100b45af43acbe9c68244fa51851",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:07:30Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": null,
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_3cbb8d9c4ea1477588a17b0ee3e0c5b4",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:30Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_93170d48eb1a413aa5c0d8bf4384a350",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_c9e1a6c4be1e40a7af83b42d1115c550",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:30Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_93170d48eb1a413aa5c0d8bf4384a350",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_a39910cfd937402fb77a9eaed223dcfe",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:30Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_93170d48eb1a413aa5c0d8bf4384a350",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_d0b494c33c3e42f893b619d730f24058",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:30Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_93170d48eb1a413aa5c0d8bf4384a350",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_dad1a54ef6f64dfc9def001cbbb2b142",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:30Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:30Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_93170d48eb1a413aa5c0d8bf4384a350",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": null,
                                                                                                                            "tracker": null,
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_90dd5fb4ba4c11ee9e88ac1f6bc539ae",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:30+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:30+00:00",
                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                              "street2": null,
                                                                                                                              "city": "Redondo Beach",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "90277",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "8573875756",
                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                              "mode": "test",
                                                                                                                              "carrier_facility": null,
                                                                                                                              "residential": null,
                                                                                                                              "federal_tax_id": null,
                                                                                                                              "state_tax_id": null,
                                                                                                                              "verifications": {}
                                                                                                                            },
                                                                                                                            "usps_zone": 4,
                                                                                                                            "return_address": {
                                                                                                                              "id": "adr_90e0406bba4c11eea7d53cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:30+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:30+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_90dd5fb4ba4c11ee9e88ac1f6bc539ae",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:30+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:30+00:00",
                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                              "street2": null,
                                                                                                                              "city": "Redondo Beach",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "90277",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "8573875756",
                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                              "mode": "test",
                                                                                                                              "carrier_facility": null,
                                                                                                                              "residential": null,
                                                                                                                              "federal_tax_id": null,
                                                                                                                              "state_tax_id": null,
                                                                                                                              "verifications": {}
                                                                                                                            },
                                                                                                                            "forms": [],
                                                                                                                            "fees": [],
                                                                                                                            "id": "shp_93170d48eb1a413aa5c0d8bf4384a350",
                                                                                                                            "object": "Shipment"
                                                                                                                          }
                                                                                                                          GET/shipments

                                                                                                                          Retrieve a list of Shipments

                                                                                                                          The Shipment List is a paginated list of all Shipment objects associated with the given API Key. See the Pagination section of our docs for more details on retrieving all records when multiple pages are available.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          before_idshp_...Optional pagination parameter. Only shipments created before the given ID will be included. May not be used with after_id
                                                                                                                          after_idshp_...Optional pagination parameter. Only shipments created after the given ID will be included. May not be used with before_id
                                                                                                                          start_datetime2016-01-02T00:00:00ZOnly return Shipments created after this timestamp. Defaults to 1 month ago, or 1 month before a passed end_datetime
                                                                                                                          end_datetime2016-01-02T00:00:00ZOnly return Shipments created before this timestamp. Defaults to end of the current day, or 1 month after a passed start_datetime
                                                                                                                          page_size20The number of shipments to return on each page. The maximum value is 100
                                                                                                                          purchasedtrueOnly include Shipments that have been purchased. Default is true
                                                                                                                          include_childrenfalseAlso include Shipments created by Child Users. Defaults to false
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipments = $client->shipment->all([
                                                                                                                              'page_size' => 5,
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $shipments;
                                                                                                                          {
                                                                                                                            "shipments": [
                                                                                                                              {
                                                                                                                                "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                "is_return": false,
                                                                                                                                "messages": [],
                                                                                                                                "mode": "test",
                                                                                                                                "options": {
                                                                                                                                  "currency": "USD",
                                                                                                                                  "payment": {
                                                                                                                                    "type": "SENDER"
                                                                                                                                  },
                                                                                                                                  "date_advance": 0
                                                                                                                                },
                                                                                                                                "reference": null,
                                                                                                                                "status": "unknown",
                                                                                                                                "tracking_code": "9405500207552011812825",
                                                                                                                                "updated_at": "2024-01-24T00:07:29Z",
                                                                                                                                "batch_id": "batch_83009a1272fa48ffb1a3d29074a16960",
                                                                                                                                "batch_status": "postage_purchased",
                                                                                                                                "batch_message": null,
                                                                                                                                "customs_info": {
                                                                                                                                  "id": "cstinfo_916710a3039140c5a6e7f2f812ef83d7",
                                                                                                                                  "object": "CustomsInfo",
                                                                                                                                  "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "contents_explanation": "",
                                                                                                                                  "contents_type": "merchandise",
                                                                                                                                  "customs_certify": true,
                                                                                                                                  "customs_signer": "Steve Brule",
                                                                                                                                  "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                                  "non_delivery_option": "return",
                                                                                                                                  "restriction_comments": null,
                                                                                                                                  "restriction_type": "none",
                                                                                                                                  "mode": "test",
                                                                                                                                  "declaration": null,
                                                                                                                                  "customs_items": [
                                                                                                                                    {
                                                                                                                                      "id": "cstitem_eead7973a2d644189ebd7c8f11f9647a",
                                                                                                                                      "object": "CustomsItem",
                                                                                                                                      "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                      "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                      "description": "T-shirt",
                                                                                                                                      "hs_tariff_number": "123456",
                                                                                                                                      "origin_country": "US",
                                                                                                                                      "quantity": 1,
                                                                                                                                      "value": "10.0",
                                                                                                                                      "weight": 5.0,
                                                                                                                                      "code": "123",
                                                                                                                                      "mode": "test",
                                                                                                                                      "manufacturer": null,
                                                                                                                                      "currency": null,
                                                                                                                                      "eccn": null,
                                                                                                                                      "printed_commodity_identifier": null
                                                                                                                                    }
                                                                                                                                  ]
                                                                                                                                },
                                                                                                                                "from_address": {
                                                                                                                                  "id": "adr_8f5e7e74ba4c11ee8bd0ac1f6bc53342",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28+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": null,
                                                                                                                                "parcel": {
                                                                                                                                  "id": "prcl_bba0f7cc48d64a299938fef3a3e0b9a0",
                                                                                                                                  "object": "Parcel",
                                                                                                                                  "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "length": 20.2,
                                                                                                                                  "width": 10.9,
                                                                                                                                  "height": 5.0,
                                                                                                                                  "predefined_package": null,
                                                                                                                                  "weight": 65.9,
                                                                                                                                  "mode": "test"
                                                                                                                                },
                                                                                                                                "postage_label": {
                                                                                                                                  "object": "PostageLabel",
                                                                                                                                  "id": "pl_9562571fa39b4e49892a8c60f12be255",
                                                                                                                                  "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "date_advance": 0,
                                                                                                                                  "integrated_form": "none",
                                                                                                                                  "label_date": "2024-01-24T00:07:28Z",
                                                                                                                                  "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/e8a95864fe9ec34eeabf5fc2ad415fda5d.png",
                                                                                                                                  "label_pdf_url": null,
                                                                                                                                  "label_zpl_url": null,
                                                                                                                                  "label_epl2_url": null,
                                                                                                                                  "label_file": null
                                                                                                                                },
                                                                                                                                "rates": [
                                                                                                                                  {
                                                                                                                                    "id": "rate_15a03f25e00d49a098da8d40c8e1719e",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "mode": "test",
                                                                                                                                    "service": "Express",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "rate": "49.60",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "retail_rate": "57.40",
                                                                                                                                    "retail_currency": "USD",
                                                                                                                                    "list_rate": "49.60",
                                                                                                                                    "list_currency": "USD",
                                                                                                                                    "billing_type": "easypost",
                                                                                                                                    "delivery_days": null,
                                                                                                                                    "delivery_date": null,
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "est_delivery_days": null,
                                                                                                                                    "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "rate_edd7e3cedd9d4aa9bd21eb23a740af7d",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "mode": "test",
                                                                                                                                    "service": "Priority",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "rate": "7.33",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "retail_rate": "15.20",
                                                                                                                                    "retail_currency": "USD",
                                                                                                                                    "list_rate": "10.89",
                                                                                                                                    "list_currency": "USD",
                                                                                                                                    "billing_type": "easypost",
                                                                                                                                    "delivery_days": 2,
                                                                                                                                    "delivery_date": null,
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "est_delivery_days": 2,
                                                                                                                                    "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "rate_bc0979e7fa314d2b935d8fee9312c766",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "mode": "test",
                                                                                                                                    "service": "GroundAdvantage",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "rate": "6.79",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "retail_rate": "13.15",
                                                                                                                                    "retail_currency": "USD",
                                                                                                                                    "list_rate": "9.41",
                                                                                                                                    "list_currency": "USD",
                                                                                                                                    "billing_type": "easypost",
                                                                                                                                    "delivery_days": 3,
                                                                                                                                    "delivery_date": null,
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "est_delivery_days": 3,
                                                                                                                                    "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "rate_418622e2edeb4015b8bbd72fbe2d3ff6",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "mode": "test",
                                                                                                                                    "service": "First",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "rate": "6.79",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "retail_rate": "13.15",
                                                                                                                                    "retail_currency": "USD",
                                                                                                                                    "list_rate": "9.41",
                                                                                                                                    "list_currency": "USD",
                                                                                                                                    "billing_type": "easypost",
                                                                                                                                    "delivery_days": 3,
                                                                                                                                    "delivery_date": null,
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "est_delivery_days": 3,
                                                                                                                                    "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                  },
                                                                                                                                  {
                                                                                                                                    "id": "rate_699f9b847989489891a0db1489c6c0f2",
                                                                                                                                    "object": "Rate",
                                                                                                                                    "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                    "mode": "test",
                                                                                                                                    "service": "ParcelSelect",
                                                                                                                                    "carrier": "USPS",
                                                                                                                                    "rate": "6.79",
                                                                                                                                    "currency": "USD",
                                                                                                                                    "retail_rate": "13.15",
                                                                                                                                    "retail_currency": "USD",
                                                                                                                                    "list_rate": "9.41",
                                                                                                                                    "list_currency": "USD",
                                                                                                                                    "billing_type": "easypost",
                                                                                                                                    "delivery_days": 3,
                                                                                                                                    "delivery_date": null,
                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                    "est_delivery_days": 3,
                                                                                                                                    "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "refund_status": null,
                                                                                                                                "scan_form": {
                                                                                                                                  "id": "sf_589e52186e9249669c7806912a6ab766",
                                                                                                                                  "object": "ScanForm",
                                                                                                                                  "created_at": "2024-01-24T00:07:29Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:29Z",
                                                                                                                                  "tracking_codes": ["9405500207552011812825"],
                                                                                                                                  "address": {
                                                                                                                                    "id": "adr_8f5e7e74ba4c11ee8bd0ac1f6bc53342",
                                                                                                                                    "object": "Address",
                                                                                                                                    "created_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                    "updated_at": "2024-01-24T00:07:28+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": {}
                                                                                                                                  },
                                                                                                                                  "status": "created",
                                                                                                                                  "message": null,
                                                                                                                                  "form_url": "https://easypost-files.s3.us-west-2.amazonaws.com/files/scan_form/20240124/e82a4cb71096604dc7bd773b1285d7e9db.pdf",
                                                                                                                                  "form_file_type": null,
                                                                                                                                  "batch_id": "batch_83009a1272fa48ffb1a3d29074a16960",
                                                                                                                                  "confirmation": null
                                                                                                                                },
                                                                                                                                "selected_rate": {
                                                                                                                                  "id": "rate_edd7e3cedd9d4aa9bd21eb23a740af7d",
                                                                                                                                  "object": "Rate",
                                                                                                                                  "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "mode": "test",
                                                                                                                                  "service": "Priority",
                                                                                                                                  "carrier": "USPS",
                                                                                                                                  "rate": "7.33",
                                                                                                                                  "currency": "USD",
                                                                                                                                  "retail_rate": "15.20",
                                                                                                                                  "retail_currency": "USD",
                                                                                                                                  "list_rate": "10.89",
                                                                                                                                  "list_currency": "USD",
                                                                                                                                  "billing_type": "easypost",
                                                                                                                                  "delivery_days": 2,
                                                                                                                                  "delivery_date": null,
                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                  "est_delivery_days": 2,
                                                                                                                                  "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                },
                                                                                                                                "tracker": {
                                                                                                                                  "id": "trk_c64aa4ee22804cceab41586397c4b833",
                                                                                                                                  "object": "Tracker",
                                                                                                                                  "mode": "test",
                                                                                                                                  "tracking_code": "9405500207552011812825",
                                                                                                                                  "status": "pre_transit",
                                                                                                                                  "status_detail": "status_update",
                                                                                                                                  "created_at": "2024-01-24T00:07:28Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:29Z",
                                                                                                                                  "signed_by": null,
                                                                                                                                  "weight": null,
                                                                                                                                  "est_delivery_date": "2024-01-24T00:07:29Z",
                                                                                                                                  "shipment_id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                  "carrier": "USPS",
                                                                                                                                  "tracking_details": [
                                                                                                                                    {
                                                                                                                                      "object": "TrackingDetail",
                                                                                                                                      "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                                      "description": "",
                                                                                                                                      "status": "pre_transit",
                                                                                                                                      "status_detail": "status_update",
                                                                                                                                      "datetime": "2023-12-24T00:07:29Z",
                                                                                                                                      "source": "USPS",
                                                                                                                                      "carrier_code": "",
                                                                                                                                      "tracking_location": {
                                                                                                                                        "object": "TrackingLocation",
                                                                                                                                        "city": null,
                                                                                                                                        "state": null,
                                                                                                                                        "country": null,
                                                                                                                                        "zip": null
                                                                                                                                      }
                                                                                                                                    },
                                                                                                                                    {
                                                                                                                                      "object": "TrackingDetail",
                                                                                                                                      "message": "Shipping Label Created",
                                                                                                                                      "description": "",
                                                                                                                                      "status": "pre_transit",
                                                                                                                                      "status_detail": "status_update",
                                                                                                                                      "datetime": "2023-12-24T12:44:29Z",
                                                                                                                                      "source": "USPS",
                                                                                                                                      "carrier_code": "",
                                                                                                                                      "tracking_location": {
                                                                                                                                        "object": "TrackingLocation",
                                                                                                                                        "city": "HOUSTON",
                                                                                                                                        "state": "TX",
                                                                                                                                        "country": null,
                                                                                                                                        "zip": "77063"
                                                                                                                                      }
                                                                                                                                    }
                                                                                                                                  ],
                                                                                                                                  "fees": [],
                                                                                                                                  "carrier_detail": {
                                                                                                                                    "object": "CarrierDetail",
                                                                                                                                    "service": "First-Class Package Service",
                                                                                                                                    "container_type": null,
                                                                                                                                    "est_delivery_date_local": null,
                                                                                                                                    "est_delivery_time_local": null,
                                                                                                                                    "origin_location": "HOUSTON TX, 77001",
                                                                                                                                    "origin_tracking_location": {
                                                                                                                                      "object": "TrackingLocation",
                                                                                                                                      "city": "HOUSTON",
                                                                                                                                      "state": "TX",
                                                                                                                                      "country": null,
                                                                                                                                      "zip": "77063"
                                                                                                                                    },
                                                                                                                                    "destination_location": "CHARLESTON SC, 29401",
                                                                                                                                    "destination_tracking_location": null,
                                                                                                                                    "guaranteed_delivery_date": null,
                                                                                                                                    "alternate_identifier": null,
                                                                                                                                    "initial_delivery_attempt": null
                                                                                                                                  },
                                                                                                                                  "public_url": "https://track.easypost.com/djE6dHJrX2M2NGFhNGVlMjI4MDRjY2VhYjQxNTg2Mzk3YzRiODMz"
                                                                                                                                },
                                                                                                                                "to_address": {
                                                                                                                                  "id": "adr_8f5bb1f5ba4c11eeb6a1ac1f6bc539aa",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                  "name": "DR. STEVE BRULE",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N HARBOR DR",
                                                                                                                                  "street2": null,
                                                                                                                                  "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_8f5e7e74ba4c11ee8bd0ac1f6bc53342",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28+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_8f5bb1f5ba4c11eeb6a1ac1f6bc539aa",
                                                                                                                                  "object": "Address",
                                                                                                                                  "created_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                  "updated_at": "2024-01-24T00:07:28+00:00",
                                                                                                                                  "name": "DR. STEVE BRULE",
                                                                                                                                  "company": null,
                                                                                                                                  "street1": "179 N HARBOR DR",
                                                                                                                                  "street2": null,
                                                                                                                                  "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": "7.33000",
                                                                                                                                    "charged": true,
                                                                                                                                    "refunded": false
                                                                                                                                  }
                                                                                                                                ],
                                                                                                                                "id": "shp_8631f00640ba4d62b9131da3852a26e4",
                                                                                                                                "object": "Shipment"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "has_more": true
                                                                                                                          }
                                                                                                                          GET/shipments/:id

                                                                                                                          Retrieve a Shipment

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

                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                          
                                                                                                                          echo $shipment;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:07:31Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "currency": "USD",
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": null,
                                                                                                                            "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_0096afa682bf443d91d2290bc95bb431",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:07:31Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_4cd92d282b9044e0a5fe4d430e221b04",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:07:31Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_913347feba4c11eeb701ac1f6bc539aa",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:31+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:31+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": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_400658d40a1f40aa9871d002dfdfb68d",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:07:31Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": null,
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_3a88998080864f5dafd05f0e39655253",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:31Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_594234d296794803bfd0a6814a29d976",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_54f2ef16614541fda0eb4cac44155954",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:31Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_594234d296794803bfd0a6814a29d976",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_591fb9d8f10d456ea105ea2e700c00ad",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:31Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_594234d296794803bfd0a6814a29d976",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_3bf9ed1c9fef437e957faeb8eb77d7f7",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:31Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_594234d296794803bfd0a6814a29d976",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_bf060d1d9e4a41c6bdbef4bee91643dd",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:31Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:31Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_594234d296794803bfd0a6814a29d976",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": null,
                                                                                                                            "tracker": null,
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_91305d88ba4c11eea7e63cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:31+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:31+00:00",
                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                              "street2": null,
                                                                                                                              "city": "Redondo Beach",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "90277",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "8573875756",
                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                              "mode": "test",
                                                                                                                              "carrier_facility": null,
                                                                                                                              "residential": null,
                                                                                                                              "federal_tax_id": null,
                                                                                                                              "state_tax_id": null,
                                                                                                                              "verifications": {}
                                                                                                                            },
                                                                                                                            "usps_zone": 4,
                                                                                                                            "return_address": {
                                                                                                                              "id": "adr_913347feba4c11eeb701ac1f6bc539aa",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:31+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:31+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_91305d88ba4c11eea7e63cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:31+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:31+00:00",
                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                              "street2": null,
                                                                                                                              "city": "Redondo Beach",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "90277",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "8573875756",
                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                              "mode": "test",
                                                                                                                              "carrier_facility": null,
                                                                                                                              "residential": null,
                                                                                                                              "federal_tax_id": null,
                                                                                                                              "state_tax_id": null,
                                                                                                                              "verifications": {}
                                                                                                                            },
                                                                                                                            "forms": [],
                                                                                                                            "fees": [],
                                                                                                                            "id": "shp_594234d296794803bfd0a6814a29d976",
                                                                                                                            "object": "Shipment"
                                                                                                                          }
                                                                                                                          POST/shipments/:id/buy

                                                                                                                          Buy a Shipment

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

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

                                                                                                                          Request Parameters
                                                                                                                          paramexample
                                                                                                                          rate<Rate>
                                                                                                                          insurance"100.00"
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                          
                                                                                                                          $boughtShipment = $client->shipment->buy(
                                                                                                                              $shipment->id,
                                                                                                                              [
                                                                                                                                  'rate'      => $shipment->lowestRate(),
                                                                                                                                  'insurance' => 249.99
                                                                                                                              ]
                                                                                                                          );
                                                                                                                          
                                                                                                                          echo $boughtShipment;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:07:32Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "currency": "USD",
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": "9434600207552011812848",
                                                                                                                            "updated_at": "2024-01-24T00:07:33Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_fd42061296ef450285b451ef66f9b9d5",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:07:32Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_f7de527850e34f018ef41e9f69be6758",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:07:32Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_91fa95f1ba4c11ee8c59ac1f6bc53342",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:32+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:32+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": "249.99",
                                                                                                                            "order_id": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_a5e317e47ac9442988d338cb2a0fde17",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:07:32Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": {
                                                                                                                              "object": "PostageLabel",
                                                                                                                              "id": "pl_51b80cc8523d4fc28c4ab710594e0913",
                                                                                                                              "created_at": "2024-01-24T00:07:33Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:33Z",
                                                                                                                              "date_advance": 0,
                                                                                                                              "integrated_form": "none",
                                                                                                                              "label_date": "2024-01-24T00:07:33Z",
                                                                                                                              "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/e81cecd85b82d749a19cf38dae0e30fc53.png",
                                                                                                                              "label_pdf_url": null,
                                                                                                                              "label_zpl_url": null,
                                                                                                                              "label_epl2_url": null,
                                                                                                                              "label_file": null
                                                                                                                            },
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_6366c70cbea94c60b8d282ccf0f60ce0",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:32Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_7dd1fb53702d473bbb9eeaf53d7a72d7",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:32Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_263930dcc1ef4331b9a16313f55c47d6",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:32Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_bd7a2aa312224b43b15d56b2e818e946",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:32Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_6ec39e90cf6b4f2d97aab43d7c946559",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:32Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:32Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": {
                                                                                                                              "id": "rate_6366c70cbea94c60b8d282ccf0f60ce0",
                                                                                                                              "object": "Rate",
                                                                                                                              "created_at": "2024-01-24T00:07:33Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:33Z",
                                                                                                                              "mode": "test",
                                                                                                                              "service": "GroundAdvantage",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "rate": "6.79",
                                                                                                                              "currency": "USD",
                                                                                                                              "retail_rate": "13.15",
                                                                                                                              "retail_currency": "USD",
                                                                                                                              "list_rate": "9.41",
                                                                                                                              "list_currency": "USD",
                                                                                                                              "billing_type": "easypost",
                                                                                                                              "delivery_days": 3,
                                                                                                                              "delivery_date": null,
                                                                                                                              "delivery_date_guaranteed": false,
                                                                                                                              "est_delivery_days": 3,
                                                                                                                              "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                              "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                            },
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_814a807c3fae4203a4d61293b2b0b3dc",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9434600207552011812848",
                                                                                                                              "status": "unknown",
                                                                                                                              "status_detail": "unknown",
                                                                                                                              "created_at": "2024-01-24T00:07:34Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": null,
                                                                                                                              "shipment_id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [],
                                                                                                                              "fees": [],
                                                                                                                              "carrier_detail": null,
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrXzgxNGE4MDdjM2ZhZTQyMDNhNGQ2MTI5M2IyYjBiM2Rj"
                                                                                                                            },
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_91f7ca0fba4c11eeb731ac1f6bc539aa",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:32+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:33+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_91fa95f1ba4c11ee8c59ac1f6bc53342",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:32+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:32+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_91f7ca0fba4c11eeb731ac1f6bc539aa",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:32+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:33+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": "6.79000",
                                                                                                                                "charged": true,
                                                                                                                                "refunded": false
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "object": "Fee",
                                                                                                                                "type": "InsuranceFee",
                                                                                                                                "amount": "1.24995",
                                                                                                                                "charged": true,
                                                                                                                                "refunded": false
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "id": "shp_56b10c708daa4c25b5895c5354758aaf",
                                                                                                                            "object": "Shipment"
                                                                                                                          }
                                                                                                                          POST/shipments

                                                                                                                          Buy a Shipment without rating (One-Call Buy)

                                                                                                                          There is an alternative way to purchase shipments 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 shipment" then "buy shipment" workflow. In order to achieve this behavior all you have to do is add a single carrier account and service level name to your "Create Shipment" call.

                                                                                                                          Request Parameters
                                                                                                                          paramexampleinfo
                                                                                                                          reference"my-reference"An optional field that may be used in place of id in other API endpoints
                                                                                                                          to_address<Address>Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
                                                                                                                          from_address<Address>Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
                                                                                                                          parcel<Parcel>
                                                                                                                          carrier_accounts["ca_..."]List of carrier accounts
                                                                                                                          service"Priority"The service of carrier
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->create([
                                                                                                                              'carrier_accounts' => ['ca_...'],
                                                                                                                              'service' => 'NextDayAir',
                                                                                                                              'to_address' => [
                                                                                                                                  'name' => 'Dr. Steve Brule',
                                                                                                                                  'street1' => '179 N Harbor Dr',
                                                                                                                                  'city' => 'Redondo Beach',
                                                                                                                                  'state' => 'CA',
                                                                                                                                  'zip' => '90277',
                                                                                                                                  'country' => 'US',
                                                                                                                                  'phone' => '3331114444',
                                                                                                                                  'email' => 'dr_steve_brule@gmail.com'
                                                                                                                              ],
                                                                                                                              'from_address' => [
                                                                                                                                  'name' => 'EasyPost',
                                                                                                                                  'street1' => '417 Montgomery Street',
                                                                                                                                  'street2' => '5th Floor',
                                                                                                                                  'city' => 'San Francisco',
                                                                                                                                  'state' => 'CA',
                                                                                                                                  'zip' => '94104',
                                                                                                                                  'country' => 'US',
                                                                                                                                  'phone' => '3331114444',
                                                                                                                                  'email' => 'support@easypost.com'
                                                                                                                              ],
                                                                                                                              'parcel' => [
                                                                                                                                  'length' => 20.2,
                                                                                                                                  'width' => 10.9,
                                                                                                                                  'height' => 5,
                                                                                                                                  'weight' => 65.9
                                                                                                                              ]
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $shipment;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:07:34Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "currency": "USD",
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": "9405500207552011812856",
                                                                                                                            "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_e6014c4dcdf5453791e90ce9a1e02415",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:07:34Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_a3eccb0d4eea40919cd8ce3fb946f294",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:07:34Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_931d01beba4c11eea85f3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:34+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:34+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": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_e41371b468254344b140e685e879d69b",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:07:34Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": {
                                                                                                                              "object": "PostageLabel",
                                                                                                                              "id": "pl_737e9444077f4b00b11dd489f1ff1b24",
                                                                                                                              "created_at": "2024-01-24T00:07:34Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                              "date_advance": 0,
                                                                                                                              "integrated_form": "none",
                                                                                                                              "label_date": "2024-01-24T00:07:34Z",
                                                                                                                              "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/e855deb38cef7e400083067c600a9848f2.png",
                                                                                                                              "label_pdf_url": null,
                                                                                                                              "label_zpl_url": null,
                                                                                                                              "label_epl2_url": null,
                                                                                                                              "label_file": null
                                                                                                                            },
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_2c2df636028f414a9334c086be6d8a78",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:34Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_55157308ac5e46ef88c45f726bcbc786",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:34Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_9f6994d9e21940288ae27be89a958e92",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:34Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_75c2218b6bd149ec9b9145380024c633",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:34Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_c8fd8ed2574c4c1aa5d751e344786157",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:34Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": {
                                                                                                                              "id": "rate_55157308ac5e46ef88c45f726bcbc786",
                                                                                                                              "object": "Rate",
                                                                                                                              "created_at": "2024-01-24T00:07:34Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:34Z",
                                                                                                                              "mode": "test",
                                                                                                                              "service": "Priority",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "rate": "7.33",
                                                                                                                              "currency": "USD",
                                                                                                                              "retail_rate": "15.20",
                                                                                                                              "retail_currency": "USD",
                                                                                                                              "list_rate": "10.89",
                                                                                                                              "list_currency": "USD",
                                                                                                                              "billing_type": "easypost",
                                                                                                                              "delivery_days": 2,
                                                                                                                              "delivery_date": null,
                                                                                                                              "delivery_date_guaranteed": false,
                                                                                                                              "est_delivery_days": 2,
                                                                                                                              "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                              "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                            },
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_4f377a2463fe4af8a42f0bd2ea17d6d3",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9405500207552011812856",
                                                                                                                              "status": "unknown",
                                                                                                                              "status_detail": "unknown",
                                                                                                                              "created_at": "2024-01-24T00:07:35Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": null,
                                                                                                                              "shipment_id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [],
                                                                                                                              "fees": [],
                                                                                                                              "carrier_detail": null,
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrXzRmMzc3YTI0NjNmZTRhZjhhNDJmMGJkMmVhMTdkNmQz"
                                                                                                                            },
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_9319ec85ba4c11ee8ca2ac1f6bc53342",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:34+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:34+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_931d01beba4c11eea85f3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:34+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:34+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_9319ec85ba4c11ee8ca2ac1f6bc53342",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:34+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:34+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": "7.33000",
                                                                                                                                "charged": true,
                                                                                                                                "refunded": false
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "id": "shp_032866f1a5174949bc938acc7f4a19fc",
                                                                                                                            "object": "Shipment"
                                                                                                                          }
                                                                                                                          GET/shipments/:id/label

                                                                                                                          Convert the Label format of a Shipment

                                                                                                                          A Shipment's PostageLabel can be converted from PNG to other formats. To convert a PostageLabel, the original must be a PNG. Converting labels works best when they are 4x6 labels converted from PNG to ZPL.

                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                          
                                                                                                                          $shipmentWithLabel = $client->shipment->label(
                                                                                                                              $shipment->id,
                                                                                                                              ['file_format' => 'ZPL']
                                                                                                                          );
                                                                                                                          
                                                                                                                          echo $shipment;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:07:35Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "currency": "USD",
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": "9434600207552011812862",
                                                                                                                            "updated_at": "2024-01-24T00:07:36Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_7020222e3699472186d9be5f7fe03965",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:07:35Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_b5d2e40ce0ce4a19aab950a848928989",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:07:35Z",
                                                                                                                                  "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_93ec5efaba4c11eeb7baac1f6bc539aa",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:35+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:35+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": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_4aa6de11e4fa44739b7e4a2b3e28ad9a",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:07:35Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": {
                                                                                                                              "object": "PostageLabel",
                                                                                                                              "id": "pl_e5d4aec4ee23458ebcb4d29c41ee75f4",
                                                                                                                              "created_at": "2024-01-24T00:07:36Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:38Z",
                                                                                                                              "date_advance": 0,
                                                                                                                              "integrated_form": "none",
                                                                                                                              "label_date": "2024-01-24T00:07:36Z",
                                                                                                                              "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/e8118119c07a5e44a2aee0f6189f13f80a.png",
                                                                                                                              "label_pdf_url": null,
                                                                                                                              "label_zpl_url": "https://easypost-files.s3-us-west-2.amazonaws.com/files/postage_label/20240124/af790a0077514f32b1d035d8b2795bb0.zpl",
                                                                                                                              "label_epl2_url": null,
                                                                                                                              "label_file": null
                                                                                                                            },
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_2068707826484b3cb89fac312a15525d",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:35Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_a1cd9d7eb69d43d084b58a01a3d433b1",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:35Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_8276cb6c0c6e412a8dd4cf9b03de9eed",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:35Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_0f20dca65d464d56b6d86ad06f27f408",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:35Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_1cee068a0deb4f1283aeb9834c70bca1",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:07:35Z",
                                                                                                                                "updated_at": "2024-01-24T00:07:35Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": {
                                                                                                                              "id": "rate_2068707826484b3cb89fac312a15525d",
                                                                                                                              "object": "Rate",
                                                                                                                              "created_at": "2024-01-24T00:07:36Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:36Z",
                                                                                                                              "mode": "test",
                                                                                                                              "service": "GroundAdvantage",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "rate": "6.79",
                                                                                                                              "currency": "USD",
                                                                                                                              "retail_rate": "13.15",
                                                                                                                              "retail_currency": "USD",
                                                                                                                              "list_rate": "9.41",
                                                                                                                              "list_currency": "USD",
                                                                                                                              "billing_type": "easypost",
                                                                                                                              "delivery_days": 3,
                                                                                                                              "delivery_date": null,
                                                                                                                              "delivery_date_guaranteed": false,
                                                                                                                              "est_delivery_days": 3,
                                                                                                                              "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                              "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                            },
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_f82598977d4147b6829b688ff79a5f83",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9434600207552011812862",
                                                                                                                              "status": "pre_transit",
                                                                                                                              "status_detail": "status_update",
                                                                                                                              "created_at": "2024-01-24T00:07:37Z",
                                                                                                                              "updated_at": "2024-01-24T00:07:37Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": "2024-01-24T00:07:37Z",
                                                                                                                              "shipment_id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "pre_transit",
                                                                                                                                  "status_detail": "status_update",
                                                                                                                                  "datetime": "2023-12-24T00:07:37Z",
                                                                                                                                  "source": "USPS",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": null,
                                                                                                                                    "state": null,
                                                                                                                                    "country": null,
                                                                                                                                    "zip": null
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "Shipping Label Created",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "pre_transit",
                                                                                                                                  "status_detail": "status_update",
                                                                                                                                  "datetime": "2023-12-24T12:44:37Z",
                                                                                                                                  "source": "USPS",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": "HOUSTON",
                                                                                                                                    "state": "TX",
                                                                                                                                    "country": null,
                                                                                                                                    "zip": "77063"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              ],
                                                                                                                              "fees": [],
                                                                                                                              "carrier_detail": {
                                                                                                                                "object": "CarrierDetail",
                                                                                                                                "service": "First-Class Package Service",
                                                                                                                                "container_type": null,
                                                                                                                                "est_delivery_date_local": null,
                                                                                                                                "est_delivery_time_local": null,
                                                                                                                                "origin_location": "HOUSTON TX, 77001",
                                                                                                                                "origin_tracking_location": {
                                                                                                                                  "object": "TrackingLocation",
                                                                                                                                  "city": "HOUSTON",
                                                                                                                                  "state": "TX",
                                                                                                                                  "country": null,
                                                                                                                                  "zip": "77063"
                                                                                                                                },
                                                                                                                                "destination_location": "CHARLESTON SC, 29401",
                                                                                                                                "destination_tracking_location": null,
                                                                                                                                "guaranteed_delivery_date": null,
                                                                                                                                "alternate_identifier": null,
                                                                                                                                "initial_delivery_attempt": null
                                                                                                                              },
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrX2Y4MjU5ODk3N2Q0MTQ3YjY4MjliNjg4ZmY3OWE1Zjgz"
                                                                                                                            },
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_93e694b8ba4c11eea88d3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:35+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:36+00:00",
                                                                                                                              "name": "DR. STEVE BRULE",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N HARBOR DR",
                                                                                                                              "street2": null,
                                                                                                                              "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_93ec5efaba4c11eeb7baac1f6bc539aa",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:35+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:35+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_93e694b8ba4c11eea88d3cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:07:35+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:07:36+00:00",
                                                                                                                              "name": "DR. STEVE BRULE",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N HARBOR DR",
                                                                                                                              "street2": null,
                                                                                                                              "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": "6.79000",
                                                                                                                                "charged": true,
                                                                                                                                "refunded": false
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "id": "shp_1d00461199d74698b40c1c1cc55654a7",
                                                                                                                            "object": "Shipment"
                                                                                                                          }

                                                                                                                          Forms

                                                                                                                          After a Shipment is created, you can create various associated Form objects for that Shipment such as a return packing slip, QR codes, and other international shipping forms. For more information about how to use Forms with your Shipments, please check our Forms guide.

                                                                                                                          Forms that may be returned with Shipment objects depending on the carrier and data passed:

                                                                                                                          • cn22
                                                                                                                          • cod_return_label
                                                                                                                          • commercial_invoice
                                                                                                                          • high_value_report
                                                                                                                          • nafta_certificate_of_origin
                                                                                                                          • order_summary

                                                                                                                          Forms that can be created after a Shipment has been bought:

                                                                                                                          • commercial_invoice
                                                                                                                          • label_qr_code
                                                                                                                          • return_packing_slip
                                                                                                                          • rma_qr_code

                                                                                                                          Form Object

                                                                                                                          attributetypespecification
                                                                                                                          idstringUnique, begins with "form_"
                                                                                                                          objectstring"Form"
                                                                                                                          modestring"test" or "production"
                                                                                                                          form_typestringThe type of form, can be one of "cn22", "cod_return_label", "commercial_invoice", "high_value_report", "label_qr_code", "nafta_certificate_of_origin", "order_summary", "return_packing_slip", "rma_qr_code"
                                                                                                                          form_urlstringThe URL that a form can be downloaded from
                                                                                                                          submitted_electronicallybooleanIf we have submitted the form to the carrier on behalf of the user
                                                                                                                          created_atdatetimeWhen the form was created
                                                                                                                          updated_atdatetimeWhen the form was updated
                                                                                                                          POST/shipments/:id/forms

                                                                                                                          Create Form

                                                                                                                          Please see Form guide for request parameter.
                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                          
                                                                                                                          $formType = 'return_packing_slip';
                                                                                                                          $formOptions = [
                                                                                                                              'barcode' => 'RMA12345678900',
                                                                                                                              'line_items' => [
                                                                                                                                  [
                                                                                                                                      'product' => [
                                                                                                                                          'title' => 'Square Reader',
                                                                                                                                          'barcode' => '855658003251',
                                                                                                                                      ],
                                                                                                                                      'units' => 8,
                                                                                                                                  ],
                                                                                                                              ],
                                                                                                                          ];
                                                                                                                          
                                                                                                                          $shipmentWithForm = $client->shipment->generateForm($shipment->id, $formType, $formOptions);
                                                                                                                          
                                                                                                                          echo $shipmentWithForm;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:05:50Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "currency": "USD",
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": "9405500207552011812542",
                                                                                                                            "updated_at": "2024-01-24T00:05:51Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_22c094c28a5849c2831e345cfa8a4809",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:05:50Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_a1f6f1d173934f37a2ce669bb6657e3c",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:05:50Z",
                                                                                                                                  "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_550ea165ba4c11eeb9e7ac1f6bc53342",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:50+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:50+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": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_44286ed3097f46d1adbc382c934ce534",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:05:50Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": {
                                                                                                                              "object": "PostageLabel",
                                                                                                                              "id": "pl_325a0a9ea29843a4918757c6bebb71b3",
                                                                                                                              "created_at": "2024-01-24T00:05:50Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:51Z",
                                                                                                                              "date_advance": 0,
                                                                                                                              "integrated_form": "none",
                                                                                                                              "label_date": "2024-01-24T00:05:50Z",
                                                                                                                              "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/e82c64213af7be49b1b2aba1ea0c4dcd5f.png",
                                                                                                                              "label_pdf_url": null,
                                                                                                                              "label_zpl_url": null,
                                                                                                                              "label_epl2_url": null,
                                                                                                                              "label_file": null
                                                                                                                            },
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_bdc3690cc6634a1fafde081f3b26c3d9",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:50Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_501c02949c3e44b0ab50eebde3068c8b",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:50Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_9649550ada4944a2b3439289a428761e",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:50Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_4379eb9028654c9d93cf5905d8619163",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:50Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_03369f5e3a844ec2b88588f2d566eef0",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:50Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": {
                                                                                                                              "id": "rate_bdc3690cc6634a1fafde081f3b26c3d9",
                                                                                                                              "object": "Rate",
                                                                                                                              "created_at": "2024-01-24T00:05:50Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:50Z",
                                                                                                                              "mode": "test",
                                                                                                                              "service": "Priority",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "rate": "7.33",
                                                                                                                              "currency": "USD",
                                                                                                                              "retail_rate": "15.20",
                                                                                                                              "retail_currency": "USD",
                                                                                                                              "list_rate": "10.89",
                                                                                                                              "list_currency": "USD",
                                                                                                                              "billing_type": "easypost",
                                                                                                                              "delivery_days": 2,
                                                                                                                              "delivery_date": null,
                                                                                                                              "delivery_date_guaranteed": false,
                                                                                                                              "est_delivery_days": 2,
                                                                                                                              "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                              "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                            },
                                                                                                                            "tracker": {
                                                                                                                              "id": "trk_a6ead3f2a19d4e1abfd3d1ce4db88ad5",
                                                                                                                              "object": "Tracker",
                                                                                                                              "mode": "test",
                                                                                                                              "tracking_code": "9405500207552011812542",
                                                                                                                              "status": "pre_transit",
                                                                                                                              "status_detail": "status_update",
                                                                                                                              "created_at": "2024-01-24T00:05:51Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:51Z",
                                                                                                                              "signed_by": null,
                                                                                                                              "weight": null,
                                                                                                                              "est_delivery_date": "2024-01-24T00:05:51Z",
                                                                                                                              "shipment_id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                              "carrier": "USPS",
                                                                                                                              "tracking_details": [
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "pre_transit",
                                                                                                                                  "status_detail": "status_update",
                                                                                                                                  "datetime": "2023-12-24T00:05:51Z",
                                                                                                                                  "source": "USPS",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": null,
                                                                                                                                    "state": null,
                                                                                                                                    "country": null,
                                                                                                                                    "zip": null
                                                                                                                                  }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                  "object": "TrackingDetail",
                                                                                                                                  "message": "Shipping Label Created",
                                                                                                                                  "description": "",
                                                                                                                                  "status": "pre_transit",
                                                                                                                                  "status_detail": "status_update",
                                                                                                                                  "datetime": "2023-12-24T12:42:51Z",
                                                                                                                                  "source": "USPS",
                                                                                                                                  "carrier_code": "",
                                                                                                                                  "tracking_location": {
                                                                                                                                    "object": "TrackingLocation",
                                                                                                                                    "city": "HOUSTON",
                                                                                                                                    "state": "TX",
                                                                                                                                    "country": null,
                                                                                                                                    "zip": "77063"
                                                                                                                                  }
                                                                                                                                }
                                                                                                                              ],
                                                                                                                              "fees": [],
                                                                                                                              "carrier_detail": {
                                                                                                                                "object": "CarrierDetail",
                                                                                                                                "service": "First-Class Package Service",
                                                                                                                                "container_type": null,
                                                                                                                                "est_delivery_date_local": null,
                                                                                                                                "est_delivery_time_local": null,
                                                                                                                                "origin_location": "HOUSTON TX, 77001",
                                                                                                                                "origin_tracking_location": {
                                                                                                                                  "object": "TrackingLocation",
                                                                                                                                  "city": "HOUSTON",
                                                                                                                                  "state": "TX",
                                                                                                                                  "country": null,
                                                                                                                                  "zip": "77063"
                                                                                                                                },
                                                                                                                                "destination_location": "CHARLESTON SC, 29401",
                                                                                                                                "destination_tracking_location": null,
                                                                                                                                "guaranteed_delivery_date": null,
                                                                                                                                "alternate_identifier": null,
                                                                                                                                "initial_delivery_attempt": null
                                                                                                                              },
                                                                                                                              "public_url": "https://track.easypost.com/djE6dHJrX2E2ZWFkM2YyYTE5ZDRlMWFiZmQzZDFjZTRkYjg4YWQ1"
                                                                                                                            },
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_550c2974ba4c11ee96563cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:50+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:50+00:00",
                                                                                                                              "name": "DR. STEVE BRULE",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N HARBOR DR",
                                                                                                                              "street2": null,
                                                                                                                              "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_550ea165ba4c11eeb9e7ac1f6bc53342",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:50+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:50+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_550c2974ba4c11ee96563cecef1b359e",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:50+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:50+00:00",
                                                                                                                              "name": "DR. STEVE BRULE",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N HARBOR DR",
                                                                                                                              "street2": null,
                                                                                                                              "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": [
                                                                                                                              {
                                                                                                                                "object": "Form",
                                                                                                                                "id": "form_395cb033b8ed4be6bcacead7782cf0d9",
                                                                                                                                "created_at": "2024-01-24T00:05:52Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:52Z",
                                                                                                                                "mode": "test",
                                                                                                                                "form_type": "return_packing_slip",
                                                                                                                                "form_url": "https://easypost-files.s3-us-west-2.amazonaws.com/files/form/20240124/a4177d0bc14e456cb91e81f48f90fb83.pdf",
                                                                                                                                "submitted_electronically": null
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "fees": [
                                                                                                                              {
                                                                                                                                "object": "Fee",
                                                                                                                                "type": "LabelFee",
                                                                                                                                "amount": "0.00000",
                                                                                                                                "charged": true,
                                                                                                                                "refunded": false
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "object": "Fee",
                                                                                                                                "type": "PostageFee",
                                                                                                                                "amount": "7.33000",
                                                                                                                                "charged": true,
                                                                                                                                "refunded": false
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "id": "shp_5889c78f5e5547958e62f6993453f0d9",
                                                                                                                            "object": "Shipment"
                                                                                                                          }

                                                                                                                          Options

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

                                                                                                                          Options Object

                                                                                                                          attributetypespecification
                                                                                                                          additional_handlingbooleanSetting this option to true, will add an additional handling charge. An Additional Handling charge may be applied to the following:
                                                                                                                          • Any article that is encased in an outside shipping container made of metal or wood.
                                                                                                                          • Any item, such as a barrel, drum, pail or tire, that is not fully encased in a corrugated cardboard shipping container.
                                                                                                                          • Any package with the longest side exceeding 60 inches or its second longest side exceeding 30 inches.
                                                                                                                          • Any package with an actual weight greater than 70 pounds.
                                                                                                                          address_validation_levelstringSetting this option to "0", will allow the minimum amount of address information to pass the validation check. Only for USPS postage.
                                                                                                                          alcoholbooleanSet this option to true if your shipment contains alcohol.
                                                                                                                          • UPS - only supported for US Domestic shipments
                                                                                                                          • FedEx - only supported for US Domestic shipments
                                                                                                                          • Canada Post - Requires adult signature 19 years or older. If you want adult signature 18 years or older, instead use delivery_confirmation: ADULT_SIGNATURE
                                                                                                                          bill_receiver_accountstring*This field is deprecated. Use the 'payment' option object instead.
                                                                                                                          bill_receiver_postal_codestring*This field is deprecated. Use the 'payment' option object instead.
                                                                                                                          bill_third_party_accountstring*This field is deprecated. Use the 'payment' option object instead.
                                                                                                                          bill_third_party_countrystring*This field is deprecated. Use the 'payment' option object instead.
                                                                                                                          bill_third_party_postal_codestring*This field is deprecated. Use the 'payment' option object instead.
                                                                                                                          by_dronebooleanSetting this option to true will indicate to the carrier to prefer delivery by drone, if the carrier supports drone delivery.
                                                                                                                          carbon_neutralbooleanSetting this to true will add a charge to reduce carbon emissions by Carriers who support this option. Alternatively, EasyPost provides carbon neutral shipping for all carriers, by default, for free.
                                                                                                                          carrier_notification_emailstringAssign an email address to receive carrier notifications.
                                                                                                                          carrier_notification_smsstringAssign a phone number to receive carrier notifications.
                                                                                                                          cod_amountstringAdding an amount will have the carrier collect the specified amount from the recipient.
                                                                                                                          cod_methodstringMethod for payment. "CASH", "CHECK", "MONEY_ORDER"
                                                                                                                          cod_address_idstringThe ID of the Address to which the COD payment should be returned. Defaults to the origin address. Only available on FedEx shipments.
                                                                                                                          content_descriptionstringA description of the content of the shipment.
                                                                                                                          currencystringWhich currency this shipment will show for rates if carrier allows.
                                                                                                                          delivery_confirmationstringIf you want to request a signature, you can pass "ADULT_SIGNATURE" or "SIGNATURE". You may also request "NO_SIGNATURE" to leave the package at the door. "NO_SIGNATURE" is equivalent to releasing liability. Some options may be limited for international shipments. Carrier specific delivery confirmation options are listed below:
                                                                                                                          • FedEx - additional options
                                                                                                                            • "DIRECT" - Requires the signature of someone at the delivery address.
                                                                                                                            • "INDIRECT_SIGNATURE" - Requires the signature of someone at the delivery address or from somebody nearby, such as a neighbor.
                                                                                                                            • "SERVICE_DEFAULT" - Attempts to set the signature requirements based on the shipment details and service level.
                                                                                                                          • USPS - additional options
                                                                                                                            • "ADULT_SIGNATURE_RESTRICTED" - Requires the signature of the specific addressee, or authorized agent, who is 21 years of age or older.
                                                                                                                            • "SIGNATURE_RESTRICTED" - Requires the signature of the specified addressee, or authorized agent.
                                                                                                                          • Canada Post - "DO_NOT_SAFE_DROP" - Tells the carrier to not hide the package ("safe drop").
                                                                                                                          • GSO - "STANDARD_SIGNATURE".
                                                                                                                          • DHL Express - option mapping
                                                                                                                            • SIGNATURE" - DHL Express Direct Signature
                                                                                                                            • NO_SIGNATURE" - DHL Express Signature Release
                                                                                                                          delivery_min_datetimestringThe earliest a package should be delivered. Supported carriers vary.
                                                                                                                          delivery_max_datetimestringThe latest a package should be delivered. Supported carriers vary.
                                                                                                                          dropoff_typestringMethod the customer will use to transfer the package to the carrier. Supported dropoff types and their corresponding carrier dropoff codes are below:
                                                                                                                          FedEx
                                                                                                                          • REGULAR_PICKUP" - Customer to transfer package during regular pickup (default)
                                                                                                                          • SCHEDULED_PICKUP" - Customer to transfer package during scheduled pickup
                                                                                                                          • RETAIL_LOCATION" - Customer to transfer package at FedEx retail location
                                                                                                                          • STATION" - "STATION
                                                                                                                          • DROP_BOX" - Customer to use carrier drop box for package transfer
                                                                                                                          dry_icebooleanPackage contents contain dry ice.
                                                                                                                          • UPS - Need dry_ice_weight to be set
                                                                                                                          • UPS MailInnovations - Need dry_ice_weight to be set
                                                                                                                          • FedEx - Need dry_ice_weight to be set
                                                                                                                          dry_ice_medicalbooleanIf the dry ice is for medical use, set this option to true.
                                                                                                                          • UPS - Need dry_ice_weight to be set
                                                                                                                          • UPS MailInnovations - Need dry_ice_weight to be set
                                                                                                                          dry_ice_weightstringWeight of the dry ice in ounces.
                                                                                                                          • UPS - Need dry_ice to be set
                                                                                                                          • UPS MailInnovations - Need dry_ice to be set
                                                                                                                          • FedEx - Need dry_ice to be set
                                                                                                                          duty_paymentobjectSetting duty_payment type to bill the correct account for purchasing postage. This option is only available with FedEx and UPS.
                                                                                                                          • type - (string) Supported values are "THIRD_PARTY", and "RECEIVER".
                                                                                                                          • account - (string) Setting account number.
                                                                                                                          • country - (string) Setting country code that the account is based in.
                                                                                                                          • postal_code - (string) Setting postal code that the account is based in.
                                                                                                                          endorsementstring
                                                                                                                          • Supported by USPS:
                                                                                                                            • ELECTRONIC_SERVICE_REQUESTED
                                                                                                                            • TEMP_RETURN_SERVICE_REQUESTED
                                                                                                                          • Supported by UPS, FedEx, and DHL:
                                                                                                                            • NO_RETURN_TO_SENDER
                                                                                                                          • Supported by: USPS, UPS, FedEx, and DHL:
                                                                                                                            • ADDRESS_SERVICE_REQUESTED
                                                                                                                            • CHANGE_SERVICE_REQUESTED
                                                                                                                            • FORWARDING_SERVICE_REQUESTED
                                                                                                                            • LEAVE_IF_NO_RESPONSE
                                                                                                                            • RETURN_SERVICE_REQUESTED
                                                                                                                          end_shipper_idstringSpecify the responsible EndShipper for the shipment by passing in an EndShipper ID.
                                                                                                                          freight_chargedoubleAdditional cost to be added to the invoice of this shipment. Only applies to UPS currently.
                                                                                                                          handling_instructionsstringThis is to designate special instructions for the carrier like "Do not drop!".
                                                                                                                          hazmatstring

                                                                                                                          Used to identify the type of hazardous materials (HazMat) or dangerous goods being shipped. Unidentified HazMat can introduce risk to human safety, property and expose the shipper to civil penalties, especially for packages that travel via air. Each carrier may have a different way of identifying HazMat and rates will only be retuned for carriers that support the type designated. Refer to carrier documentation to determine how to identify HazMat types and for complete rules and regulations.

                                                                                                                          FedEx and DHL eCommerce
                                                                                                                          • PRIMARY_CONTAINED: Primary Contained
                                                                                                                          • PRIMARY_PACKED: Primary Packed
                                                                                                                          • PRIMARY: Primary
                                                                                                                          • SECONDARY_CONTAINED: Secondary Contained
                                                                                                                          • SECONDARY_PACKED: Secondary Packed
                                                                                                                          • SECONDARY: Secondary
                                                                                                                          • ORMD: Other Regulated Materials—Domestic
                                                                                                                          • LITHIUM: Lithium
                                                                                                                          FedEx, DHL eCommerce, and USPS
                                                                                                                          • LIMITED_QUANTITY: Limited Quantity Ground Package
                                                                                                                          USPS: See EasyPost's USPS HazMat Guide and USPS Pub. 52 for complete regulations.
                                                                                                                          • AIR_ELIGIBLE_ETHANOL: Air Eligible Ethanol Package
                                                                                                                          • CLASS_1: Class 1 - Toy Propellant/Safety Fuse Package
                                                                                                                          • CLASS_3: Class 3 - Package
                                                                                                                          • CLASS_7: Class 7 - Radioactive Materials Package
                                                                                                                          • CLASS_8_CORROSIVE: Class 8 - Corrosive Materials Package
                                                                                                                          • CLASS_8_WET_BATTERY: Class 8 - Nonspillable Wet Battery Package
                                                                                                                          • CLASS_9_NEW_LITHIUM_INDIVIDUAL: Class 9 - Lithium Battery Marked - Ground Only Package
                                                                                                                          • CLASS_9_USED_LITHIUM: Class 9 - Lithium Battery - Returns Package
                                                                                                                          • CLASS_9_NEW_LITHIUM_DEVICE: Class 9 - Lithium batteries, marked package
                                                                                                                          • CLASS_9_DRY_ICE: Class 9 - Dry Ice Package
                                                                                                                          • CLASS_9_UNMARKED_LITHIUM: Class 9 - Lithium batteries, unmarked package
                                                                                                                          • CLASS_9_MAGNETIZED: Class 9 - Magnetized Materials Package
                                                                                                                          • DIVISION_4_1: Division 4.1 - Mailable flammable solids and Safety Matches Package
                                                                                                                          • DIVISION_5_1: Division 5.1 - Oxidizers Package
                                                                                                                          • DIVISION_5_2: Division 5.2 - Organic Peroxides Package
                                                                                                                          • DIVISION_6_1: Division 6.1 - Toxic Materials Package (with an LD50 of 50 mg/kg or less)
                                                                                                                          • DIVISION_6_2: Division 6.2
                                                                                                                          • EXCEPTED_QUANTITY_PROVISION: Excepted Quantity Provision Package
                                                                                                                          • GROUND_ONLY: Ground Only
                                                                                                                          • ID8000: ID8000 Consumer Commodity Package
                                                                                                                          • LIGHTERS: Lighters Package
                                                                                                                          • SMALL_QUANTITY_PROVISION: Small Quantity Provision Package
                                                                                                                          hold_for_pickupbooleanPackage will wait at carrier facility for pickup.
                                                                                                                          incotermstringIncoterm negotiated for shipment. Supported values are "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP", "FAS", "FOB", "CFR", and "CIF". Setting this value to anything other than "DDP" will pass the cost and responsibility of duties on to the recipient of the package(s), as specified by Incoterms rules
                                                                                                                          invoice_numberstringThis will print an invoice number on the postage label.
                                                                                                                          label_datestringSet the date that will appear on the postage label. Accepts ISO 8601 formatted string including time zone offset. EasyPost stores all dates as UTC time.
                                                                                                                          label_formatstringSupported label formats include "PNG", "PDF", "ZPL", and "EPL2". "PNG" is the only format that allows for conversion.
                                                                                                                          machinablebooleanWhether or not the parcel can be processed by the carriers equipment.
                                                                                                                          paymentobjectSetting payment type to bill the correct account for purchasing postage. THIRD_PARTY is only supported on passthrough billed carriers.
                                                                                                                          • type - (string) Supported values are "SENDER", "THIRD_PARTY", "RECEIVER", "COLLECT". Defaults to SENDER.
                                                                                                                          • account - (string) Setting account number. Required for RECEIVER and THIRD_PARTY.
                                                                                                                          • country - (string) Setting country code that the account is based in. Required for THIRD_PARTY.
                                                                                                                          • postal_code - (string) Setting postal code that the account is based in. Required for RECEIVER and THIRD_PARTY.
                                                                                                                          pickup_min_datetimestringThe earliest a package should be picked up. Supported carriers vary.
                                                                                                                          pickup_max_datetimestringThe latest a package should be picked up. Supported carriers vary.
                                                                                                                          print_custom_1stringYou can optionally print custom messages on labels. The locations of these fields show up on different spots on the carrier's labels.
                                                                                                                          print_custom_2stringAn additional message on the label. Same restrictions as print_custom_1
                                                                                                                          print_custom_3stringAn additional message on the label. Same restrictions as print_custom_1
                                                                                                                          print_custom_1_barcodebooleanCreate a barcode for this custom reference if supported by carrier.
                                                                                                                          print_custom_2_barcodebooleanCreate a barcode for this custom reference if supported by carrier.
                                                                                                                          print_custom_3_barcodebooleanCreate a barcode for this custom reference if supported by carrier.
                                                                                                                          print_custom_1_codestringSpecify the type of print_custom_1.
                                                                                                                          FedEx
                                                                                                                          • (null) - If print_custom_1_code is not provided it defaults to Customer Reference
                                                                                                                          • PO - Purchase Order Number
                                                                                                                          • DP - Department Number
                                                                                                                          • RMA - Return Merchandise Authorization
                                                                                                                          UPS
                                                                                                                          • AJ - Accounts Receivable Customer Account
                                                                                                                          • AT - Appropriation Number
                                                                                                                          • BM - Bill of Lading Number
                                                                                                                          • 9V - Collect on Delivery (COD) Number
                                                                                                                          • ON - Dealer Order Number
                                                                                                                          • DP - Department Number
                                                                                                                          • 3Q - Food and Drug Administration (FDA) Product Code
                                                                                                                          • IK - Invoice Number
                                                                                                                          • MK - Manifest Key Number
                                                                                                                          • MJ - Model Number
                                                                                                                          • PM - Part Number
                                                                                                                          • PC - Production Code
                                                                                                                          • PO - Purchase Order Number
                                                                                                                          • RQ - Purchase Request Number
                                                                                                                          • RZ - Return Authorization Number
                                                                                                                          • SA - Salesperson Number
                                                                                                                          • SE - Serial Number
                                                                                                                          • ST - Store Number
                                                                                                                          • TN - Transaction Reference Number
                                                                                                                          • EI - Employer's ID Number
                                                                                                                          • TJ - Federal Taxpayer ID No.
                                                                                                                          print_custom_2_codestringSee print_custom_1_code.
                                                                                                                          print_custom_3_codestringSee print_custom_1_code.
                                                                                                                          saturday_deliverybooleanSet this value to true to make your shipment eligible for Saturday delivery.
                                                                                                                          special_rates_eligibilitystringThis option enables the selection of USPS Media Mail or Library Mail classes. Specify 'USPS.MEDIAMAIL' or 'USPS.LIBRARYMAIL' to return respective rates. To request rates for both classes simultaneously, input 'USPS.MEDIAMAIL,USPS.LIBRARYMAIL'. These mail classes are subject to restrictions and eligibility rules as outlined in the DMM .
                                                                                                                          smartpost_hubstringYou can use this to override the hub ID you have on your account.
                                                                                                                          smartpost_manifeststringThe manifest ID is used to group FedEx Ground Economy packages onto a manifest for each trailer.
                                                                                                                          billing_refstringA reference ID for aggregating DHL eCommerce billing data.
                                                                                                                          certified_mailbooleanCertified Mail provides the sender with a mailing receipt and, upon request, electronic verification that an article was delivered or that a delivery attempt was made.
                                                                                                                          registered_mailbooleanRegistered Mail is the most secure service that the USPS offers. It incorporates a system of receipts to monitor the movement of the mail from the point of acceptance to delivery
                                                                                                                          registered_mail_amountdoubleThe value of the package contents
                                                                                                                          return_receiptbooleanAn electronic return receipt may be purchased at the time of mailing and provides a shipper with evidence of delivery (to whom the mail was delivered and date of delivery), and information about the recipient's actual delivery address. Only applies to the USPS.
                                                                                                                          POST/shipments

                                                                                                                          Create a Shipment with Options

                                                                                                                          Any number of options can be specified during Shipment creation.

                                                                                                                          Example
                                                                                                                          <?php
                                                                                                                          
                                                                                                                          $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                          
                                                                                                                          $shipment = $client->shipment->create([
                                                                                                                              'to_address' => ['id' => 'adr_...'],
                                                                                                                              'from_address' => ['id' => 'adr_...'],
                                                                                                                              'parcel' => [
                                                                                                                                  'length' => 20.2,
                                                                                                                                  'width' => 10.9,
                                                                                                                                  'height' => 5,
                                                                                                                                  'weight' => 65.9
                                                                                                                              ],
                                                                                                                              'options' => ['print_custom_1' => 'Custom label message']
                                                                                                                          ]);
                                                                                                                          
                                                                                                                          echo $shipment;
                                                                                                                          {
                                                                                                                            "created_at": "2024-01-24T00:05:54Z",
                                                                                                                            "is_return": false,
                                                                                                                            "messages": [],
                                                                                                                            "mode": "test",
                                                                                                                            "options": {
                                                                                                                              "print_custom_1": "Custom label message",
                                                                                                                              "currency": "USD",
                                                                                                                              "print_custom": [
                                                                                                                                {
                                                                                                                                  "value": "Custom label message"
                                                                                                                                }
                                                                                                                              ],
                                                                                                                              "payment": {
                                                                                                                                "type": "SENDER"
                                                                                                                              },
                                                                                                                              "date_advance": 0
                                                                                                                            },
                                                                                                                            "reference": null,
                                                                                                                            "status": "unknown",
                                                                                                                            "tracking_code": null,
                                                                                                                            "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                            "batch_id": null,
                                                                                                                            "batch_status": null,
                                                                                                                            "batch_message": null,
                                                                                                                            "customs_info": {
                                                                                                                              "id": "cstinfo_8a0e647447974eaf97d0d94fe660c888",
                                                                                                                              "object": "CustomsInfo",
                                                                                                                              "created_at": "2024-01-24T00:05:54Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                              "contents_explanation": "",
                                                                                                                              "contents_type": "merchandise",
                                                                                                                              "customs_certify": true,
                                                                                                                              "customs_signer": "Steve Brule",
                                                                                                                              "eel_pfc": "NOEEI 30.37(a)",
                                                                                                                              "non_delivery_option": "return",
                                                                                                                              "restriction_comments": null,
                                                                                                                              "restriction_type": "none",
                                                                                                                              "mode": "test",
                                                                                                                              "declaration": null,
                                                                                                                              "customs_items": [
                                                                                                                                {
                                                                                                                                  "id": "cstitem_34121009b24446eca08712c10b95ffb7",
                                                                                                                                  "object": "CustomsItem",
                                                                                                                                  "created_at": "2024-01-24T00:05:54Z",
                                                                                                                                  "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                                  "description": "T-shirt",
                                                                                                                                  "hs_tariff_number": "123456",
                                                                                                                                  "origin_country": "US",
                                                                                                                                  "quantity": 1,
                                                                                                                                  "value": "10.0",
                                                                                                                                  "weight": 5.0,
                                                                                                                                  "code": "123",
                                                                                                                                  "mode": "test",
                                                                                                                                  "manufacturer": null,
                                                                                                                                  "currency": null,
                                                                                                                                  "eccn": null,
                                                                                                                                  "printed_commodity_identifier": null
                                                                                                                                }
                                                                                                                              ]
                                                                                                                            },
                                                                                                                            "from_address": {
                                                                                                                              "id": "adr_57988df8ba4c11ee8d3bac1f6bc539ae",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:54+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:54+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": null,
                                                                                                                            "parcel": {
                                                                                                                              "id": "prcl_5e953fb53a5f4207b7d6ee32267d25cb",
                                                                                                                              "object": "Parcel",
                                                                                                                              "created_at": "2024-01-24T00:05:54Z",
                                                                                                                              "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                              "length": 20.2,
                                                                                                                              "width": 10.9,
                                                                                                                              "height": 5.0,
                                                                                                                              "predefined_package": null,
                                                                                                                              "weight": 65.9,
                                                                                                                              "mode": "test"
                                                                                                                            },
                                                                                                                            "postage_label": null,
                                                                                                                            "rates": [
                                                                                                                              {
                                                                                                                                "id": "rate_caa4e8d8f0ae4a06b7ea79451886c781",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:54Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Express",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "49.60",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "57.40",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "49.60",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": null,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": null,
                                                                                                                                "shipment_id": "shp_ca70827221b04ad589f0d170ec933f52",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_c5c1761ec40244e3bb06e16e4bf84e27",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:54Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "Priority",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "7.33",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "15.20",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "10.89",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 2,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 2,
                                                                                                                                "shipment_id": "shp_ca70827221b04ad589f0d170ec933f52",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_4f361f673c364f28bd4c8aa806c9a226",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:54Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "GroundAdvantage",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_ca70827221b04ad589f0d170ec933f52",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_c201b421c0304e73a4320c240d3c206b",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:54Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "First",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_ca70827221b04ad589f0d170ec933f52",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              },
                                                                                                                              {
                                                                                                                                "id": "rate_c1a6b070dd9d45acb3f3a3eaf3a439bd",
                                                                                                                                "object": "Rate",
                                                                                                                                "created_at": "2024-01-24T00:05:54Z",
                                                                                                                                "updated_at": "2024-01-24T00:05:54Z",
                                                                                                                                "mode": "test",
                                                                                                                                "service": "ParcelSelect",
                                                                                                                                "carrier": "USPS",
                                                                                                                                "rate": "6.79",
                                                                                                                                "currency": "USD",
                                                                                                                                "retail_rate": "13.15",
                                                                                                                                "retail_currency": "USD",
                                                                                                                                "list_rate": "9.41",
                                                                                                                                "list_currency": "USD",
                                                                                                                                "billing_type": "easypost",
                                                                                                                                "delivery_days": 3,
                                                                                                                                "delivery_date": null,
                                                                                                                                "delivery_date_guaranteed": false,
                                                                                                                                "est_delivery_days": 3,
                                                                                                                                "shipment_id": "shp_ca70827221b04ad589f0d170ec933f52",
                                                                                                                                "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "refund_status": null,
                                                                                                                            "scan_form": null,
                                                                                                                            "selected_rate": null,
                                                                                                                            "tracker": null,
                                                                                                                            "to_address": {
                                                                                                                              "id": "adr_5795ce04ba4c11ee8d39ac1f6bc539ae",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:54+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:54+00:00",
                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                              "street2": null,
                                                                                                                              "city": "Redondo Beach",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "90277",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "8573875756",
                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                              "mode": "test",
                                                                                                                              "carrier_facility": null,
                                                                                                                              "residential": null,
                                                                                                                              "federal_tax_id": null,
                                                                                                                              "state_tax_id": null,
                                                                                                                              "verifications": {}
                                                                                                                            },
                                                                                                                            "usps_zone": 4,
                                                                                                                            "return_address": {
                                                                                                                              "id": "adr_57988df8ba4c11ee8d3bac1f6bc539ae",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:54+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:54+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_5795ce04ba4c11ee8d39ac1f6bc539ae",
                                                                                                                              "object": "Address",
                                                                                                                              "created_at": "2024-01-24T00:05:54+00:00",
                                                                                                                              "updated_at": "2024-01-24T00:05:54+00:00",
                                                                                                                              "name": "Dr. Steve Brule",
                                                                                                                              "company": null,
                                                                                                                              "street1": "179 N Harbor Dr",
                                                                                                                              "street2": null,
                                                                                                                              "city": "Redondo Beach",
                                                                                                                              "state": "CA",
                                                                                                                              "zip": "90277",
                                                                                                                              "country": "US",
                                                                                                                              "phone": "8573875756",
                                                                                                                              "email": "dr_steve_brule@gmail.com",
                                                                                                                              "mode": "test",
                                                                                                                              "carrier_facility": null,
                                                                                                                              "residential": null,
                                                                                                                              "federal_tax_id": null,
                                                                                                                              "state_tax_id": null,
                                                                                                                              "verifications": {}
                                                                                                                            },
                                                                                                                            "forms": [],
                                                                                                                            "fees": [],
                                                                                                                            "id": "shp_ca70827221b04ad589f0d170ec933f52",
                                                                                                                            "object": "Shipment"
                                                                                                                          }

                                                                                                                          Rates

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

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

                                                                                                                          Rates Object

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

                                                                                                                          Service Levels

                                                                                                                          Accurate
                                                                                                                          • Route
                                                                                                                          Amazon MWS
                                                                                                                          • UPS Rates
                                                                                                                          • USPS Rates
                                                                                                                          • FedEx Rates
                                                                                                                          • UPS Labels
                                                                                                                          • USPS Labels
                                                                                                                          • FedEx Labels
                                                                                                                          • UPS Tracking
                                                                                                                          • USPS Tracking
                                                                                                                          • FedEx Tracking
                                                                                                                          APC
                                                                                                                          • parcelConnectBookService
                                                                                                                          • parcelConnectExpeditedDDP
                                                                                                                          • parcelConnectExpeditedDDU
                                                                                                                          • parcelConnectPriorityDDP
                                                                                                                          • parcelConnectPriorityDDPDelcon
                                                                                                                          • parcelConnectPriorityDDU
                                                                                                                          • parcelConnectPriorityDDUDelcon
                                                                                                                          • parcelConnectPriorityDDUPQW
                                                                                                                          • parcelConnectStandardDDU
                                                                                                                          • parcelConnectStandardDDUPQW
                                                                                                                          • parcelConnectPacketDDU
                                                                                                                          Asendia USA
                                                                                                                          • ADS
                                                                                                                          • AirFreightInbound
                                                                                                                          • AirFreightOutbound
                                                                                                                          • AsendiaDomesticBoundPrinterMatterExpedited
                                                                                                                          • AsendiaDomesticBoundPrinterMatterGround
                                                                                                                          • AsendiaDomesticFlatsExpedited
                                                                                                                          • AsendiaDomesticFlatsGround
                                                                                                                          • AsendiaDomesticParcelGroundOver1lb
                                                                                                                          • AsendiaDomesticParcelGroundUnder1lb
                                                                                                                          • AsendiaDomesticParcelMAXOver1lb
                                                                                                                          • AsendiaDomesticParcelMAXUnder1lb
                                                                                                                          • AsendiaDomesticParcelOver1lbExpedited
                                                                                                                          • AsendiaDomesticParcelUnder1lbExpedited
                                                                                                                          • AsendiaDomesticPromoParcelExpedited
                                                                                                                          • AsendiaDomesticPromoParcelGround
                                                                                                                          • BulkFreight
                                                                                                                          • BusinessMailCanadaLettermail
                                                                                                                          • BusinessMailCanadaLettermailMachineable
                                                                                                                          • BusinessMailEconomy
                                                                                                                          • BusinessMailEconomyLPWholesale
                                                                                                                          • BusinessMailEconomySPWholesale
                                                                                                                          • BusinessMailIPA
                                                                                                                          • BusinessMailISAL
                                                                                                                          • BusinessMailPriority
                                                                                                                          • BusinessMailPriorityLPWholesale
                                                                                                                          • BusinessMailPrioritySPWholesale
                                                                                                                          • MarketingMailCanadaPersonalizedLCP
                                                                                                                          • MarketingMailCanadaPersonalizedMachineable
                                                                                                                          • MarketingMailCanadaPersonalizedNDG
                                                                                                                          • MarketingMailEconomy
                                                                                                                          • MarketingMailIPA
                                                                                                                          • MarketingMailISAL
                                                                                                                          • MarketingMailPriority
                                                                                                                          • PublicationsCanadaLCP
                                                                                                                          • PublicationsCanadaNDG
                                                                                                                          • PublicationsEconomy
                                                                                                                          • PublicationsIPA
                                                                                                                          • PublicationsISAL
                                                                                                                          • PublicationsPriority
                                                                                                                          • ePAQElite
                                                                                                                          • ePAQEliteCustom
                                                                                                                          • ePAQEliteDAP
                                                                                                                          • ePAQEliteDDP
                                                                                                                          • ePAQEliteDDPOversized
                                                                                                                          • ePAQEliteDPD
                                                                                                                          • ePAQEliteDirectAccessCanadaDDP
                                                                                                                          • ePAQEliteOversized
                                                                                                                          • ePAQPlus
                                                                                                                          • ePAQPlusCustom
                                                                                                                          • ePAQPlusCustomsPrepaid
                                                                                                                          • ePAQPlusDAP
                                                                                                                          • ePAQPlusDDP
                                                                                                                          • ePAQPlusEconomy
                                                                                                                          • ePAQPlusWholesale
                                                                                                                          • ePAQPlusePacket
                                                                                                                          • ePAQPlusePacketCanadaCustomsPrePaid
                                                                                                                          • ePAQPlusePacketCanadaDDP
                                                                                                                          • ePAQReturnsDomestic
                                                                                                                          • ePAQReturnsInternational
                                                                                                                          • ePAQSelect
                                                                                                                          • ePAQSelectCustom
                                                                                                                          • ePAQSelectCustomsPrepaidByShopper
                                                                                                                          • ePAQSelectDAP
                                                                                                                          • ePAQSelectDDP
                                                                                                                          • ePAQSelectDDPDirectAccess
                                                                                                                          • ePAQSelectDirectAccess
                                                                                                                          • ePAQSelectDirectAccessCanadaDDP
                                                                                                                          • ePAQSelectEconomy
                                                                                                                          • ePAQSelectOversized
                                                                                                                          • ePAQSelectOversizedDDP
                                                                                                                          • ePAQSelectPMEI
                                                                                                                          • ePAQSelectPMEICanadaCustomsPrePaid
                                                                                                                          • ePAQSelectPMEIPCPostage
                                                                                                                          • ePAQSelectPMI
                                                                                                                          • ePAQSelectPMICanadaCustomsPrepaid
                                                                                                                          • ePAQSelectPMICanadaDDP
                                                                                                                          • ePAQSelectPMINonPresort
                                                                                                                          • ePAQSelectPMIPCPostage
                                                                                                                          • ePAQStandard
                                                                                                                          • ePAQStandardCustom
                                                                                                                          • ePAQStandardEconomy
                                                                                                                          • ePAQStandardIPA
                                                                                                                          • ePAQStandardISAL
                                                                                                                          • ePaqSelectPMEINonPresort
                                                                                                                          • ePAQSelectDDPDG
                                                                                                                          Australia Post
                                                                                                                          • ParcelPost
                                                                                                                          • ExpressPost
                                                                                                                          • International
                                                                                                                          • Commercial
                                                                                                                          Better Trucks
                                                                                                                          • NEXT_DAY
                                                                                                                          • EXPRESS
                                                                                                                          Canada Post
                                                                                                                          • RegularParcel
                                                                                                                          • ExpeditedParcel
                                                                                                                          • Xpresspost
                                                                                                                          • Priority
                                                                                                                          • ExpeditedParcelUSA
                                                                                                                          • SmallPacketUSAAir
                                                                                                                          • TrackedPacketUSA
                                                                                                                          • TrackedPacketUSALVM
                                                                                                                          • XpresspostUSA
                                                                                                                          • XpresspostInternational
                                                                                                                          • InternationalParcelAir
                                                                                                                          • InternationalParcelSurface
                                                                                                                          • SmallPacketInternationalAir
                                                                                                                          • SmallPacketInternationalSurface
                                                                                                                          • TrackedPacketInternational
                                                                                                                          • ExpeditedParcelPlus
                                                                                                                          Canpar
                                                                                                                          • Ground
                                                                                                                          • USA
                                                                                                                          • SelectLetter
                                                                                                                          • SelectPak
                                                                                                                          • Select
                                                                                                                          • OvernightLetter
                                                                                                                          • OvernightPak
                                                                                                                          • Overnight
                                                                                                                          • USALetter
                                                                                                                          • USAPak
                                                                                                                          • SelectUSA
                                                                                                                          • International
                                                                                                                          CDL Last Mile Solutions
                                                                                                                          • DISTRIBUTION
                                                                                                                          • Same Day
                                                                                                                          Chronopost

                                                                                                                          No service levels for Chronopost.

                                                                                                                            Cirro E-Commerce
                                                                                                                            • CAECOCE (US to CA Economy)
                                                                                                                            • CAECONE (US to CA Economy)
                                                                                                                            • CAECOWE (US to CA Economy)
                                                                                                                            • ECOCE (Economy Central)
                                                                                                                            • ECOEA (Economy East)
                                                                                                                            • ECONE (Economy Northeast)
                                                                                                                            • ECOSO (Economy South)
                                                                                                                            • ECOWE (Economy West)
                                                                                                                            • EUECOWE (US to Europe Economy)
                                                                                                                            • EXPBNE (Expedited Northeast)
                                                                                                                            • EXPWE (Expedited West)
                                                                                                                            • REGCE (Regional Central)
                                                                                                                            • REGEA (Regional East)
                                                                                                                            • REGNE (Regional Northeast)
                                                                                                                            • REGSO (Regional South)
                                                                                                                            • REGWE (Regional West)
                                                                                                                            CloudSort

                                                                                                                            No service levels for CloudSort.

                                                                                                                              Courier Express
                                                                                                                              • BASIC_PARCEL
                                                                                                                              Couriers Please
                                                                                                                              • RoadExpress
                                                                                                                              • AggExpAtlP10
                                                                                                                              • AggExpAtlP25
                                                                                                                              • AggExpAtlBaseandKilo
                                                                                                                              • AggExpAtlP0
                                                                                                                              • AggExpAtlP1
                                                                                                                              • AggExpAtlP3
                                                                                                                              • AggExpAtlP5
                                                                                                                              • AggDropOffHubbedBaseandKilo
                                                                                                                              • AggDropOffHubbedP0
                                                                                                                              • AggDropOffHubbedP1
                                                                                                                              • AggDropOffHubbedP3
                                                                                                                              • AggDropOffHubbedP5
                                                                                                                              • AggStdAtlP10
                                                                                                                              • AggStdAtlBaseandKilo
                                                                                                                              • AggStdAtlP0
                                                                                                                              • AggStdAtlP1
                                                                                                                              • AggStdAtlP3
                                                                                                                              • AggStdAtlP5
                                                                                                                              • AggEcomBaseandKilo
                                                                                                                              • AggEcomP0
                                                                                                                              • AggEcomP1
                                                                                                                              • AggEcomP3
                                                                                                                              • AggEcomP5
                                                                                                                              • AggDropOffHubbedP10
                                                                                                                              • AggDropOffHubbedP25
                                                                                                                              • AggStdAtlP25
                                                                                                                              • AggEcomP10
                                                                                                                              • AggEcomP25
                                                                                                                              • AustralianCityExpress
                                                                                                                              • DropShip500GramParcel
                                                                                                                              • DropShip1KgParcel
                                                                                                                              • DropShip3KgParcel
                                                                                                                              • DropShip5KgParcel
                                                                                                                              • DomesticPriority
                                                                                                                              • DropShip10KgParcel
                                                                                                                              • DropShip20KgParcel
                                                                                                                              • DomesticPrioritySignature
                                                                                                                              • GoldDomestic
                                                                                                                              • RoadExpressNoDelivery
                                                                                                                              • RoadExpressNoPickUp
                                                                                                                              • 500GramParcel
                                                                                                                              • 500GramParcelATL
                                                                                                                              • 10KgParcel
                                                                                                                              • 10KgParcelATL
                                                                                                                              • 15KgParcel
                                                                                                                              • 15KgParcelATL
                                                                                                                              • 1KgParcelATL
                                                                                                                              • 2KgParcel
                                                                                                                              • 25KgParcel
                                                                                                                              • 25KgParcelATL
                                                                                                                              • 2KgParcelATL
                                                                                                                              • 3KgParcelATL
                                                                                                                              • 5Kg Parcel ATL
                                                                                                                              • AustralianCityExpressSignature
                                                                                                                              • DomesticSaverSignature
                                                                                                                              • DomesticOffPeak
                                                                                                                              • DomesticSaver
                                                                                                                              • DomesticOffPeakSignature
                                                                                                                              • GoldDomesticSignature
                                                                                                                              • 1KgSatchelATL
                                                                                                                              • 1KgSatchel
                                                                                                                              • 3KgSatchel
                                                                                                                              • 5KgSatchel
                                                                                                                              • 3KgSatchelATL
                                                                                                                              • 5KgSatchelATL
                                                                                                                              • 500GramSatchelATL
                                                                                                                              • 500GramSatchel
                                                                                                                              • 5KSatchel
                                                                                                                              • ExpressInternationalPriority
                                                                                                                              • InternationalSaver
                                                                                                                              • InternationalExpressImport
                                                                                                                              • InternationalExpress
                                                                                                                              • 500gmParcel
                                                                                                                              • 1KgParcel
                                                                                                                              • 3KgParcel
                                                                                                                              • 5KgParcel
                                                                                                                              CSLogistics
                                                                                                                              • Distribution
                                                                                                                              DAI Post
                                                                                                                              • ParcelMax
                                                                                                                              • InternationalEconomy
                                                                                                                              • InternationalStandard
                                                                                                                              • InternationalExpress
                                                                                                                              • DomesticTracked
                                                                                                                              • ParcelRight
                                                                                                                              Deliver-It
                                                                                                                              • Saturday
                                                                                                                              • Economy
                                                                                                                              • Noon-It
                                                                                                                              • Early-It
                                                                                                                              • Afternoon
                                                                                                                              Deutsche Post
                                                                                                                              • PacketPlus
                                                                                                                              Deutsche Post UK
                                                                                                                              • PriorityPacketPlus
                                                                                                                              • PriorityPacket
                                                                                                                              • PriorityPacketTracked
                                                                                                                              • BusinessMailRegistered
                                                                                                                              • StandardPacket
                                                                                                                              • BusinessMailStandard
                                                                                                                              DHL eCommerce Solutions
                                                                                                                              • DHLParcelExpedited
                                                                                                                              • DHLParcelExpeditedMax
                                                                                                                              • DHLParcelGround
                                                                                                                              • DHLBPMExpedited
                                                                                                                              • DHLBPMGround
                                                                                                                              • DHLParcelInternationalDirect
                                                                                                                              • DHLParcelInternationalStandard
                                                                                                                              • DHLPacketInternational
                                                                                                                              • DHLParcelInternationalDirectPriority
                                                                                                                              • DHLParcelInternationalDirectStandard
                                                                                                                              DHL Express
                                                                                                                              • BreakBulkEconomy
                                                                                                                              • BreakBulkExpress
                                                                                                                              • DomesticEconomySelect
                                                                                                                              • DomesticExpress
                                                                                                                              • DomesticExpress1030
                                                                                                                              • DomesticExpress1200
                                                                                                                              • EconomySelect
                                                                                                                              • EconomySelectNonDoc
                                                                                                                              • EuroPack
                                                                                                                              • EuropackNonDoc
                                                                                                                              • Express1030
                                                                                                                              • Express1030NonDoc
                                                                                                                              • Express1200NonDoc
                                                                                                                              • Express1200
                                                                                                                              • Express900
                                                                                                                              • Express900NonDoc
                                                                                                                              • ExpressEasy
                                                                                                                              • ExpressEasyNonDoc
                                                                                                                              • ExpressEnvelope
                                                                                                                              • ExpressWorldwide
                                                                                                                              • ExpressWorldwideB2C
                                                                                                                              • ExpressWorldwideB2CNonDoc
                                                                                                                              • ExpressWorldwideECX
                                                                                                                              • ExpressWorldwideNonDoc
                                                                                                                              • FreightWorldwide
                                                                                                                              • GlobalmailBusiness
                                                                                                                              • JetLine
                                                                                                                              • JumboBox
                                                                                                                              • LogisticsServices
                                                                                                                              • SameDay
                                                                                                                              • SecureLine
                                                                                                                              • SprintLine
                                                                                                                              DHL Paket
                                                                                                                              • EuroPaket
                                                                                                                              • Paket
                                                                                                                              • PaketConnect
                                                                                                                              • PaketInternational
                                                                                                                              • Retoure
                                                                                                                              DoorDash
                                                                                                                              • Standard
                                                                                                                              DPD
                                                                                                                              • DPDCLASSIC
                                                                                                                              • DPD8:30
                                                                                                                              • DPD10:00
                                                                                                                              • DPD12:00
                                                                                                                              • DPD18:00
                                                                                                                              • DPDEXPRESS
                                                                                                                              • DPDPARCELLETTER
                                                                                                                              • DPDPARCELLETTERPLUS
                                                                                                                              • DPDINTERNATIONALMAIL
                                                                                                                              DPD NL
                                                                                                                              • DPDNL_CLASSIC
                                                                                                                              • EXPRESS_10
                                                                                                                              • EXPRESS_12
                                                                                                                              • EXPRESS_18
                                                                                                                              • INTERNATIONAL_EXPRESS
                                                                                                                              • DPDNL_HOME
                                                                                                                              • DPDNL_TO_SHOP
                                                                                                                              DPD UK
                                                                                                                              • AirClassicInternationalAir
                                                                                                                              • AirExpressInternationalAir
                                                                                                                              • ExpresspakDpd10:30
                                                                                                                              • ExpresspakDpd12:00
                                                                                                                              • ExpresspakDpdClassic
                                                                                                                              • ExpresspakDpdNextDay
                                                                                                                              • ExpresspakSaturday
                                                                                                                              • ExpresspakSaturday10:30
                                                                                                                              • ExpresspakSaturday12:00
                                                                                                                              • ExpresspakSunday
                                                                                                                              • ExpresspakSunday12:00
                                                                                                                              • FreightParcelDpd10:30
                                                                                                                              • FreightParcelDpd12:00
                                                                                                                              • FreightParcelDpdClassic
                                                                                                                              • FreightParcelDpdNextDay
                                                                                                                              • FreightParcelDpdTwoDay
                                                                                                                              • FreightParcelSaturday
                                                                                                                              • FreightParcelSaturday10:30
                                                                                                                              • FreightParcelSaturday12:00
                                                                                                                              • FreightParcelSunday
                                                                                                                              • FreightParcelSunday12:00
                                                                                                                              • PalletDpd10:30
                                                                                                                              • PalletDpd12:00
                                                                                                                              • PalletDpdClassic
                                                                                                                              • PalletDpdNextDay
                                                                                                                              • PalletDpdTwoDay
                                                                                                                              • PalletSaturday
                                                                                                                              • PalletSaturday10:30
                                                                                                                              • PalletSaturday12:00
                                                                                                                              • PalletSunday
                                                                                                                              • PalletSunday12:00
                                                                                                                              • ParcelDpd10:30
                                                                                                                              • ParcelDpd12:00
                                                                                                                              • ParcelDpdClassic
                                                                                                                              • ParcelDpdNextDay
                                                                                                                              • ParcelDpdTwoDay
                                                                                                                              • ParcelReturnToShop
                                                                                                                              • ParcelSaturday
                                                                                                                              • ParcelSaturday10:30
                                                                                                                              • ParcelSaturday12:00
                                                                                                                              • ParcelSunday
                                                                                                                              • ParcelSunday12:00
                                                                                                                              ePostGlobal
                                                                                                                              • CourierServiceDDP
                                                                                                                              • CourierServiceDDU
                                                                                                                              • DomesticEconomyParcel
                                                                                                                              • DomesticParcelBPM
                                                                                                                              • DomesticPriorityParcel
                                                                                                                              • DomesticPriorityParcelBPM
                                                                                                                              • EMIService
                                                                                                                              • EconomyParcelService
                                                                                                                              • IPAService
                                                                                                                              • ISALService
                                                                                                                              • PMIService
                                                                                                                              • PriorityParcelDDP
                                                                                                                              • PriorityParcelDDU
                                                                                                                              • PriorityParcelDeliveryConfirmationDDP
                                                                                                                              • PriorityParcelDeliveryConfirmationDDU
                                                                                                                              • ePacketService
                                                                                                                              Estafeta
                                                                                                                              • NextDayBy930
                                                                                                                              • NextDayBy1130
                                                                                                                              • NextDay
                                                                                                                              • Ground
                                                                                                                              • TwoDay
                                                                                                                              • LTL
                                                                                                                              Evri
                                                                                                                              • Courier2Home
                                                                                                                              • Courier2HomeNextDay
                                                                                                                              • Shop2Home
                                                                                                                              • Shop2HomeNextDay
                                                                                                                              • Shop2Shop
                                                                                                                              • Shop2ShopNextDay
                                                                                                                              • Courier2Shop
                                                                                                                              • Courier2ShopNextDay
                                                                                                                              • International Delivery
                                                                                                                              • Commercial
                                                                                                                              • DDP Courier
                                                                                                                              • DDU Courier
                                                                                                                              • DDU Shop
                                                                                                                              • Postal
                                                                                                                              Fastway
                                                                                                                              • Parcel
                                                                                                                              • Satchel
                                                                                                                              FedEx
                                                                                                                              • FEDEX_2_DAY
                                                                                                                              • FEDEX_2_DAY_AM
                                                                                                                              • FEDEX_EXPRESS_SAVER
                                                                                                                              • FEDEX_GROUND
                                                                                                                              • FEDEX_INTERNATIONAL_CONNECT_PLUS
                                                                                                                              • FIRST_OVERNIGHT
                                                                                                                              • GROUND_HOME_DELIVERY
                                                                                                                              • INTERNATIONAL_ECONOMY
                                                                                                                              • INTERNATIONAL_FIRST
                                                                                                                              • INTERNATIONAL_PRIORITY
                                                                                                                              • PRIORITY_OVERNIGHT
                                                                                                                              • SMART_POST
                                                                                                                              • STANDARD_OVERNIGHT
                                                                                                                              FedEx Ground Economy
                                                                                                                              • SMART_POST
                                                                                                                              First Choice
                                                                                                                              • ST
                                                                                                                              First Mile
                                                                                                                              • XParcelPriority
                                                                                                                              • XParcelExpedited
                                                                                                                              • XParcelReturns
                                                                                                                              • XParcelGround
                                                                                                                              • XParcelExpeditedPlus
                                                                                                                              Flexport
                                                                                                                              • Standard
                                                                                                                              • Expedited
                                                                                                                              Gio
                                                                                                                              • scheduled
                                                                                                                              GSO
                                                                                                                              • CaliforniaParcelService
                                                                                                                              • EarlyPriorityOvernight
                                                                                                                              • EarlySaturdayService
                                                                                                                              • Ground
                                                                                                                              • Overnight
                                                                                                                              • PriorityOvernight
                                                                                                                              • SaturdayDeliveryService
                                                                                                                              Hailify
                                                                                                                              • Xpress
                                                                                                                              Interlink Express
                                                                                                                              • InterlinkAirClassicInternationalAir
                                                                                                                              • InterlinkAirExpressInternationalAir
                                                                                                                              • InterlinkExpresspak1By10:30
                                                                                                                              • InterlinkExpresspak1By12
                                                                                                                              • InterlinkExpresspak1NextDay
                                                                                                                              • InterlinkExpresspak1Saturday
                                                                                                                              • InterlinkExpresspak1SaturdayBy10:30
                                                                                                                              • InterlinkExpresspak1SaturdayBy12
                                                                                                                              • InterlinkExpresspak1Sunday
                                                                                                                              • InterlinkExpresspak1SundayBy12
                                                                                                                              • InterlinkExpresspak5By10
                                                                                                                              • InterlinkExpresspak5By10:30
                                                                                                                              • InterlinkExpresspak5By12
                                                                                                                              • InterlinkExpresspak5NextDay
                                                                                                                              • InterlinkExpresspak5Saturday
                                                                                                                              • InterlinkExpresspak5SaturdayBy10
                                                                                                                              • InterlinkExpresspak5SaturdayBy10:30
                                                                                                                              • InterlinkExpresspak5SaturdayBy12
                                                                                                                              • InterlinkExpresspak5Sunday
                                                                                                                              • InterlinkExpresspak5SundayBy12
                                                                                                                              • InterlinkFreightBy10
                                                                                                                              • InterlinkFreightBy12
                                                                                                                              • InterlinkFreightNextDay
                                                                                                                              • InterlinkFreightSaturday
                                                                                                                              • InterlinkFreightSaturdayBy10
                                                                                                                              • InterlinkFreightSaturdayBy12
                                                                                                                              • InterlinkFreightSunday
                                                                                                                              • InterlinkFreightSundayBy12
                                                                                                                              • InterlinkParcelBy10
                                                                                                                              • InterlinkParcelBy10:30
                                                                                                                              • InterlinkParcelBy12
                                                                                                                              • InterlinkParcelDpdEuropeByRoad
                                                                                                                              • InterlinkParcelNextDay
                                                                                                                              • InterlinkParcelReturn
                                                                                                                              • InterlinkParcelReturnToShop
                                                                                                                              • InterlinkParcelSaturday
                                                                                                                              • InterlinkParcelSaturdayBy10
                                                                                                                              • InterlinkParcelSaturdayBy10:30
                                                                                                                              • InterlinkParcelSaturdayBy12
                                                                                                                              • InterlinkParcelShipToShop
                                                                                                                              • InterlinkParcelSunday
                                                                                                                              • InterlinkParcelSundayBy12
                                                                                                                              • InterlinkParcelTwoDay
                                                                                                                              • InterlinkPickupParcelDpdEuropeByRoad
                                                                                                                              Jet
                                                                                                                              • Distribution
                                                                                                                              Jitsu
                                                                                                                              • AxleHireDelivery
                                                                                                                              JP Post

                                                                                                                              No service levels for JP Post.

                                                                                                                                Kuroneko Yamato

                                                                                                                                No service levels for Kuroneko Yamato.

                                                                                                                                  La Poste

                                                                                                                                  No service levels for La Poste.

                                                                                                                                    LaserShip
                                                                                                                                    • SameDay
                                                                                                                                    • NextDay
                                                                                                                                    • Weekend
                                                                                                                                    Loomis Express
                                                                                                                                    • LoomisGround
                                                                                                                                    • LoomisExpress1800
                                                                                                                                    • LoomisExpress1200
                                                                                                                                    • LoomisExpress900
                                                                                                                                    LSO
                                                                                                                                    • PriorityEarly
                                                                                                                                    • PriorityBasic
                                                                                                                                    • Priority2ndDay
                                                                                                                                    • GroundEarly
                                                                                                                                    • GroundBasic
                                                                                                                                    • ECommerce
                                                                                                                                    Maergo
                                                                                                                                    • Standard
                                                                                                                                    Newgistics
                                                                                                                                    • ParcelSelect
                                                                                                                                    • ParcelSelectLightweight
                                                                                                                                    • Ground
                                                                                                                                    • Express
                                                                                                                                    • FirstClassMail
                                                                                                                                    • PriorityMail
                                                                                                                                    • BoundPrintedMatter
                                                                                                                                    Ontrac
                                                                                                                                    • Sunrise
                                                                                                                                    • Gold
                                                                                                                                    • OnTracGround
                                                                                                                                    • SameDay
                                                                                                                                    • PalletizedFreight
                                                                                                                                    Optima
                                                                                                                                    • NxtDay
                                                                                                                                    OSM Worldwide
                                                                                                                                    • Priority
                                                                                                                                    • BPM
                                                                                                                                    • ParcelSelect
                                                                                                                                    • MediaMail
                                                                                                                                    • MarketingParcel
                                                                                                                                    • MarketingParcelTracked
                                                                                                                                    • ParcelSelectHazardousMaterial
                                                                                                                                    • USPSGroundAdvantage
                                                                                                                                    • USPSGroundAdvantageLightweight
                                                                                                                                    • USPSGroundAdvantageHazmat
                                                                                                                                    • USPSGroundAdvantageHazmatSignature
                                                                                                                                    • USPSGroundAdvantageLightweightHazmat
                                                                                                                                    • USPSGroundAdvantageLightweightHazmatSignature
                                                                                                                                    • ParcelSelectHazmatSignature
                                                                                                                                    Pandion
                                                                                                                                    • Pandion Express
                                                                                                                                    Parcelforce
                                                                                                                                    • europrioritybusiness
                                                                                                                                    • europriorityhome
                                                                                                                                    • express10
                                                                                                                                    • express10CourierPack
                                                                                                                                    • express10Exchange
                                                                                                                                    • express10Secure
                                                                                                                                    • express10SecureExchange
                                                                                                                                    • express24
                                                                                                                                    • express24CourierPack
                                                                                                                                    • express24Exchange
                                                                                                                                    • express24large
                                                                                                                                    • express24Secure
                                                                                                                                    • express24SecureExchange
                                                                                                                                    • express48
                                                                                                                                    • express48large
                                                                                                                                    • express9
                                                                                                                                    • express9CourierPack
                                                                                                                                    • express9Secure
                                                                                                                                    • expressAM
                                                                                                                                    • expressAMCourierPack
                                                                                                                                    • expressAMExchange
                                                                                                                                    • expressAMSecure
                                                                                                                                    • expressAMSecureExchange
                                                                                                                                    • expressPM
                                                                                                                                    • expressPMSecure
                                                                                                                                    • globalBulkDirect
                                                                                                                                    • globalexpress
                                                                                                                                    • globalexpressEnvelopeDelivery
                                                                                                                                    • globalexpressPackDelivery
                                                                                                                                    • globalpriority
                                                                                                                                    • globalpriorityReturns
                                                                                                                                    • globalvalue
                                                                                                                                    • irelandexpress
                                                                                                                                    • ParcelRiderPlus
                                                                                                                                    Passport

                                                                                                                                    No service levels for Passport.

                                                                                                                                      PostNL

                                                                                                                                      No service levels for PostNL.

                                                                                                                                        Purolator
                                                                                                                                        • PurolatorExpress
                                                                                                                                        • PurolatorExpress12PM
                                                                                                                                        • PurolatorExpressPack12PM
                                                                                                                                        • PurolatorExpressBox12PM
                                                                                                                                        • PurolatorExpressEnvelope12PM
                                                                                                                                        • PurolatorExpress1030AM
                                                                                                                                        • PurolatorExpress9AM
                                                                                                                                        • PurolatorExpressBox
                                                                                                                                        • PurolatorExpressBox1030AM
                                                                                                                                        • PurolatorExpressBox9AM
                                                                                                                                        • PurolatorExpressBoxEvening
                                                                                                                                        • PurolatorExpressBoxInternational
                                                                                                                                        • PurolatorExpressBoxUS
                                                                                                                                        • PurolatorExpressEnvelope
                                                                                                                                        • PurolatorExpressEnvelope1030AM
                                                                                                                                        • PurolatorExpressEnvelope9AM
                                                                                                                                        • PurolatorExpressEnvelopeEvening
                                                                                                                                        • PurolatorExpressEnvelopeInternational
                                                                                                                                        • PurolatorExpressEnvelopeUS
                                                                                                                                        • PurolatorExpressEvening
                                                                                                                                        • PurolatorExpressInternational
                                                                                                                                        • PurolatorExpressInternational1030AM
                                                                                                                                        • PurolatorExpressInternational1200
                                                                                                                                        • PurolatorExpressInternational9AM
                                                                                                                                        • PurolatorExpressBoxInternational1030AM
                                                                                                                                        • PurolatorExpressBoxInternational1200
                                                                                                                                        • PurolatorExpressBoxInternational9AM
                                                                                                                                        • PurolatorExpressEnvelopeInternational1030AM
                                                                                                                                        • PurolatorExpressEnvelopeInternational1200
                                                                                                                                        • PurolatorExpressEnvelopeInternational9AM
                                                                                                                                        • PurolatorExpressPackInternational1030AM
                                                                                                                                        • PurolatorExpressPackInternational1200
                                                                                                                                        • PurolatorExpressPackInternational9AM
                                                                                                                                        • PurolatorExpressPack
                                                                                                                                        • PurolatorExpressPack1030AM
                                                                                                                                        • PurolatorExpressPack9AM
                                                                                                                                        • PurolatorExpressPackEvening
                                                                                                                                        • PurolatorExpressPackInternational
                                                                                                                                        • PurolatorExpressPackUS
                                                                                                                                        • PurolatorExpressUS
                                                                                                                                        • PurolatorExpressUS1030AM
                                                                                                                                        • PurolatorExpressUS1200
                                                                                                                                        • PurolatorExpressUS9AM
                                                                                                                                        • PurolatorExpressBoxUS1030AM
                                                                                                                                        • PurolatorExpressBoxUS1200
                                                                                                                                        • PurolatorExpressBoxUS9AM
                                                                                                                                        • PurolatorExpressEnvelopeUS1030AM
                                                                                                                                        • PurolatorExpressEnvelopeUS1200
                                                                                                                                        • PurolatorExpressEnvelopeUS9AM
                                                                                                                                        • PurolatorExpressPackUS1030AM
                                                                                                                                        • PurolatorExpressPackUS1200
                                                                                                                                        • PurolatorExpressPackUS9AM
                                                                                                                                        • PurolatorGround
                                                                                                                                        • PurolatorGround1030AM
                                                                                                                                        • PurolatorGround9AM
                                                                                                                                        • PurolatorGround12PM
                                                                                                                                        • PurolatorGroundDistribution
                                                                                                                                        • PurolatorGroundEvening
                                                                                                                                        • PurolatorGroundUS
                                                                                                                                        • PurolatorQuickShip
                                                                                                                                        • PurolatorQuickShipEnvelope
                                                                                                                                        • PurolatorQuickShipPack
                                                                                                                                        • PurolatorQuickShipBox
                                                                                                                                        Quick
                                                                                                                                        • Routed
                                                                                                                                        Royal Mail
                                                                                                                                        • InternationalPriority
                                                                                                                                        • InternationalEconomy
                                                                                                                                        • InternationalStandard
                                                                                                                                        • InternationalTrackedAndSigned
                                                                                                                                        • InternationalTracked
                                                                                                                                        • InternationalSigned
                                                                                                                                        • AccountMail
                                                                                                                                        • RoyalMailUnsigned
                                                                                                                                        • RoyalMail
                                                                                                                                        • SpecialDeliveryGuaranteed
                                                                                                                                        • SpecialDeliveryGuaranteed1pm
                                                                                                                                        • SpecialDeliveryGuaranteed9am
                                                                                                                                        • StandardLetter
                                                                                                                                        • Tracked24
                                                                                                                                        • Tracked24HighVolume
                                                                                                                                        • Tracked24HighVolumeSignature
                                                                                                                                        • Tracked24LBT
                                                                                                                                        • Tracked24SignatureLBT
                                                                                                                                        • Tracked48LBT
                                                                                                                                        • Tracked48SignatureLBT
                                                                                                                                        • Tracked24Signature
                                                                                                                                        • Tracked48
                                                                                                                                        • Tracked48HighVolume
                                                                                                                                        • Tracked48HighVolumeSignature
                                                                                                                                        • Tracked48Signature
                                                                                                                                        • TrackedReturns24
                                                                                                                                        • TrackedReturns48
                                                                                                                                        • CrossBorderImportTracked48HighVolume
                                                                                                                                        SEKO OmniParcel
                                                                                                                                        • Ecommerce Standard Tracked
                                                                                                                                        • Ecommerce Express Tracked
                                                                                                                                        • Domestic Express
                                                                                                                                        • Domestic Standard
                                                                                                                                        Sendle
                                                                                                                                        • Standard
                                                                                                                                        • Express
                                                                                                                                        • Saver
                                                                                                                                        • Two-Day
                                                                                                                                        • Three-Day
                                                                                                                                        SF Express
                                                                                                                                        • InternationalStandardExpressDoc
                                                                                                                                        • InternationalStandardExpressParcel
                                                                                                                                        • InternationalEconomyExpressPilot
                                                                                                                                        • InternationalEconomyExpressDoc
                                                                                                                                        • InternationalEconomyExpressParcel
                                                                                                                                        • DomesticExpress
                                                                                                                                        • DomesticStandard
                                                                                                                                        • DomesticIntraCity
                                                                                                                                        • StandardExpress
                                                                                                                                        • EconomyExpress
                                                                                                                                        SmartKargo
                                                                                                                                        • EPR
                                                                                                                                        • EPS
                                                                                                                                        • EST
                                                                                                                                        • EXP
                                                                                                                                        Sonic
                                                                                                                                        • SAMEDAY
                                                                                                                                        Spee-Dee
                                                                                                                                        • SpeeDeeDelivery
                                                                                                                                        Swyft
                                                                                                                                        • NEXTDAY
                                                                                                                                        • SAMEDAY
                                                                                                                                        TForce Logistics
                                                                                                                                        • NextDay
                                                                                                                                        • Return
                                                                                                                                        Toll
                                                                                                                                        • IPEC Direct
                                                                                                                                        • IPEC Fashion
                                                                                                                                        • IPEC Local
                                                                                                                                        • IPEC Priority
                                                                                                                                        • IPEC Road Express
                                                                                                                                        • IPEC Sensitive
                                                                                                                                        • IPEC VicEXP
                                                                                                                                        UDS
                                                                                                                                        • DeliveryService
                                                                                                                                        UPS
                                                                                                                                        • Ground
                                                                                                                                        • UPSStandard
                                                                                                                                        • UPSSaver
                                                                                                                                        • Express
                                                                                                                                        • ExpressPlus
                                                                                                                                        • Expedited
                                                                                                                                        • NextDayAir
                                                                                                                                        • NextDayAirSaver
                                                                                                                                        • NextDayAirEarlyAM
                                                                                                                                        • 2ndDayAir
                                                                                                                                        • 2ndDayAirAM
                                                                                                                                        • 3DaySelect
                                                                                                                                        UPS iParcel

                                                                                                                                        No service levels for UPS iParcel.

                                                                                                                                          UPS Mail Innovations
                                                                                                                                          • BPMFlats
                                                                                                                                          • BPMParcels
                                                                                                                                          • EconomyMailInnovations
                                                                                                                                          • ExpeditedMailInnovations
                                                                                                                                          • First
                                                                                                                                          • MarketingParcels
                                                                                                                                          • MediaMail
                                                                                                                                          • ParcelSelect
                                                                                                                                          • ParcelSelectLightweight-Irreg
                                                                                                                                          • Priority
                                                                                                                                          • PriorityMailInnovations
                                                                                                                                          • SingleReturns
                                                                                                                                          • StandardFlats
                                                                                                                                          USPS
                                                                                                                                          • First
                                                                                                                                          • Priority
                                                                                                                                          • Express
                                                                                                                                          • GroundAdvantage
                                                                                                                                          • LibraryMail
                                                                                                                                          • MediaMail
                                                                                                                                          • FirstClassMailInternational
                                                                                                                                          • FirstClassPackageInternationalService
                                                                                                                                          • PriorityMailInternational
                                                                                                                                          • ExpressMailInternational
                                                                                                                                          Veho
                                                                                                                                          • nextDay
                                                                                                                                          • sameDay
                                                                                                                                          Yanwen

                                                                                                                                          No service levels for Yanwen.

                                                                                                                                            POST/shipments/:id/rerate

                                                                                                                                            Regenerate Rates for a Shipment

                                                                                                                                            You can regenerate the Rates of a Shipment at any time. This is ideal when shipments aren't bought the same day as they were created and you want the most up-to-date rates available. This operation respects the carrier_accounts attribute.

                                                                                                                                            Example
                                                                                                                                            <?php
                                                                                                                                            
                                                                                                                                            $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                                            
                                                                                                                                            $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                                            
                                                                                                                                            $shipmentWithRegeneratedrates = $client->shipment->regenerateRates($shipment->id);
                                                                                                                                            
                                                                                                                                            echo $shipmentWithRegeneratedrates;
                                                                                                                                            {
                                                                                                                                              "rates": [
                                                                                                                                                {
                                                                                                                                                  "id": "rate_baa35256609648be87726a3e2dfebdac",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "created_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "updated_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "Priority",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "7.33",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "15.20",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "10.89",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 2,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 2,
                                                                                                                                                  "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "id": "rate_2bab14cc52364f2b9bc2ccf3ca7b3862",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "created_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "updated_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "GroundAdvantage",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "6.79",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "13.15",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "9.41",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "id": "rate_e378828036014066810f573b11e3422c",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "created_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "updated_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "First",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "6.79",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "13.15",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "9.41",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "id": "rate_6989382e7baf477e90b024d4b2adb123",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "created_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "updated_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "ParcelSelect",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "6.79",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "13.15",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "9.41",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "id": "rate_d1795faa20de435089eac68b61ae37dc",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "created_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "updated_at": "2024-01-24T00:07:18Z",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "Express",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "49.60",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "57.40",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "49.60",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": null,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": null,
                                                                                                                                                  "shipment_id": "shp_ad0d9c3e424b498698df7258db0d677e",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                }
                                                                                                                                              ]
                                                                                                                                            }
                                                                                                                                            POST/beta/rates

                                                                                                                                            Retrieve Rates for a Shipment

                                                                                                                                            You can retrieve Rates without creating a Shipment object using this endpoint. This endpoint is ideal when wanting to display or compare rates without creating Shipment objects. The Rate objects returned by this endpoint do not include IDs.

                                                                                                                                            Request Parameters
                                                                                                                                            paramexampleinfo
                                                                                                                                            reference"my-reference"An optional field that may be used in place of id in other API endpoints
                                                                                                                                            to_address<Address>Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
                                                                                                                                            from_address<Address>Can be specified by ID or attributes to create a new one, and be verified inline. See Create and Verify Address
                                                                                                                                            parcel<Parcel>
                                                                                                                                            carrier_accounts["ca_..."]List of carrier accounts
                                                                                                                                            service"Priority"The service of carrier
                                                                                                                                            Example
                                                                                                                                            <?php
                                                                                                                                            
                                                                                                                                            $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                                            
                                                                                                                                            $shipmentDetails = [
                                                                                                                                                'to_address' => [
                                                                                                                                                    'name' => 'Dr. Steve Brule',
                                                                                                                                                    'street1' => '179 N Harbor Dr',
                                                                                                                                                    'city' => 'Redondo Beach',
                                                                                                                                                    'state' => 'CA',
                                                                                                                                                    'zip' => '90277',
                                                                                                                                                    'country' => 'US',
                                                                                                                                                    'phone' => '3331114444',
                                                                                                                                                    'email' => 'dr_steve_brule@gmail.com'
                                                                                                                                                ],
                                                                                                                                                'from_address' => [
                                                                                                                                                    'name' => 'EasyPost',
                                                                                                                                                    'street1' => '417 Montgomery Street',
                                                                                                                                                    'street2' => '5th Floor',
                                                                                                                                                    'city' => 'San Francisco',
                                                                                                                                                    'state' => 'CA',
                                                                                                                                                    'zip' => '94104',
                                                                                                                                                    'country' => 'US',
                                                                                                                                                    'phone' => '3331114444',
                                                                                                                                                    'email' => 'support@easypost.com'
                                                                                                                                                ],
                                                                                                                                                'parcel' => [
                                                                                                                                                    'length' => 20.2,
                                                                                                                                                    'width' => 10.9,
                                                                                                                                                    'height' => 5,
                                                                                                                                                    'weight' => 65.9
                                                                                                                                                ]
                                                                                                                                            ];
                                                                                                                                            
                                                                                                                                            $rates = $client->betaRate->retrieveStatelessRates($shipmentDetails);
                                                                                                                                            
                                                                                                                                            echo $rates;
                                                                                                                                            {
                                                                                                                                              "from_address": {
                                                                                                                                                "object": "Address",
                                                                                                                                                "name": "EasyPost",
                                                                                                                                                "street1": "417 Montgomery Street",
                                                                                                                                                "street2": "5th Floor",
                                                                                                                                                "city": "San Francisco",
                                                                                                                                                "state": "CA",
                                                                                                                                                "zip": "94104",
                                                                                                                                                "country": "US",
                                                                                                                                                "phone": "4153334445",
                                                                                                                                                "email": "support@easypost.com"
                                                                                                                                              },
                                                                                                                                              "to_address": {
                                                                                                                                                "object": "Address",
                                                                                                                                                "name": "Dr. Steve Brule",
                                                                                                                                                "street1": "179 N Harbor Dr",
                                                                                                                                                "city": "Redondo Beach",
                                                                                                                                                "state": "CA",
                                                                                                                                                "zip": "90277",
                                                                                                                                                "country": "US",
                                                                                                                                                "phone": "8573875756",
                                                                                                                                                "email": "dr_steve_brule@gmail.com"
                                                                                                                                              },
                                                                                                                                              "rates": [
                                                                                                                                                {
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "Priority",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "7.33",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "15.20",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "10.89",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 2,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 2,
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "GroundAdvantage",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "6.79",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "13.15",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "9.41",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "First",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "6.79",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "13.15",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "9.41",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "ParcelSelect",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "6.79",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "13.15",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "9.41",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "service": "Express",
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "rate": "49.60",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "retail_rate": "57.40",
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "list_rate": "49.60",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "billing_type": "easypost",
                                                                                                                                                  "delivery_days": null,
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "est_delivery_days": null,
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                                }
                                                                                                                                              ],
                                                                                                                                              "options": {
                                                                                                                                                "currency": "USD",
                                                                                                                                                "payment": {
                                                                                                                                                  "type": "SENDER"
                                                                                                                                                },
                                                                                                                                                "date_advance": 0
                                                                                                                                              },
                                                                                                                                              "parcel": {
                                                                                                                                                "object": "Parcel",
                                                                                                                                                "length": 20.2,
                                                                                                                                                "width": 10.9,
                                                                                                                                                "height": 5.0,
                                                                                                                                                "weight": 65.9
                                                                                                                                              },
                                                                                                                                              "messages": []
                                                                                                                                            }

                                                                                                                                            Messages

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

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

                                                                                                                                            Message Object

                                                                                                                                            attributetypespecification
                                                                                                                                            carrierstringthe name of the carrier generating the error, e.g. "UPS"
                                                                                                                                            typestringthe category of error that occurred. Most frequently "rate_error"
                                                                                                                                            messagestringthe string from the carrier explaining the problem
                                                                                                                                            carrier_account_idstringthe account id of the carrier. Useful if you have multiple accounts with the same carrier

                                                                                                                                            SmartRate

                                                                                                                                            The SmartRate API provides shippers with highly accurate, Shipment-level transit time predictions which can be used to save money, improve on-time delivery, and provide end customers with reliable delivery estimates.

                                                                                                                                            The SmartRate API accepts a Shipment ID and returns predicted transit days across a variety of percentiles for each carrier service being evaluated for the Shipment. The transit time predictions in the response are based off of a sophisticated model using actual historical data for the shipping lane in question.

                                                                                                                                            To make a request to the SmartRate API, first create a Shipment, then make the SmartRate call. Using the response, you can now make better data-driven decisions about which Rate to select when purchasing a label.

                                                                                                                                            Time in Transit Object

                                                                                                                                            attributetypespecification
                                                                                                                                            percentile_50integerexpected transit days at the 50th percentile
                                                                                                                                            percentile_75integerexpected transit days at the 75th percentile
                                                                                                                                            percentile_85integerexpected transit days at the 85th percentile
                                                                                                                                            percentile_90integerexpected transit days at the 90th percentile
                                                                                                                                            percentile_95integerexpected transit days at the 95th percentile
                                                                                                                                            percentile_97integerexpected transit days at the 97th percentile
                                                                                                                                            percentile_99integerexpected transit days at the 99th percentile
                                                                                                                                            GET/shipments/:id/smartrate

                                                                                                                                            Retrieve Time in Transit statistics across all Rates for a Shipment

                                                                                                                                            The SmartRate API returns a Time in Transit object with transit days across a variety of percentiles for every Rate for a given Shipment. Transit days are calculated as the number of business days between the first time the carrier acknowledges possession of the Shipment and the first out-for-delivery attempt.

                                                                                                                                            Example
                                                                                                                                            <?php
                                                                                                                                            
                                                                                                                                            $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                                            
                                                                                                                                            $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                                            
                                                                                                                                            $smartRates = $client->shipment->getSmartrates();
                                                                                                                                            
                                                                                                                                            echo $smartRates;
                                                                                                                                            {
                                                                                                                                              "result": [
                                                                                                                                                {
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                  "created_at": "2024-01-24T00:07:44Z",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "delivery_days": null,
                                                                                                                                                  "est_delivery_days": null,
                                                                                                                                                  "id": "rate_29120e36c58a4232b14547e53b0131c6",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "list_rate": 49.6,
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "rate": 49.6,
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "retail_rate": 57.4,
                                                                                                                                                  "service": "Express",
                                                                                                                                                  "shipment_id": "shp_91721066728d473999b736a0d3f88ce8",
                                                                                                                                                  "time_in_transit": {
                                                                                                                                                    "percentile_50": 1,
                                                                                                                                                    "percentile_75": 2,
                                                                                                                                                    "percentile_85": 2,
                                                                                                                                                    "percentile_90": 3,
                                                                                                                                                    "percentile_95": 3,
                                                                                                                                                    "percentile_97": 4,
                                                                                                                                                    "percentile_99": 6
                                                                                                                                                  },
                                                                                                                                                  "updated_at": "2024-01-24T00:07:44Z"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                  "created_at": "2024-01-24T00:07:44Z",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "delivery_days": 2,
                                                                                                                                                  "est_delivery_days": 2,
                                                                                                                                                  "id": "rate_ea6e4920d07142f694e8d81a89fe3cd1",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "list_rate": 10.89,
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "rate": 7.33,
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "retail_rate": 15.2,
                                                                                                                                                  "service": "Priority",
                                                                                                                                                  "shipment_id": "shp_91721066728d473999b736a0d3f88ce8",
                                                                                                                                                  "time_in_transit": {
                                                                                                                                                    "percentile_50": 1,
                                                                                                                                                    "percentile_75": 2,
                                                                                                                                                    "percentile_85": 2,
                                                                                                                                                    "percentile_90": 2,
                                                                                                                                                    "percentile_95": 3,
                                                                                                                                                    "percentile_97": 3,
                                                                                                                                                    "percentile_99": 3
                                                                                                                                                  },
                                                                                                                                                  "updated_at": "2024-01-24T00:07:44Z"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                  "created_at": "2024-01-24T00:07:44Z",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "id": "rate_26cb7b0f451e407db3adddb432a38b19",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "list_rate": 9.41,
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "rate": 6.79,
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "retail_rate": 13.15,
                                                                                                                                                  "service": "GroundAdvantage",
                                                                                                                                                  "shipment_id": "shp_91721066728d473999b736a0d3f88ce8",
                                                                                                                                                  "time_in_transit": {
                                                                                                                                                    "percentile_50": 1,
                                                                                                                                                    "percentile_75": 2,
                                                                                                                                                    "percentile_85": 2,
                                                                                                                                                    "percentile_90": 2,
                                                                                                                                                    "percentile_95": 3,
                                                                                                                                                    "percentile_97": 3,
                                                                                                                                                    "percentile_99": 4
                                                                                                                                                  },
                                                                                                                                                  "updated_at": "2024-01-24T00:07:44Z"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                  "created_at": "2024-01-24T00:07:44Z",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "id": "rate_3e9facc8738d41ecb3ff17b9c75d6669",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "list_rate": 9.41,
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "rate": 6.79,
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "retail_rate": 13.15,
                                                                                                                                                  "service": "First",
                                                                                                                                                  "shipment_id": "shp_91721066728d473999b736a0d3f88ce8",
                                                                                                                                                  "time_in_transit": {
                                                                                                                                                    "percentile_50": 1,
                                                                                                                                                    "percentile_75": 2,
                                                                                                                                                    "percentile_85": 2,
                                                                                                                                                    "percentile_90": 2,
                                                                                                                                                    "percentile_95": 3,
                                                                                                                                                    "percentile_97": 3,
                                                                                                                                                    "percentile_99": 4
                                                                                                                                                  },
                                                                                                                                                  "updated_at": "2024-01-24T00:07:44Z"
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "carrier": "USPS",
                                                                                                                                                  "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                  "created_at": "2024-01-24T00:07:44Z",
                                                                                                                                                  "currency": "USD",
                                                                                                                                                  "delivery_date": null,
                                                                                                                                                  "delivery_date_guaranteed": false,
                                                                                                                                                  "delivery_days": 3,
                                                                                                                                                  "est_delivery_days": 3,
                                                                                                                                                  "id": "rate_c40cd28b908141649d8b66c4189266e0",
                                                                                                                                                  "list_currency": "USD",
                                                                                                                                                  "list_rate": 9.41,
                                                                                                                                                  "mode": "test",
                                                                                                                                                  "object": "Rate",
                                                                                                                                                  "rate": 6.79,
                                                                                                                                                  "retail_currency": "USD",
                                                                                                                                                  "retail_rate": 13.15,
                                                                                                                                                  "service": "ParcelSelect",
                                                                                                                                                  "shipment_id": "shp_91721066728d473999b736a0d3f88ce8",
                                                                                                                                                  "time_in_transit": {
                                                                                                                                                    "percentile_50": 1,
                                                                                                                                                    "percentile_75": 2,
                                                                                                                                                    "percentile_85": 2,
                                                                                                                                                    "percentile_90": 2,
                                                                                                                                                    "percentile_95": 3,
                                                                                                                                                    "percentile_97": 3,
                                                                                                                                                    "percentile_99": 4
                                                                                                                                                  },
                                                                                                                                                  "updated_at": "2024-01-24T00:07:44Z"
                                                                                                                                                }
                                                                                                                                              ]
                                                                                                                                            }
                                                                                                                                            GET/shipments/:id/smartrate/delivery_date

                                                                                                                                            Retrieve Estimated Delivery Date and Total Transit Days across all Rates for a Shipment

                                                                                                                                            The Delivery Date endpoint of the SmartRate API will return an EasyPost Estimated Delivery Date as well as a Days in Transit object that contains the expected number of total days the shipment is to be in transit across a variety of percentiles for every Rate for a given Shipment. Transit days are calculated as the number of days (including weekends and holidays) between the first time the carrier acknowledges possession of the Shipment and the first out-for-delivery attempt.

                                                                                                                                            This endpoint requires the parameter planned_ship_date to be provided when called. Planned Ship Date is the date that the user would expect the carrier to take possession of the shipment. Knowing this makes the results of the API extremely accurate.

                                                                                                                                            Example
                                                                                                                                            <?php
                                                                                                                                            
                                                                                                                                            $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                                            
                                                                                                                                            $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                                            
                                                                                                                                            $estimatedDeliveryDates = $client->shipment->retrieveEstimatedDeliveryDate($shipment->id, 'YYYY-MM-DD');
                                                                                                                                            
                                                                                                                                            echo $estimatedDeliveryDates;
                                                                                                                                            {
                                                                                                                                              "rates": [
                                                                                                                                                {
                                                                                                                                                  "easypost_time_in_transit_data": {
                                                                                                                                                    "days_in_transit": {
                                                                                                                                                      "percentile_50": 3,
                                                                                                                                                      "percentile_75": 3,
                                                                                                                                                      "percentile_85": 6,
                                                                                                                                                      "percentile_90": 6,
                                                                                                                                                      "percentile_95": 6,
                                                                                                                                                      "percentile_97": 6,
                                                                                                                                                      "percentile_99": 9
                                                                                                                                                    },
                                                                                                                                                    "easypost_estimated_delivery_date": "2024-01-26",
                                                                                                                                                    "planned_ship_date": "2024-01-24"
                                                                                                                                                  },
                                                                                                                                                  "rate": {
                                                                                                                                                    "carrier": "USPS",
                                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                    "created_at": "2024-01-24T00:07:45Z",
                                                                                                                                                    "currency": "USD",
                                                                                                                                                    "delivery_date": null,
                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                    "delivery_days": 3,
                                                                                                                                                    "est_delivery_days": 3,
                                                                                                                                                    "id": "rate_36a64db214ab4fafaeaaad6855ebf422",
                                                                                                                                                    "list_currency": "USD",
                                                                                                                                                    "list_rate": 9.41,
                                                                                                                                                    "mode": "test",
                                                                                                                                                    "object": "Rate",
                                                                                                                                                    "rate": 6.79,
                                                                                                                                                    "retail_currency": "USD",
                                                                                                                                                    "retail_rate": 13.15,
                                                                                                                                                    "service": "GroundAdvantage",
                                                                                                                                                    "shipment_id": "shp_e3ce96ba8b6745608fe1c419d76b8fb5",
                                                                                                                                                    "updated_at": "2024-01-24T00:07:45Z"
                                                                                                                                                  }
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "easypost_time_in_transit_data": {
                                                                                                                                                    "days_in_transit": {
                                                                                                                                                      "percentile_50": 3,
                                                                                                                                                      "percentile_75": 3,
                                                                                                                                                      "percentile_85": 6,
                                                                                                                                                      "percentile_90": 6,
                                                                                                                                                      "percentile_95": 6,
                                                                                                                                                      "percentile_97": 6,
                                                                                                                                                      "percentile_99": 9
                                                                                                                                                    },
                                                                                                                                                    "easypost_estimated_delivery_date": "2024-01-26",
                                                                                                                                                    "planned_ship_date": "2024-01-24"
                                                                                                                                                  },
                                                                                                                                                  "rate": {
                                                                                                                                                    "carrier": "USPS",
                                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                    "created_at": "2024-01-24T00:07:45Z",
                                                                                                                                                    "currency": "USD",
                                                                                                                                                    "delivery_date": null,
                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                    "delivery_days": 3,
                                                                                                                                                    "est_delivery_days": 3,
                                                                                                                                                    "id": "rate_90170bc6328b46cda598d683828d6ac6",
                                                                                                                                                    "list_currency": "USD",
                                                                                                                                                    "list_rate": 9.41,
                                                                                                                                                    "mode": "test",
                                                                                                                                                    "object": "Rate",
                                                                                                                                                    "rate": 6.79,
                                                                                                                                                    "retail_currency": "USD",
                                                                                                                                                    "retail_rate": 13.15,
                                                                                                                                                    "service": "First",
                                                                                                                                                    "shipment_id": "shp_e3ce96ba8b6745608fe1c419d76b8fb5",
                                                                                                                                                    "updated_at": "2024-01-24T00:07:45Z"
                                                                                                                                                  }
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "easypost_time_in_transit_data": {
                                                                                                                                                    "days_in_transit": {
                                                                                                                                                      "percentile_50": 3,
                                                                                                                                                      "percentile_75": 3,
                                                                                                                                                      "percentile_85": 6,
                                                                                                                                                      "percentile_90": 6,
                                                                                                                                                      "percentile_95": 6,
                                                                                                                                                      "percentile_97": 6,
                                                                                                                                                      "percentile_99": 9
                                                                                                                                                    },
                                                                                                                                                    "easypost_estimated_delivery_date": "2024-01-26",
                                                                                                                                                    "planned_ship_date": "2024-01-24"
                                                                                                                                                  },
                                                                                                                                                  "rate": {
                                                                                                                                                    "carrier": "USPS",
                                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                    "created_at": "2024-01-24T00:07:45Z",
                                                                                                                                                    "currency": "USD",
                                                                                                                                                    "delivery_date": null,
                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                    "delivery_days": 3,
                                                                                                                                                    "est_delivery_days": 3,
                                                                                                                                                    "id": "rate_ca519ed1f83d4a8ebc5c17a1dbe96553",
                                                                                                                                                    "list_currency": "USD",
                                                                                                                                                    "list_rate": 9.41,
                                                                                                                                                    "mode": "test",
                                                                                                                                                    "object": "Rate",
                                                                                                                                                    "rate": 6.79,
                                                                                                                                                    "retail_currency": "USD",
                                                                                                                                                    "retail_rate": 13.15,
                                                                                                                                                    "service": "ParcelSelect",
                                                                                                                                                    "shipment_id": "shp_e3ce96ba8b6745608fe1c419d76b8fb5",
                                                                                                                                                    "updated_at": "2024-01-24T00:07:45Z"
                                                                                                                                                  }
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "easypost_time_in_transit_data": {
                                                                                                                                                    "days_in_transit": {
                                                                                                                                                      "percentile_50": 1,
                                                                                                                                                      "percentile_75": 2,
                                                                                                                                                      "percentile_85": 2,
                                                                                                                                                      "percentile_90": 3,
                                                                                                                                                      "percentile_95": 3,
                                                                                                                                                      "percentile_97": 6,
                                                                                                                                                      "percentile_99": 7
                                                                                                                                                    },
                                                                                                                                                    "easypost_estimated_delivery_date": "2024-01-25",
                                                                                                                                                    "planned_ship_date": "2024-01-24"
                                                                                                                                                  },
                                                                                                                                                  "rate": {
                                                                                                                                                    "carrier": "USPS",
                                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                    "created_at": "2024-01-24T00:07:45Z",
                                                                                                                                                    "currency": "USD",
                                                                                                                                                    "delivery_date": null,
                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                    "delivery_days": null,
                                                                                                                                                    "est_delivery_days": null,
                                                                                                                                                    "id": "rate_30c5c922506445a88b51212c52ac2db3",
                                                                                                                                                    "list_currency": "USD",
                                                                                                                                                    "list_rate": 49.6,
                                                                                                                                                    "mode": "test",
                                                                                                                                                    "object": "Rate",
                                                                                                                                                    "rate": 49.6,
                                                                                                                                                    "retail_currency": "USD",
                                                                                                                                                    "retail_rate": 57.4,
                                                                                                                                                    "service": "Express",
                                                                                                                                                    "shipment_id": "shp_e3ce96ba8b6745608fe1c419d76b8fb5",
                                                                                                                                                    "updated_at": "2024-01-24T00:07:45Z"
                                                                                                                                                  }
                                                                                                                                                },
                                                                                                                                                {
                                                                                                                                                  "easypost_time_in_transit_data": {
                                                                                                                                                    "days_in_transit": {
                                                                                                                                                      "percentile_50": 2,
                                                                                                                                                      "percentile_75": 3,
                                                                                                                                                      "percentile_85": 3,
                                                                                                                                                      "percentile_90": 6,
                                                                                                                                                      "percentile_95": 6,
                                                                                                                                                      "percentile_97": 6,
                                                                                                                                                      "percentile_99": 8
                                                                                                                                                    },
                                                                                                                                                    "easypost_estimated_delivery_date": "2024-01-26",
                                                                                                                                                    "planned_ship_date": "2024-01-24"
                                                                                                                                                  },
                                                                                                                                                  "rate": {
                                                                                                                                                    "carrier": "USPS",
                                                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                                    "created_at": "2024-01-24T00:07:45Z",
                                                                                                                                                    "currency": "USD",
                                                                                                                                                    "delivery_date": null,
                                                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                                                    "delivery_days": 2,
                                                                                                                                                    "est_delivery_days": 2,
                                                                                                                                                    "id": "rate_4d9a5348efb44acbb25d162e1a692cb0",
                                                                                                                                                    "list_currency": "USD",
                                                                                                                                                    "list_rate": 10.89,
                                                                                                                                                    "mode": "test",
                                                                                                                                                    "object": "Rate",
                                                                                                                                                    "rate": 7.33,
                                                                                                                                                    "retail_currency": "USD",
                                                                                                                                                    "retail_rate": 15.2,
                                                                                                                                                    "service": "Priority",
                                                                                                                                                    "shipment_id": "shp_e3ce96ba8b6745608fe1c419d76b8fb5",
                                                                                                                                                    "updated_at": "2024-01-24T00:07:45Z"
                                                                                                                                                  }
                                                                                                                                                }
                                                                                                                                              ]
                                                                                                                                            }

                                                                                                                                            Shipping Insurance

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

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

                                                                                                                                            POST/shipments/:id/insure

                                                                                                                                            Insure a Shipment

                                                                                                                                            Request Parameters
                                                                                                                                            paramexample
                                                                                                                                            amount200.00
                                                                                                                                            Example
                                                                                                                                            <?php
                                                                                                                                            
                                                                                                                                            $client = new \EasyPost\EasyPostClient('EASYPOST_API_KEY');
                                                                                                                                            
                                                                                                                                            $shipment = $client->shipment->retrieve('shp_...');
                                                                                                                                            
                                                                                                                                            $shipmentWithInsurance = $client->shipment->insure(
                                                                                                                                                $shipment->id,
                                                                                                                                                ['amount' => 100]
                                                                                                                                            );
                                                                                                                                            
                                                                                                                                            echo $shipmentWithInsurance;
                                                                                                                                            {
                                                                                                                                              "created_at": "2024-01-24T00:07:39Z",
                                                                                                                                              "is_return": false,
                                                                                                                                              "messages": [],
                                                                                                                                              "mode": "test",
                                                                                                                                              "options": {
                                                                                                                                                "currency": &qu