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.

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
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.Create(
                new Dictionary<string, object>
                {
                    { "street1", "417 MONTGOMERY ST" },
                    { "street2", "FLOOR 5" },
                    { "city", "SAN FRANCISCO" },
                    { "state", "CA" },
                    { "zip", "94104" },
                    { "country", "US" },
                    { "company", "EasyPost" },
                    { "phone", "415-123-4567" },
                }
            );

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "id": "adr_5dacbea44e3f11ed90f5ac1f6bc72124",
  "object": "Address",
  "created_at": "2022-10-17T17:15:57+00:00",
  "updated_at": "2022-10-17T17:15:57+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": {}
}
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.CreateAndVerify(
                new Dictionary<string, object>
                {
                    { "street1", "417 Montgomery Street" },
                    { "street2", "FL 5" },
                    { "city", "San Francisco" },
                    { "state", "CA" },
                    { "zip", "94104" },
                    { "country", "US" },
                    { "company", "EasyPost" },
                    { "phone", "415-123-4567" },
                }
            );

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "address": {
    "id": "adr_5e891acf4e3f11edb1a1ac1f6bc7bdc6",
    "object": "Address",
    "created_at": "2022-10-17T17:15:59+00:00",
    "updated_at": "2022-10-17T17:15:59+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": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": null
      },
      "delivery": {
        "success": true,
        "errors": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": {
          "latitude": 37.79342,
          "longitude": -122.40288,
          "time_zone": "America/Los_Angeles"
        }
      }
    }
  }
}
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.Create(
                new Dictionary<string, object>
                {
                    { "street1", "417 MONTGOMERY ST" },
                    { "street2", "FLOOR 5" },
                    { "city", "SAN FRANCISCO" },
                    { "state", "CA" },
                    { "zip", "94104" },
                    { "country", "US" },
                    { "company", "EasyPost" },
                    { "phone", "415-123-4567" },
                    { "verify", true }
                }
            );

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "id": "adr_5eed63904e3f11eda352ac1f6bc7b362",
  "object": "Address",
  "created_at": "2022-10-17T17:16:00+00:00",
  "updated_at": "2022-10-17T17:16:00+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": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": true,
      "errors": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": {
        "latitude": 37.79342,
        "longitude": -122.40288,
        "time_zone": "America/Los_Angeles"
      }
    }
  }
}
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.Create(
                new Dictionary<string, object>
                {
                    { "street1", "UNDELIVERABLE ST" },
                    { "city", "SAN FRANCISCO" },
                    { "state", "CA" },
                    { "zip", "94104" },
                    { "country", "US" },
                    { "company", "EasyPost" },
                    { "phone", "415-123-4567" },
                }
            );

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "id": "adr_20a96bfd554911ed9551ac1f6bc72124",
  "object": "Address",
  "created_at": "2022-10-26T16:13:28+00:00",
  "updated_at": "2022-10-26T16:13:28+00:00",
  "name": null,
  "company": "EasyPost",
  "street1": "UNDELIVERABLE ST",
  "street2": null,
  "city": "SAN FRANCISCO",
  "state": "CA",
  "zip": "94104",
  "country": "US",
  "phone": "4151234567",
  "email": null,
  "mode": "test",
  "carrier_facility": null,
  "residential": null,
  "federal_tax_id": null,
  "state_tax_id": null,
  "verifications": {
    "zip4": {
      "success": false,
      "errors": [
        {
          "code": "E.ADDRESS.NOT_FOUND",
          "field": "address",
          "message": "Address not found",
          "suggestion": null
        },
        {
          "code": "E.HOUSE_NUMBER.MISSING",
          "field": "street1",
          "message": "House number is missing",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": false,
      "errors": [
        {
          "code": "E.ADDRESS.NOT_FOUND",
          "field": "address",
          "message": "Address not found",
          "suggestion": null
        },
        {
          "code": "E.HOUSE_NUMBER.MISSING",
          "field": "street1",
          "message": "House number is missing",
          "suggestion": null
        }
      ],
      "details": {}
    }
  }
}
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.Create(
                new Dictionary<string, object>
                {
                    { "street1", "417 MONTGOMERY ST" },
                    { "street2", "FLOOR 5" },
                    { "city", "SAN FRANCISCO" },
                    { "state", "CA" },
                    { "zip", "94104" },
                    { "country", "US" },
                    { "company", "EasyPost" },
                    { "phone", "415-123-4567" },
                    { "verify_strict", true }
                }
            );

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "id": "adr_5f4e008e4e3f11eda36cac1f6bc7b362",
  "object": "Address",
  "created_at": "2022-10-17T17:16:00+00:00",
  "updated_at": "2022-10-17T17:16:00+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": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": null
    },
    "delivery": {
      "success": true,
      "errors": [
        {
          "code": "E.SECONDARY_INFORMATION.INVALID",
          "field": "street2",
          "message": "Invalid secondary information(Apt/Suite#)",
          "suggestion": null
        }
      ],
      "details": {
        "latitude": 37.79342,
        "longitude": -122.40288,
        "time_zone": "America/Los_Angeles"
      }
    }
  }
}
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.Retrieve("adr_...");

            await address.Verify();

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "address": {
    "id": "adr_5fdd21764e3f11edadebac1f6b0a0d1e",
    "object": "Address",
    "created_at": "2022-10-17T17:16:01+00:00",
    "updated_at": "2022-10-17T17:16:01+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": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "details": null
      },
      "delivery": {
        "success": true,
        "errors": [
          {
            "code": "E.SECONDARY_INFORMATION.INVALID",
            "field": "street2",
            "message": "Invalid secondary information(Apt/Suite#)",
            "suggestion": null
          }
        ],
        "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
page_size30The number of records to return on each page. The maximum value is 100, and default is 20.
Example
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            AddressCollection addressCollection = await client.Address.All(new Dictionary<string, object>
                {
                    { "page_size", 5 }
                }
            );

            Console.WriteLine(JsonConvert.SerializeObject(addressCollection, Formatting.Indented));
        }
    }
}
{
  "addresses": [
    {
      "id": "adr_6039af864e3f11edae1dac1f6b0a0d1e",
      "object": "Address",
      "created_at": "2022-10-17T17:16:02+00:00",
      "updated_at": "2022-10-17T17:16:02+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
using System;
using System.Collections.Generic;
using System.Threading.Tasks;
using Newtonsoft.Json;
using EasyPost;
using EasyPost.Models.API;

namespace EasyPostExamples
{
    public class Examples
    {
        public static async Task Main()
        {
            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;

            var client = new EasyPost.Client(apiKey);

            Address address = await client.Address.Retrieve("adr_...");

            Console.WriteLine(JsonConvert.SerializeObject(address, Formatting.Indented));
        }
    }
}
{
  "id": "adr_6039af864e3f11edae1dac1f6b0a0d1e",
  "object": "Address",
  "created_at": "2022-10-17T17:16:02+00:00",
  "updated_at": "2022-10-17T17:16:02+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.

Amazon MWS

No predefined packages for Amazon MWS.

    APC

    No predefined packages for APC.

      Asendia USA

      No predefined packages for Asendia USA.

        Australia Post

        No predefined packages for Australia Post.

          AxlehireV3

          No predefined packages for AxlehireV3.

            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.

                      CloudSort

                      No predefined packages for CloudSort.

                        Courier Express

                        No predefined packages for Courier Express.

                          Couriers Please

                          No predefined packages for Couriers Please.

                            DAI Post

                            No predefined packages for DAI Post.

                              DeliverIt

                              No predefined packages for DeliverIt.

                                Deutsche Post

                                No predefined packages for Deutsche Post.

                                  Deutsche Post UK

                                  No predefined packages for Deutsche Post UK.

                                    DHL eCommerce Asia

                                    No predefined packages for DHL eCommerce Asia.

                                      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.

                                          DHL SmartMail

                                          No predefined packages for DHL SmartMail.

                                            DPD

                                            No predefined packages for DPD.

                                              DPDUK
                                              • Parcel
                                              • Pallet
                                              • ExpressPak
                                              • FreightParcel
                                              • Freight
                                              ePostGlobal

                                              No predefined packages for ePostGlobal.

                                                Estafeta
                                                • ENVELOPE
                                                • PARCEL
                                                Evri

                                                No predefined packages for Evri.

                                                  Fastway
                                                  • Parcel
                                                  • A2 (Satchel)
                                                  • A3 (Satchel)
                                                  • A4 (Satchel, not available in Australia)
                                                  • A5 (Satchel, not available in South Africa)
                                                  • BOXSML
                                                  • BOXMED
                                                  • BOXLRG
                                                  FedEx
                                                  • FedExEnvelope
                                                  • FedExBox
                                                  • FedExPak
                                                  • FedExTube
                                                  • FedEx10kgBox
                                                  • FedEx25kgBox
                                                  • FedExSmallBox
                                                  • FedExMediumBox
                                                  • FedExLargeBox
                                                  • FedExExtraLargeBox
                                                  FedEx Cross Border

                                                  No predefined packages for FedEx Cross Border.

                                                    FedEx Mailview

                                                    No predefined packages for FedEx Mailview.

                                                      FedEx SmartPost

                                                      No predefined packages for FedEx SmartPost.

                                                        FirstMile

                                                        No predefined packages for FirstMile.

                                                          GSO

                                                          No predefined packages for GSO.

                                                            Hailify

                                                            No predefined packages for Hailify.

                                                              Interlink Express
                                                              • Parcel
                                                              • Pallet
                                                              • ExpressPak
                                                              • FreightParcel
                                                              • Freight
                                                              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
                                                                              Parcelforce

                                                                              No predefined packages for Parcelforce.

                                                                                PARCLL

                                                                                No predefined packages for PARCLL.

                                                                                  Passport

                                                                                  No predefined packages for Passport.

                                                                                    PostNL

                                                                                    No predefined packages for PostNL.

                                                                                      Purolator
                                                                                      • CUSTOMERPACKAGING
                                                                                      • EXPRESSPACK
                                                                                      • EXPRESSBOX
                                                                                      • EXPRESSENVELOPE
                                                                                      Royal Mail
                                                                                      • Letter
                                                                                      • LargeLetter
                                                                                      • SmallParcel
                                                                                      • MediumParcel
                                                                                      • Parcel (for use with RoyalMail24 or RoyalMail48)
                                                                                      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
                                                                                                            • FlatRateGiftCardEnvelope
                                                                                                            • 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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Parcel parcel = await client.Parcel.Create(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                { "length", 20.2 },
                                                                                                                                { "width", 10.9 },
                                                                                                                                { "height", 5 },
                                                                                                                                { "weight", 65.9 }
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(parcel, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "id": "prcl_f1e15ba5892749e2a039a70b4d83d5d1",
                                                                                                                  "object": "Parcel",
                                                                                                                  "created_at": "2022-10-17T17:17:08Z",
                                                                                                                  "updated_at": "2022-10-17T17:17:08Z",
                                                                                                                  "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Parcel parcel = await client.Parcel.Retrieve("prcl_...");
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(parcel, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "id": "prcl_76ca5e21f413474bad2ae2086ba902ae",
                                                                                                                  "object": "Parcel",
                                                                                                                  "created_at": "2022-10-17T17:17:08Z",
                                                                                                                  "updated_at": "2022-10-17T17:17:08Z",
                                                                                                                  "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 unique reference for this Insurance, if any
                                                                                                                amountstringUSD value of insured goods with sub-cent precision
                                                                                                                providerstringThe insurance provider used by EasyPost
                                                                                                                provider_idstringAn identifying number for some insurance providers used by EasyPost
                                                                                                                shipment_idstringThe ID of the Shipment in EasyPost, if postage was purchased via EasyPost
                                                                                                                tracking_codestringThe tracking code of either the shipment within EasyPost, or provided by you during creation
                                                                                                                statusstringThe current status of the insurance, possible values are "new", "pending", "purchased", "failed", or "cancelled"
                                                                                                                trackerTrackerThe associated Tracker object
                                                                                                                to_addressAddressThe associated Address object for destination
                                                                                                                from_addressAddressThe associated Address object for origin
                                                                                                                feeFeeThe associated InsuranceFee object if any
                                                                                                                messagesArray of stringsThe list of errors encountered during attempted purchase of the insurance
                                                                                                                created_atdatetime
                                                                                                                updated_atdatetime
                                                                                                                POST/insurances

                                                                                                                Create an Insurance

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

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

                                                                                                                Request Parameters
                                                                                                                paramexampleinfo
                                                                                                                to_addressAddressThe destination of the package to be insured.
                                                                                                                from_addressAddressThe origin of the package to be insured.
                                                                                                                tracking_code9400110898825022579493The tracking code associated with the non-EasyPost-purchased package you'd like to insure.
                                                                                                                referenceexternal-order-493Optional. A unique value that may be used in place of ID when doing Retrieve calls for this insurance.
                                                                                                                amount"$100.00"The USD value of contents you would like to insure. Currently the maximum is $5000.
                                                                                                                carrierUSPSThe carrier associated with the tracking_code you provided. The carrier will get auto-detected if none is provided.
                                                                                                                Example
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Insurance insurance = await client.Insurance.Create(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                {
                                                                                                                                    "to_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "adr_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "from_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "adr_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                { "tracking_code", "9400110898825022579493" },
                                                                                                                                { "carrier", "USPS" },
                                                                                                                                { "reference", "InsuranceRef1" },
                                                                                                                                { "amount", "100.00" }
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(insurance, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "id": "ins_7609b3212565474389a311ce8ff70c78",
                                                                                                                  "object": "Insurance",
                                                                                                                  "mode": "test",
                                                                                                                  "reference": null,
                                                                                                                  "status": "pending",
                                                                                                                  "amount": "100.00000",
                                                                                                                  "provider": "easypost",
                                                                                                                  "provider_id": null,
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_e0e4047f4e4311ed9b74ac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:48:16+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:48:16+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_e0e89e564e4311eda48eac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:48:16+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:48:16+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": [
                                                                                                                          {
                                                                                                                            "code": "E.SECONDARY_INFORMATION.INVALID",
                                                                                                                            "field": "street2",
                                                                                                                            "message": "Invalid secondary information(Apt/Suite#)",
                                                                                                                            "suggestion": null
                                                                                                                          }
                                                                                                                        ],
                                                                                                                        "details": null
                                                                                                                      },
                                                                                                                      "delivery": {
                                                                                                                        "success": true,
                                                                                                                        "errors": [
                                                                                                                          {
                                                                                                                            "code": "E.SECONDARY_INFORMATION.INVALID",
                                                                                                                            "field": "street2",
                                                                                                                            "message": "Invalid secondary information(Apt/Suite#)",
                                                                                                                            "suggestion": null
                                                                                                                          }
                                                                                                                        ],
                                                                                                                        "details": {
                                                                                                                          "latitude": 37.79342,
                                                                                                                          "longitude": -122.40288,
                                                                                                                          "time_zone": "America/Los_Angeles"
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  },
                                                                                                                  "shipment_id": null,
                                                                                                                  "tracker": null,
                                                                                                                  "tracking_code": "9400110898825022579493",
                                                                                                                  "fee": {
                                                                                                                    "object": "Fee",
                                                                                                                    "type": "InsuranceFee",
                                                                                                                    "amount": "0.50000",
                                                                                                                    "charged": true,
                                                                                                                    "refunded": false
                                                                                                                  },
                                                                                                                  "messages": [],
                                                                                                                  "created_at": "2022-10-17T17:48:16Z",
                                                                                                                  "updated_at": "2022-10-17T17:48:16Z"
                                                                                                                }
                                                                                                                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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            InsuranceCollection insuranceCollection = await client.Insurance.All(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                { "page_size", 5 }
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(insuranceCollection, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "insurances": [
                                                                                                                    {
                                                                                                                      "id": "ins_eb937fd125c4495986d33ab14d175952",
                                                                                                                      "object": "Insurance",
                                                                                                                      "mode": "test",
                                                                                                                      "reference": "insuranceRef1",
                                                                                                                      "status": "pending",
                                                                                                                      "amount": "100.00000",
                                                                                                                      "provider": "easypost",
                                                                                                                      "provider_id": null,
                                                                                                                      "to_address": {
                                                                                                                        "id": "adr_91a042464be811ed9d0fac1f6b0a0d1e",
                                                                                                                        "object": "Address",
                                                                                                                        "created_at": "2022-10-14T17:49:36+00:00",
                                                                                                                        "updated_at": "2022-10-14T17:49: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"
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      },
                                                                                                                      "from_address": {
                                                                                                                        "id": "adr_91a4575b4be811edab5aac1f6bc7b362",
                                                                                                                        "object": "Address",
                                                                                                                        "created_at": "2022-10-14T17:49:36+00:00",
                                                                                                                        "updated_at": "2022-10-14T17:49:36+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": [
                                                                                                                              {
                                                                                                                                "code": "E.SECONDARY_INFORMATION.INVALID",
                                                                                                                                "field": "street2",
                                                                                                                                "message": "Invalid secondary information(Apt/Suite#)",
                                                                                                                                "suggestion": null
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "details": null
                                                                                                                          },
                                                                                                                          "delivery": {
                                                                                                                            "success": true,
                                                                                                                            "errors": [
                                                                                                                              {
                                                                                                                                "code": "E.SECONDARY_INFORMATION.INVALID",
                                                                                                                                "field": "street2",
                                                                                                                                "message": "Invalid secondary information(Apt/Suite#)",
                                                                                                                                "suggestion": null
                                                                                                                              }
                                                                                                                            ],
                                                                                                                            "details": {
                                                                                                                              "latitude": 37.79342,
                                                                                                                              "longitude": -122.40288,
                                                                                                                              "time_zone": "America/Los_Angeles"
                                                                                                                            }
                                                                                                                          }
                                                                                                                        }
                                                                                                                      },
                                                                                                                      "shipment_id": null,
                                                                                                                      "tracker": null,
                                                                                                                      "tracking_code": "9400110898825022579493",
                                                                                                                      "fee": {
                                                                                                                        "object": "Fee",
                                                                                                                        "type": "InsuranceFee",
                                                                                                                        "amount": "0.50000",
                                                                                                                        "charged": true,
                                                                                                                        "refunded": false
                                                                                                                      },
                                                                                                                      "messages": [],
                                                                                                                      "created_at": "2022-10-14T17:49:36Z",
                                                                                                                      "updated_at": "2022-10-14T17:49:36Z"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "has_more": false
                                                                                                                }
                                                                                                                GET/insurances/:id

                                                                                                                Retrieve an Insurance

                                                                                                                Retrieve an Insurance by id.

                                                                                                                Request Parameters
                                                                                                                paramexampleinfo
                                                                                                                idins_...Unique, starts with "ins_"
                                                                                                                Example
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Insurance insurance = await client.Insurance.Retrieve("ins_...");
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(insurance, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "id": "ins_eb937fd125c4495986d33ab14d175952",
                                                                                                                  "object": "Insurance",
                                                                                                                  "mode": "test",
                                                                                                                  "reference": "insuranceRef1",
                                                                                                                  "status": "pending",
                                                                                                                  "amount": "100.00000",
                                                                                                                  "provider": "easypost",
                                                                                                                  "provider_id": null,
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_91a042464be811ed9d0fac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-14T17:49:36+00:00",
                                                                                                                    "updated_at": "2022-10-14T17:49: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"
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  },
                                                                                                                  "from_address": {
                                                                                                                    "id": "adr_91a4575b4be811edab5aac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-14T17:49:36+00:00",
                                                                                                                    "updated_at": "2022-10-14T17:49:36+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": [
                                                                                                                          {
                                                                                                                            "code": "E.SECONDARY_INFORMATION.INVALID",
                                                                                                                            "field": "street2",
                                                                                                                            "message": "Invalid secondary information(Apt/Suite#)",
                                                                                                                            "suggestion": null
                                                                                                                          }
                                                                                                                        ],
                                                                                                                        "details": null
                                                                                                                      },
                                                                                                                      "delivery": {
                                                                                                                        "success": true,
                                                                                                                        "errors": [
                                                                                                                          {
                                                                                                                            "code": "E.SECONDARY_INFORMATION.INVALID",
                                                                                                                            "field": "street2",
                                                                                                                            "message": "Invalid secondary information(Apt/Suite#)",
                                                                                                                            "suggestion": null
                                                                                                                          }
                                                                                                                        ],
                                                                                                                        "details": {
                                                                                                                          "latitude": 37.79342,
                                                                                                                          "longitude": -122.40288,
                                                                                                                          "time_zone": "America/Los_Angeles"
                                                                                                                        }
                                                                                                                      }
                                                                                                                    }
                                                                                                                  },
                                                                                                                  "shipment_id": null,
                                                                                                                  "tracker": null,
                                                                                                                  "tracking_code": "9400110898825022579493",
                                                                                                                  "fee": {
                                                                                                                    "object": "Fee",
                                                                                                                    "type": "InsuranceFee",
                                                                                                                    "amount": "0.50000",
                                                                                                                    "charged": true,
                                                                                                                    "refunded": false
                                                                                                                  },
                                                                                                                  "messages": [],
                                                                                                                  "created_at": "2022-10-14T17:49:36Z",
                                                                                                                  "updated_at": "2022-10-14T17:49:36Z"
                                                                                                                }

                                                                                                                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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            // Create a shipment using all data in one API call
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Create(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                {
                                                                                                                                    "to_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "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" }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "from_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "name", "EasyPost" },
                                                                                                                                        { "street1", "417 Montgomery Street" },
                                                                                                                                        { "street2", "5th Floor" },
                                                                                                                                        { "city", "San Francisco" },
                                                                                                                                        { "state", "CA" },
                                                                                                                                        { "zip", "94104" },
                                                                                                                                        { "country", "US" },
                                                                                                                                        { "phone", "4153334445" },
                                                                                                                                        { "email", "support@easypost.com" }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "parcel", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "length", 20.2 },
                                                                                                                                        { "width", 10.9 },
                                                                                                                                        { "height", 5 },
                                                                                                                                        { "weight", 65.9 }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "customs_info", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "cstinfo_..." }
                                                                                                                                    }
                                                                                                                                }
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                
                                                                                                                            // Create a shipment using ids of existing data
                                                                                                                
                                                                                                                            Shipment shipmentWithIds = await client.Shipment.Create(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                {
                                                                                                                                    "to_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "adr_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "from_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "adr_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "parcel", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "prcl_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "customs_info", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "cstinfo_..." }
                                                                                                                                    }
                                                                                                                                }
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipmentWithIds, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:17:41Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": null,
                                                                                                                  "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_6210b433c0e3434a863bfa3731e4d986",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:17:41Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                    "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_a3fcadc30f8f48e0bbe15bc8cc00d41f",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:17:41Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                        "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_9b7dc4824e3f11edba96ac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:41+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:41+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_b60c57c34057409daa33d9acf2c032f7",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:17:41Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": null,
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_aacff1509904422ca4b079fea6926895",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:41Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_490d50bd449442edb36f75e2937b32e8",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_1f68017479ff441f8e68459b6df507bf",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:41Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_490d50bd449442edb36f75e2937b32e8",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_f8cdad8cbf044c318a15a04c21b33dc6",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:41Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:41Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_490d50bd449442edb36f75e2937b32e8",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": null,
                                                                                                                  "tracker": null,
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_9b7b32c54e3f11eda8b8ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:41+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:41+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_9b7dc4824e3f11edba96ac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:41+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:41+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_9b7b32c54e3f11eda8b8ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:41+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:41+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_490d50bd449442edb36f75e2937b32e8",
                                                                                                                  "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Dictionary<string, object> listParams = new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                { "page_size", 5 }
                                                                                                                            };
                                                                                                                
                                                                                                                            ShipmentCollection shipmentCollection = await client.Shipment.All(listParams);
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipmentCollection, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "shipments": [
                                                                                                                    {
                                                                                                                      "created_at": "2022-10-17T17:17:38Z",
                                                                                                                      "is_return": false,
                                                                                                                      "messages": [],
                                                                                                                      "mode": "test",
                                                                                                                      "options": {
                                                                                                                        "currency": "USD",
                                                                                                                        "payment": {
                                                                                                                          "type": "SENDER"
                                                                                                                        },
                                                                                                                        "date_advance": 0
                                                                                                                      },
                                                                                                                      "reference": null,
                                                                                                                      "status": "unknown",
                                                                                                                      "tracking_code": "9405500106068143632993",
                                                                                                                      "updated_at": "2022-10-17T17:17:39Z",
                                                                                                                      "batch_id": "batch_879633ae98a847409f0ca5b22c9872f4",
                                                                                                                      "batch_status": "postage_purchased",
                                                                                                                      "batch_message": null,
                                                                                                                      "customs_info": {
                                                                                                                        "id": "cstinfo_f85189b578ec4706ac387b76cec7ff01",
                                                                                                                        "object": "CustomsInfo",
                                                                                                                        "created_at": "2022-10-17T17:17:38Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:38Z",
                                                                                                                        "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_fa0aa9aa3a8f41639295c10aa7469480",
                                                                                                                            "object": "CustomsItem",
                                                                                                                            "created_at": "2022-10-17T17:17:38Z",
                                                                                                                            "updated_at": "2022-10-17T17:17:38Z",
                                                                                                                            "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_99962d534e3f11ed846dac1f6b0a0d1e",
                                                                                                                        "object": "Address",
                                                                                                                        "created_at": "2022-10-17T17:17:38+00:00",
                                                                                                                        "updated_at": "2022-10-17T17:17:38+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_fda3e370c180461f9bfe8cb4fc23d597",
                                                                                                                        "object": "Parcel",
                                                                                                                        "created_at": "2022-10-17T17:17:38Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:38Z",
                                                                                                                        "length": 20.2,
                                                                                                                        "width": 10.9,
                                                                                                                        "height": 5.0,
                                                                                                                        "predefined_package": null,
                                                                                                                        "weight": 65.9,
                                                                                                                        "mode": "test"
                                                                                                                      },
                                                                                                                      "postage_label": {
                                                                                                                        "object": "PostageLabel",
                                                                                                                        "id": "pl_109fa1307e564ecf882511518dd939a4",
                                                                                                                        "created_at": "2022-10-17T17:17:39Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:39Z",
                                                                                                                        "date_advance": 0,
                                                                                                                        "integrated_form": "none",
                                                                                                                        "label_date": "2022-10-17T17:17:39Z",
                                                                                                                        "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/20221017/f75dd1254c51419cbaed4ac0e715f088.png",
                                                                                                                        "label_pdf_url": null,
                                                                                                                        "label_zpl_url": null,
                                                                                                                        "label_epl2_url": null,
                                                                                                                        "label_file": null
                                                                                                                      },
                                                                                                                      "rates": [
                                                                                                                        {
                                                                                                                          "id": "rate_4d47535e18b14ccbad227fd5ce970e2c",
                                                                                                                          "object": "Rate",
                                                                                                                          "created_at": "2022-10-17T17:17:38Z",
                                                                                                                          "updated_at": "2022-10-17T17:17:38Z",
                                                                                                                          "mode": "test",
                                                                                                                          "service": "Express",
                                                                                                                          "carrier": "USPS",
                                                                                                                          "rate": "44.55",
                                                                                                                          "currency": "USD",
                                                                                                                          "retail_rate": "51.30",
                                                                                                                          "retail_currency": "USD",
                                                                                                                          "list_rate": "44.55",
                                                                                                                          "list_currency": "USD",
                                                                                                                          "billing_type": "easypost",
                                                                                                                          "delivery_days": null,
                                                                                                                          "delivery_date": null,
                                                                                                                          "delivery_date_guaranteed": false,
                                                                                                                          "est_delivery_days": null,
                                                                                                                          "shipment_id": "shp_8829ca7df9694a0eb625f2a74dee5220",
                                                                                                                          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                        },
                                                                                                                        {
                                                                                                                          "id": "rate_f4e803e1bb124f7ba4832732a493d48b",
                                                                                                                          "object": "Rate",
                                                                                                                          "created_at": "2022-10-17T17:17:38Z",
                                                                                                                          "updated_at": "2022-10-17T17:17:38Z",
                                                                                                                          "mode": "test",
                                                                                                                          "service": "ParcelSelect",
                                                                                                                          "carrier": "USPS",
                                                                                                                          "rate": "9.16",
                                                                                                                          "currency": "USD",
                                                                                                                          "retail_rate": "9.16",
                                                                                                                          "retail_currency": "USD",
                                                                                                                          "list_rate": "9.16",
                                                                                                                          "list_currency": "USD",
                                                                                                                          "billing_type": "easypost",
                                                                                                                          "delivery_days": 5,
                                                                                                                          "delivery_date": null,
                                                                                                                          "delivery_date_guaranteed": false,
                                                                                                                          "est_delivery_days": 5,
                                                                                                                          "shipment_id": "shp_8829ca7df9694a0eb625f2a74dee5220",
                                                                                                                          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                        },
                                                                                                                        {
                                                                                                                          "id": "rate_9e54918857a54c9192e46a7c5ea488d8",
                                                                                                                          "object": "Rate",
                                                                                                                          "created_at": "2022-10-17T17:17:38Z",
                                                                                                                          "updated_at": "2022-10-17T17:17:38Z",
                                                                                                                          "mode": "test",
                                                                                                                          "service": "Priority",
                                                                                                                          "carrier": "USPS",
                                                                                                                          "rate": "10.07",
                                                                                                                          "currency": "USD",
                                                                                                                          "retail_rate": "13.45",
                                                                                                                          "retail_currency": "USD",
                                                                                                                          "list_rate": "10.07",
                                                                                                                          "list_currency": "USD",
                                                                                                                          "billing_type": "easypost",
                                                                                                                          "delivery_days": 2,
                                                                                                                          "delivery_date": null,
                                                                                                                          "delivery_date_guaranteed": false,
                                                                                                                          "est_delivery_days": 2,
                                                                                                                          "shipment_id": "shp_8829ca7df9694a0eb625f2a74dee5220",
                                                                                                                          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                        }
                                                                                                                      ],
                                                                                                                      "refund_status": null,
                                                                                                                      "scan_form": {
                                                                                                                        "id": "sf_3684195c590740a88bc2c2cf5f25acb1",
                                                                                                                        "object": "ScanForm",
                                                                                                                        "created_at": "2022-10-17T17:17:39Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:40Z",
                                                                                                                        "tracking_codes": ["9405500106068143632993"],
                                                                                                                        "address": {
                                                                                                                          "id": "adr_99962d534e3f11ed846dac1f6b0a0d1e",
                                                                                                                          "object": "Address",
                                                                                                                          "created_at": "2022-10-17T17:17:38+00:00",
                                                                                                                          "updated_at": "2022-10-17T17:17:38+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/20221017/58d6eef422424d02bd4105029666d614.pdf",
                                                                                                                        "form_file_type": null,
                                                                                                                        "batch_id": "batch_879633ae98a847409f0ca5b22c9872f4",
                                                                                                                        "confirmation": null
                                                                                                                      },
                                                                                                                      "selected_rate": {
                                                                                                                        "id": "rate_9e54918857a54c9192e46a7c5ea488d8",
                                                                                                                        "object": "Rate",
                                                                                                                        "created_at": "2022-10-17T17:17:39Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:39Z",
                                                                                                                        "mode": "test",
                                                                                                                        "service": "Priority",
                                                                                                                        "carrier": "USPS",
                                                                                                                        "rate": "10.07",
                                                                                                                        "currency": "USD",
                                                                                                                        "retail_rate": "13.45",
                                                                                                                        "retail_currency": "USD",
                                                                                                                        "list_rate": "10.07",
                                                                                                                        "list_currency": "USD",
                                                                                                                        "billing_type": "easypost",
                                                                                                                        "delivery_days": 2,
                                                                                                                        "delivery_date": null,
                                                                                                                        "delivery_date_guaranteed": false,
                                                                                                                        "est_delivery_days": 2,
                                                                                                                        "shipment_id": "shp_8829ca7df9694a0eb625f2a74dee5220",
                                                                                                                        "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                      },
                                                                                                                      "tracker": {
                                                                                                                        "id": "trk_0f08d178b1a24688a26ffc2f63cfe208",
                                                                                                                        "object": "Tracker",
                                                                                                                        "mode": "test",
                                                                                                                        "tracking_code": "9405500106068143632993",
                                                                                                                        "status": "pre_transit",
                                                                                                                        "status_detail": "status_update",
                                                                                                                        "created_at": "2022-10-17T17:17:39Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:39Z",
                                                                                                                        "signed_by": null,
                                                                                                                        "weight": null,
                                                                                                                        "est_delivery_date": "2022-10-17T17:17:39Z",
                                                                                                                        "shipment_id": "shp_8829ca7df9694a0eb625f2a74dee5220",
                                                                                                                        "carrier": "USPS",
                                                                                                                        "tracking_details": [
                                                                                                                          {
                                                                                                                            "object": "TrackingDetail",
                                                                                                                            "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                            "description": null,
                                                                                                                            "status": "pre_transit",
                                                                                                                            "status_detail": "status_update",
                                                                                                                            "datetime": "2022-09-17T17:17:39Z",
                                                                                                                            "source": "USPS",
                                                                                                                            "carrier_code": null,
                                                                                                                            "tracking_location": {
                                                                                                                              "object": "TrackingLocation",
                                                                                                                              "city": null,
                                                                                                                              "state": null,
                                                                                                                              "country": null,
                                                                                                                              "zip": null
                                                                                                                            }
                                                                                                                          },
                                                                                                                          {
                                                                                                                            "object": "TrackingDetail",
                                                                                                                            "message": "Shipping Label Created",
                                                                                                                            "description": null,
                                                                                                                            "status": "pre_transit",
                                                                                                                            "status_detail": "status_update",
                                                                                                                            "datetime": "2022-09-18T05:54:39Z",
                                                                                                                            "source": "USPS",
                                                                                                                            "carrier_code": null,
                                                                                                                            "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/djE6dHJrXzBmMDhkMTc4YjFhMjQ2ODhhMjZmZmMyZjYzY2ZlMjA4"
                                                                                                                      },
                                                                                                                      "to_address": {
                                                                                                                        "id": "adr_9993766d4e3f11ed846cac1f6b0a0d1e",
                                                                                                                        "object": "Address",
                                                                                                                        "created_at": "2022-10-17T17:17:38+00:00",
                                                                                                                        "updated_at": "2022-10-17T17:17:38+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_99962d534e3f11ed846dac1f6b0a0d1e",
                                                                                                                        "object": "Address",
                                                                                                                        "created_at": "2022-10-17T17:17:38+00:00",
                                                                                                                        "updated_at": "2022-10-17T17:17:38+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_9993766d4e3f11ed846cac1f6b0a0d1e",
                                                                                                                        "object": "Address",
                                                                                                                        "created_at": "2022-10-17T17:17:38+00:00",
                                                                                                                        "updated_at": "2022-10-17T17:17:38+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": "10.07000",
                                                                                                                          "charged": true,
                                                                                                                          "refunded": false
                                                                                                                        }
                                                                                                                      ],
                                                                                                                      "id": "shp_8829ca7df9694a0eb625f2a74dee5220",
                                                                                                                      "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:17:42Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": null,
                                                                                                                  "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_5f7b05526d3249e5885b53e3afa21a9f",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:17:42Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                    "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_40347a18757e4968816283b67cefc761",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:17:42Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                        "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_9bf5f8f14e3f11ed8529ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:42+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:42+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_095ff347886549a593e56ce1c73f613d",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:17:42Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": null,
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_e69a90b917dd40468ee8301dac24f1e2",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:42Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_e77845c40de7492f90be39341d7db2dd",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_6a0c2bbab91b4e25aea107415e96b6cb",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:42Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_e77845c40de7492f90be39341d7db2dd",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_d3d4ffed04c749d39799864b66fa7032",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:42Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:42Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_e77845c40de7492f90be39341d7db2dd",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": null,
                                                                                                                  "tracker": null,
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_9bf3ca7b4e3f11edbac4ac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:42+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:42+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_9bf5f8f14e3f11ed8529ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:42+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:42+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_9bf3ca7b4e3f11edbac4ac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:42+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:42+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_e77845c40de7492f90be39341d7db2dd",
                                                                                                                  "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                
                                                                                                                            Rate rate = shipment.LowestRate();
                                                                                                                
                                                                                                                            await shipment.Buy(rate, "249.99");
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:17:44Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": "9461200106068143633001",
                                                                                                                  "updated_at": "2022-10-17T17:17:45Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_ffaf5dcba179407ba0e02380019ced69",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:17:44Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:44Z",
                                                                                                                    "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_49a9cf18128c4e03a0c7cfa92b77b26a",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:17:44Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:44Z",
                                                                                                                        "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_9d3dddae4e3f11ed85a8ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:44+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:44+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_22c8ed21a7134827964540c187358cef",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:17:44Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:44Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": {
                                                                                                                    "object": "PostageLabel",
                                                                                                                    "id": "pl_07b70ffff0884392b833f14c248b1a61",
                                                                                                                    "created_at": "2022-10-17T17:17:45Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:45Z",
                                                                                                                    "date_advance": 0,
                                                                                                                    "integrated_form": "none",
                                                                                                                    "label_date": "2022-10-17T17:17:45Z",
                                                                                                                    "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/20221017/3e5031aad94d4612a8bf2fba0daa4817.png",
                                                                                                                    "label_pdf_url": null,
                                                                                                                    "label_zpl_url": null,
                                                                                                                    "label_epl2_url": null,
                                                                                                                    "label_file": null
                                                                                                                  },
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_8f746502db64446784d624de2c5120d9",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:44Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:44Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_8daff852bf404a468c14f6562f7125e7",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_77fef8dcfba84374b0b6d967ed4142d2",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:44Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:44Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_8daff852bf404a468c14f6562f7125e7",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_68cf1cddc082457b9b494a52fc3bffe5",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:44Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:44Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_8daff852bf404a468c14f6562f7125e7",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": {
                                                                                                                    "id": "rate_77fef8dcfba84374b0b6d967ed4142d2",
                                                                                                                    "object": "Rate",
                                                                                                                    "created_at": "2022-10-17T17:17:45Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:45Z",
                                                                                                                    "mode": "test",
                                                                                                                    "service": "ParcelSelect",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "rate": "9.16",
                                                                                                                    "currency": "USD",
                                                                                                                    "retail_rate": "9.16",
                                                                                                                    "retail_currency": "USD",
                                                                                                                    "list_rate": "9.16",
                                                                                                                    "list_currency": "USD",
                                                                                                                    "billing_type": "easypost",
                                                                                                                    "delivery_days": 5,
                                                                                                                    "delivery_date": null,
                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                    "est_delivery_days": 5,
                                                                                                                    "shipment_id": "shp_8daff852bf404a468c14f6562f7125e7",
                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                  },
                                                                                                                  "tracker": {
                                                                                                                    "id": "trk_f66007350c014243aca09099ad00ca44",
                                                                                                                    "object": "Tracker",
                                                                                                                    "mode": "test",
                                                                                                                    "tracking_code": "9461200106068143633001",
                                                                                                                    "status": "unknown",
                                                                                                                    "status_detail": "unknown",
                                                                                                                    "created_at": "2022-10-17T17:17:45Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:45Z",
                                                                                                                    "signed_by": null,
                                                                                                                    "weight": null,
                                                                                                                    "est_delivery_date": null,
                                                                                                                    "shipment_id": "shp_8daff852bf404a468c14f6562f7125e7",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "tracking_details": [],
                                                                                                                    "fees": [],
                                                                                                                    "carrier_detail": null,
                                                                                                                    "public_url": "https://track.easypost.com/djE6dHJrX2Y2NjAwNzM1MGMwMTQyNDNhY2EwOTA5OWFkMDBjYTQ0"
                                                                                                                  },
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_9d3bada94e3f11ed85a7ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:44+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:45+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_9d3dddae4e3f11ed85a8ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:44+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:44+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_9d3bada94e3f11ed85a7ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:44+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:45+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": "9.16000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "object": "Fee",
                                                                                                                      "type": "InsuranceFee",
                                                                                                                      "amount": "1.24995",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "id": "shp_8daff852bf404a468c14f6562f7125e7",
                                                                                                                  "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Create(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                {
                                                                                                                                    "to_address", new Dictionary<string, string>()
                                                                                                                                    {
                                                                                                                                        { "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" }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "from_address", new Dictionary<string, string>()
                                                                                                                                    {
                                                                                                                                        { "name", "EasyPost" },
                                                                                                                                        { "street1", "417 Montgomery Street" },
                                                                                                                                        { "street2", "5th Floor" },
                                                                                                                                        { "city", "San Francisco" },
                                                                                                                                        { "state", "CA" },
                                                                                                                                        { "zip", "94104" },
                                                                                                                                        { "country", "US" },
                                                                                                                                        { "phone", "4153334445" },
                                                                                                                                        { "email", "support@easypost.com" }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "parcel", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "length", 20.2 },
                                                                                                                                        { "width", 10.9 },
                                                                                                                                        { "height", 5 },
                                                                                                                                        { "weight", 65.9 }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                { "service", "NextDayAir" },
                                                                                                                                { "carrier_accounts", new List<string>()
                                                                                                                                    {
                                                                                                                                    "ca_..."
                                                                                                                                    }
                                                                                                                                },
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-27T16:55:16Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": "9405500106068145794057",
                                                                                                                  "updated_at": "2022-10-27T16:55:17Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_cd38807b69ff417d849d3b014833b521",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-27T16:55:16Z",
                                                                                                                    "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                    "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_2b2060940fc24c01b728f39d8fcf8dac",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-27T16:55:16Z",
                                                                                                                        "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                        "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_21a919c7561811ed9652ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-27T16:55:16+00:00",
                                                                                                                    "updated_at": "2022-10-27T16:55:16+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_a07f51976f1148948fd13dbc06da8e2c",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-27T16:55:16Z",
                                                                                                                    "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": {
                                                                                                                    "object": "PostageLabel",
                                                                                                                    "id": "pl_0422d418ba554cdbb71aa4155654c5bb",
                                                                                                                    "created_at": "2022-10-27T16:55:16Z",
                                                                                                                    "updated_at": "2022-10-27T16:55:17Z",
                                                                                                                    "date_advance": 0,
                                                                                                                    "integrated_form": "none",
                                                                                                                    "label_date": "2022-10-27T16:55:16Z",
                                                                                                                    "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/20221027/960bbdc30bc844479d7516b87afea21f.png",
                                                                                                                    "label_pdf_url": null,
                                                                                                                    "label_zpl_url": null,
                                                                                                                    "label_epl2_url": null,
                                                                                                                    "label_file": null
                                                                                                                  },
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_aba5cf93627a4784a552e7149894dccc",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-27T16:55:16Z",
                                                                                                                      "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_c2aab812a68549cc99a710053da0b063",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_2385958e1961451f88bd19742d3d40fd",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-27T16:55:16Z",
                                                                                                                      "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_c2aab812a68549cc99a710053da0b063",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_c9a4291540bb4d71a34817bea9403d6e",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-27T16:55:16Z",
                                                                                                                      "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_c2aab812a68549cc99a710053da0b063",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": {
                                                                                                                    "id": "rate_c9a4291540bb4d71a34817bea9403d6e",
                                                                                                                    "object": "Rate",
                                                                                                                    "created_at": "2022-10-27T16:55:16Z",
                                                                                                                    "updated_at": "2022-10-27T16:55:16Z",
                                                                                                                    "mode": "test",
                                                                                                                    "service": "Priority",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "rate": "10.07",
                                                                                                                    "currency": "USD",
                                                                                                                    "retail_rate": "13.45",
                                                                                                                    "retail_currency": "USD",
                                                                                                                    "list_rate": "10.07",
                                                                                                                    "list_currency": "USD",
                                                                                                                    "billing_type": "easypost",
                                                                                                                    "delivery_days": 2,
                                                                                                                    "delivery_date": null,
                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                    "est_delivery_days": 2,
                                                                                                                    "shipment_id": "shp_c2aab812a68549cc99a710053da0b063",
                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                  },
                                                                                                                  "tracker": {
                                                                                                                    "id": "trk_cabd8faadb134c81bf7cc5e20dc74077",
                                                                                                                    "object": "Tracker",
                                                                                                                    "mode": "test",
                                                                                                                    "tracking_code": "9405500106068145794057",
                                                                                                                    "status": "unknown",
                                                                                                                    "status_detail": "unknown",
                                                                                                                    "created_at": "2022-10-27T16:55:17Z",
                                                                                                                    "updated_at": "2022-10-27T16:55:17Z",
                                                                                                                    "signed_by": null,
                                                                                                                    "weight": null,
                                                                                                                    "est_delivery_date": null,
                                                                                                                    "shipment_id": "shp_c2aab812a68549cc99a710053da0b063",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "tracking_details": [],
                                                                                                                    "fees": [],
                                                                                                                    "carrier_detail": null,
                                                                                                                    "public_url": "https://track.easypost.com/djE6dHJrX2NhYmQ4ZmFhZGIxMzRjODFiZjdjYzVlMjBkYzc0MDc3"
                                                                                                                  },
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_21a73c5d561811ed9651ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-27T16:55:16+00:00",
                                                                                                                    "updated_at": "2022-10-27T16:55:16+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_21a919c7561811ed9652ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-27T16:55:16+00:00",
                                                                                                                    "updated_at": "2022-10-27T16:55:16+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_21a73c5d561811ed9651ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-27T16:55:16+00:00",
                                                                                                                    "updated_at": "2022-10-27T16:55:16+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": "10.07000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "id": "shp_c2aab812a68549cc99a710053da0b063",
                                                                                                                  "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                
                                                                                                                            await shipment.GenerateLabel("ZPL");
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:17:47Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": "9461200106068143633025",
                                                                                                                  "updated_at": "2022-10-17T17:17:49Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_7775de399d0943dfa843bbc39ce48e4a",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:17:47Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:47Z",
                                                                                                                    "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_a1f3ba825068442a9c25b0b5d3dce436",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:17:47Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:47Z",
                                                                                                                        "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_9f341da04e3f11edaa31ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:47+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:47+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_8c676f5b0f6946f3ab04a6343deab98e",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:17:47Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:47Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": {
                                                                                                                    "object": "PostageLabel",
                                                                                                                    "id": "pl_554a28915a144bc381ef633ea89df30a",
                                                                                                                    "created_at": "2022-10-17T17:17:48Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:50Z",
                                                                                                                    "date_advance": 0,
                                                                                                                    "integrated_form": "none",
                                                                                                                    "label_date": "2022-10-17T17:17:48Z",
                                                                                                                    "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/20221017/b886f670e99443c78e13e060adc5ee29.png",
                                                                                                                    "label_pdf_url": null,
                                                                                                                    "label_zpl_url": "https://easypost-files.s3-us-west-2.amazonaws.com/files/postage_label/20221017/c851593ca87b471da45210949a258236.zpl",
                                                                                                                    "label_epl2_url": null,
                                                                                                                    "label_file": null
                                                                                                                  },
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_b04b5c01f67847fe9c9539d99ee590c3",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:48Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:48Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_be2b8af2f90a46ea96ee28ce6b50259a",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_94836bf9bf5c4f3a9860fb3111806ffa",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:48Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:48Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_be2b8af2f90a46ea96ee28ce6b50259a",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_c1e5c5bc48384aafba26133efd8b4ba3",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:48Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:48Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_be2b8af2f90a46ea96ee28ce6b50259a",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": {
                                                                                                                    "id": "rate_94836bf9bf5c4f3a9860fb3111806ffa",
                                                                                                                    "object": "Rate",
                                                                                                                    "created_at": "2022-10-17T17:17:48Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:48Z",
                                                                                                                    "mode": "test",
                                                                                                                    "service": "ParcelSelect",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "rate": "9.16",
                                                                                                                    "currency": "USD",
                                                                                                                    "retail_rate": "9.16",
                                                                                                                    "retail_currency": "USD",
                                                                                                                    "list_rate": "9.16",
                                                                                                                    "list_currency": "USD",
                                                                                                                    "billing_type": "easypost",
                                                                                                                    "delivery_days": 5,
                                                                                                                    "delivery_date": null,
                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                    "est_delivery_days": 5,
                                                                                                                    "shipment_id": "shp_be2b8af2f90a46ea96ee28ce6b50259a",
                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                  },
                                                                                                                  "tracker": {
                                                                                                                    "id": "trk_4b48d3c1057f4ecbbe2a82a06681a649",
                                                                                                                    "object": "Tracker",
                                                                                                                    "mode": "test",
                                                                                                                    "tracking_code": "9461200106068143633025",
                                                                                                                    "status": "pre_transit",
                                                                                                                    "status_detail": "status_update",
                                                                                                                    "created_at": "2022-10-17T17:17:49Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:49Z",
                                                                                                                    "signed_by": null,
                                                                                                                    "weight": null,
                                                                                                                    "est_delivery_date": "2022-10-17T17:17:49Z",
                                                                                                                    "shipment_id": "shp_be2b8af2f90a46ea96ee28ce6b50259a",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "tracking_details": [
                                                                                                                      {
                                                                                                                        "object": "TrackingDetail",
                                                                                                                        "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                        "description": null,
                                                                                                                        "status": "pre_transit",
                                                                                                                        "status_detail": "status_update",
                                                                                                                        "datetime": "2022-09-17T17:17:49Z",
                                                                                                                        "source": "USPS",
                                                                                                                        "carrier_code": null,
                                                                                                                        "tracking_location": {
                                                                                                                          "object": "TrackingLocation",
                                                                                                                          "city": null,
                                                                                                                          "state": null,
                                                                                                                          "country": null,
                                                                                                                          "zip": null
                                                                                                                        }
                                                                                                                      },
                                                                                                                      {
                                                                                                                        "object": "TrackingDetail",
                                                                                                                        "message": "Shipping Label Created",
                                                                                                                        "description": null,
                                                                                                                        "status": "pre_transit",
                                                                                                                        "status_detail": "status_update",
                                                                                                                        "datetime": "2022-09-18T05:54:49Z",
                                                                                                                        "source": "USPS",
                                                                                                                        "carrier_code": null,
                                                                                                                        "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/djE6dHJrXzRiNDhkM2MxMDU3ZjRlY2JiZTJhODJhMDY2ODFhNjQ5"
                                                                                                                  },
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_9f31c1774e3f11ed8687ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:47+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:48+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_9f341da04e3f11edaa31ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:47+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:47+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_9f31c1774e3f11ed8687ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:47+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:48+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": "9.16000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "id": "shp_be2b8af2f90a46ea96ee28ce6b50259a",
                                                                                                                  "object": "Shipment"
                                                                                                                }

                                                                                                                Carbon Offset

                                                                                                                The Carbon Offset API estimates the carbon emissions on parcel delivery for a given shipment, and allows purchasing offsets to neutralize carbon emissions from parcel delivery.

                                                                                                                To use the Carbon Offset API, set carbon_offset to "true" when creating a Shipment. Each Rate will return a CarbonOffset object with the estimated grams of carbon emitted and price to offset the carbon emissions. To purchase the carbon offset, set carbon_offset to "true" when you purchase the Shipment.

                                                                                                                If no offset is available for a shipment when requested, a message "No carbon offset available for this shipment" is shown in the messages array.

                                                                                                                Carbon Offset Object

                                                                                                                attributetypespecification
                                                                                                                gramsintegerthe estimated amount of carbon grams emitted by the shipment
                                                                                                                pricestringprice to offset the amount of carbon grams
                                                                                                                currencystringcurrency of the price (currently always USD)
                                                                                                                objectstring"CarbonOffset"
                                                                                                                POST/shipments

                                                                                                                Create Shipment with Carbon Offset

                                                                                                                Request Parameters
                                                                                                                paramexampleinfo
                                                                                                                carbon_offsettrueWhether you want to buy a shipment with carbon offset.
                                                                                                                Example
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                using Newtonsoft.Json;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Dictionary<string, object> fromAddress = new Dictionary<string, object>() {
                                                                                                                                { "name", "Dr. Steve Brule" },
                                                                                                                                { "street1", "417 Montgomery Street" },
                                                                                                                                { "street2", "5th Floor" },
                                                                                                                                { "city", "San Francisco" },
                                                                                                                                { "state", "CA" },
                                                                                                                                { "country", "US" },
                                                                                                                                { "zip", "94104" }
                                                                                                                            };
                                                                                                                
                                                                                                                            Dictionary<string, object> toAddress = new Dictionary<string, object>() {
                                                                                                                                { "company", "EasyPost" },
                                                                                                                                { "street1", "417 Montgomery Street" },
                                                                                                                                { "street2", "Floor 5" },
                                                                                                                                { "city", "San Francisco" },
                                                                                                                                { "state", "CA" },
                                                                                                                                { "country", "US" },
                                                                                                                                { "zip", "94104" }
                                                                                                                            };
                                                                                                                
                                                                                                                            Shipment shipment = await Shipment.Create(new Dictionary<string, object>() {
                                                                                                                                { "parcel", new Dictionary<string, object>() {
                                                                                                                                    { "length", 8 }, { "width", 6 }, { "height", 5 }, { "weight", 10 }
                                                                                                                                } },
                                                                                                                                { "to_address", toAddress },
                                                                                                                                { "from_address", fromAddress },
                                                                                                                                { "reference", "ShipmentRef" }
                                                                                                                            }, withCarbonOffset: true);
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:18:01Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": null,
                                                                                                                  "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_b98dadb97cd3412e96e95b26c701ccd1",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:18:01Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                    "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_fe1e69e9a3394b398b796d6fbd307fc3",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:18:01Z",
                                                                                                                        "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                        "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_a712727c4e3f11edbf4bac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:01+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:01+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_c9c8597448d84e6db789b7e5388351e1",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:18:01Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": null,
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_d638b8120123495fa90b2306cc96934c",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:01Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_a344b57322ed43de997bddd43fa9b11e",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_3aafd51adfec439baa4ad2d0af3b03dc",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:01Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_a344b57322ed43de997bddd43fa9b11e",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_61d155ab513d459095b3b6e88c8c234c",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:01Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:01Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_a344b57322ed43de997bddd43fa9b11e",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": null,
                                                                                                                  "tracker": null,
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_a7109bae4e3f11ed89b2ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:01+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:01+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_a712727c4e3f11edbf4bac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:01+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:01+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_a7109bae4e3f11ed89b2ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:01+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:01+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_a344b57322ed43de997bddd43fa9b11e",
                                                                                                                  "object": "Shipment"
                                                                                                                }
                                                                                                                POST/shipments/:id/buy

                                                                                                                Buy Shipment with Carbon Offset

                                                                                                                Request Parameters
                                                                                                                paramexampleinfo
                                                                                                                carbon_offsettrueWhether you want to buy a shipment with carbon offset.
                                                                                                                Example
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                using Newtonsoft.Json;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await Shipment.Retrieve("shp_...");
                                                                                                                            await shipment.Buy(shipment.LowestRate(), withCarbonOffset: true);
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:18:02Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": "9461200106068143633094",
                                                                                                                  "updated_at": "2022-10-17T17:18:03Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_0a86a4ae4cb5410fb1e6a34fd91a4e4a",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:18:02Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:02Z",
                                                                                                                    "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_ff56fa5ff54a46a7b4d2d5ad42abd8e4",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:18:02Z",
                                                                                                                        "updated_at": "2022-10-17T17:18:02Z",
                                                                                                                        "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_a7b78b274e3f11ed82c1ac1f6bc7bdc6",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:02+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:02+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_b1c18adec38445ba9fbbdebefc189441",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:18:02Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:02Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": {
                                                                                                                    "object": "PostageLabel",
                                                                                                                    "id": "pl_f65be76ac8ac481e92124b825558cedd",
                                                                                                                    "created_at": "2022-10-17T17:18:03Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:03Z",
                                                                                                                    "date_advance": 0,
                                                                                                                    "integrated_form": "none",
                                                                                                                    "label_date": "2022-10-17T17:18:03Z",
                                                                                                                    "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/20221017/d8f58ee193b24f9fadffae791f85d5f0.png",
                                                                                                                    "label_pdf_url": null,
                                                                                                                    "label_zpl_url": null,
                                                                                                                    "label_epl2_url": null,
                                                                                                                    "label_file": null
                                                                                                                  },
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_f3c5cd5385bf4c2b8f50c4f096236fa3",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:02Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:02Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_053e30b444fe4ed8bb48c78f64ca6f72",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_4b78b657d7ca43c280aedc31abfa272e",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:02Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:02Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_053e30b444fe4ed8bb48c78f64ca6f72",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_9f9be32c0ebc4842a054bd5406881c31",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:02Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:02Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_053e30b444fe4ed8bb48c78f64ca6f72",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": {
                                                                                                                    "id": "rate_9f9be32c0ebc4842a054bd5406881c31",
                                                                                                                    "object": "Rate",
                                                                                                                    "created_at": "2022-10-17T17:18:03Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:03Z",
                                                                                                                    "mode": "test",
                                                                                                                    "service": "ParcelSelect",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "rate": "9.16",
                                                                                                                    "currency": "USD",
                                                                                                                    "retail_rate": "9.16",
                                                                                                                    "retail_currency": "USD",
                                                                                                                    "list_rate": "9.16",
                                                                                                                    "list_currency": "USD",
                                                                                                                    "billing_type": "easypost",
                                                                                                                    "delivery_days": 5,
                                                                                                                    "delivery_date": null,
                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                    "est_delivery_days": 5,
                                                                                                                    "shipment_id": "shp_053e30b444fe4ed8bb48c78f64ca6f72",
                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                  },
                                                                                                                  "tracker": {
                                                                                                                    "id": "trk_c801f8fb13804c1bb8cbe0c3c750a8e7",
                                                                                                                    "object": "Tracker",
                                                                                                                    "mode": "test",
                                                                                                                    "tracking_code": "9461200106068143633094",
                                                                                                                    "status": "unknown",
                                                                                                                    "status_detail": "unknown",
                                                                                                                    "created_at": "2022-10-17T17:18:03Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:03Z",
                                                                                                                    "signed_by": null,
                                                                                                                    "weight": null,
                                                                                                                    "est_delivery_date": null,
                                                                                                                    "shipment_id": "shp_053e30b444fe4ed8bb48c78f64ca6f72",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "tracking_details": [],
                                                                                                                    "fees": [],
                                                                                                                    "carrier_detail": null,
                                                                                                                    "public_url": "https://track.easypost.com/djE6dHJrX2M4MDFmOGZiMTM4MDRjMWJiOGNiZTBjM2M3NTBhOGU3"
                                                                                                                  },
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_a7b4bcf24e3f11ed89edac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:02+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:02+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_a7b78b274e3f11ed82c1ac1f6bc7bdc6",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:02+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:02+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_a7b4bcf24e3f11ed89edac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:02+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:02+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": "9.16000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "object": "Fee",
                                                                                                                      "type": "CarbonOffsetFee",
                                                                                                                      "amount": "0.11000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "id": "shp_053e30b444fe4ed8bb48c78f64ca6f72",
                                                                                                                  "object": "Shipment"
                                                                                                                }
                                                                                                                POST/shipments

                                                                                                                One-Call Buy Shipment with Carbon Offset

                                                                                                                Request Parameters
                                                                                                                paramexampleinfo
                                                                                                                carbon_offsettrueWhether you want to buy a shipment with carbon offset.
                                                                                                                Example
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                using Newtonsoft.Json;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Dictionary<string, object> fromAddress = new Dictionary<string, object>() {
                                                                                                                                { "name", "Dr. Steve Brule" },
                                                                                                                                { "street1", "417 Montgomery Street" },
                                                                                                                                { "street2", "5th Floor" },
                                                                                                                                { "city", "San Francisco" },
                                                                                                                                { "state", "CA" },
                                                                                                                                { "country", "US" },
                                                                                                                                { "zip", "94104" }
                                                                                                                            };
                                                                                                                
                                                                                                                            Dictionary<string, object> toAddress = new Dictionary<string, object>() {
                                                                                                                                { "company", "EasyPost" },
                                                                                                                                { "street1", "417 Montgomery Street" },
                                                                                                                                { "street2", "Floor 5" },
                                                                                                                                { "city", "San Francisco" },
                                                                                                                                { "state", "CA" },
                                                                                                                                { "country", "US" },
                                                                                                                                { "zip", "94104" }
                                                                                                                            };
                                                                                                                
                                                                                                                            Shipment shipment = await Shipment.Create(new Dictionary<string, object>() {
                                                                                                                                { "carrier_accounts", new Dictionary<string, string>() { { "id", "ca_..." } } },
                                                                                                                                { "service", "NextDayAir" },
                                                                                                                                { "parcel", new Dictionary<string, object>() {
                                                                                                                                    { "length", 8 }, { "width", 6 }, { "height", 5 }, { "weight", 10 }
                                                                                                                                } },
                                                                                                                                { "to_address", toAddress },
                                                                                                                                { "from_address", fromAddress },
                                                                                                                                { "reference", "ShipmentRef" }
                                                                                                                            }, withCarbonOffset: true);
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:18:04Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": "9405500106068143633105",
                                                                                                                  "updated_at": "2022-10-17T17:18:05Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_8adecb9fa4ca4e90adb5d960c9579fcf",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:18:04Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:04Z",
                                                                                                                    "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_5f5a69a313384b13835dea9b3a7b1494",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:18:04Z",
                                                                                                                        "updated_at": "2022-10-17T17:18:04Z",
                                                                                                                        "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_a92c9a7a4e3f11edadb4ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:04+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:04+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_9a394d9a6af943cbb97ccc549e547326",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:18:04Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:04Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": {
                                                                                                                    "object": "PostageLabel",
                                                                                                                    "id": "pl_1071c07faffe4010a5cb060e25ac837a",
                                                                                                                    "created_at": "2022-10-17T17:18:05Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:05Z",
                                                                                                                    "date_advance": 0,
                                                                                                                    "integrated_form": "none",
                                                                                                                    "label_date": "2022-10-17T17:18:05Z",
                                                                                                                    "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/20221017/b0d07ac387e24d8db90a48416c088876.png",
                                                                                                                    "label_pdf_url": null,
                                                                                                                    "label_zpl_url": null,
                                                                                                                    "label_epl2_url": null,
                                                                                                                    "label_file": null
                                                                                                                  },
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_f1ce8a63c0b54575b84618894cb214bb",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:04Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:04Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_15deb4bde7ad49ba9cde52f7e48c5c22",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_bc13f11026f244a8924ff6e0081e5d58",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:04Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:04Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_15deb4bde7ad49ba9cde52f7e48c5c22",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_cd45a2abd0884bdca6031a011d0c63fd",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:04Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:04Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_15deb4bde7ad49ba9cde52f7e48c5c22",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                      "carbon_offset": {
                                                                                                                        "object": "CarbonOffset",
                                                                                                                        "grams": 154,
                                                                                                                        "price": "0.11",
                                                                                                                        "currency": "USD"
                                                                                                                      }
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": {
                                                                                                                    "id": "rate_bc13f11026f244a8924ff6e0081e5d58",
                                                                                                                    "object": "Rate",
                                                                                                                    "created_at": "2022-10-17T17:18:05Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:05Z",
                                                                                                                    "mode": "test",
                                                                                                                    "service": "Priority",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "rate": "10.07",
                                                                                                                    "currency": "USD",
                                                                                                                    "retail_rate": "13.45",
                                                                                                                    "retail_currency": "USD",
                                                                                                                    "list_rate": "10.07",
                                                                                                                    "list_currency": "USD",
                                                                                                                    "billing_type": "easypost",
                                                                                                                    "delivery_days": 2,
                                                                                                                    "delivery_date": null,
                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                    "est_delivery_days": 2,
                                                                                                                    "shipment_id": "shp_15deb4bde7ad49ba9cde52f7e48c5c22",
                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                  },
                                                                                                                  "tracker": {
                                                                                                                    "id": "trk_d79bf6d00fff4da880ea4d0ac57c041f",
                                                                                                                    "object": "Tracker",
                                                                                                                    "mode": "test",
                                                                                                                    "tracking_code": "9405500106068143633105",
                                                                                                                    "status": "unknown",
                                                                                                                    "status_detail": "unknown",
                                                                                                                    "created_at": "2022-10-17T17:18:05Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:05Z",
                                                                                                                    "signed_by": null,
                                                                                                                    "weight": null,
                                                                                                                    "est_delivery_date": null,
                                                                                                                    "shipment_id": "shp_15deb4bde7ad49ba9cde52f7e48c5c22",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "tracking_details": [],
                                                                                                                    "fees": [],
                                                                                                                    "carrier_detail": null,
                                                                                                                    "public_url": "https://track.easypost.com/djE6dHJrX2Q3OWJmNmQwMGZmZjRkYTg4MGVhNGQwYWM1N2MwNDFm"
                                                                                                                  },
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_a9297b274e3f11ed82f5ac1f6bc7bdc6",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:04+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:05+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_a92c9a7a4e3f11edadb4ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:04+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:04+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_a9297b274e3f11ed82f5ac1f6bc7bdc6",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:04+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:05+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": "10.07000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "object": "Fee",
                                                                                                                      "type": "CarbonOffsetFee",
                                                                                                                      "amount": "0.11000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "id": "shp_15deb4bde7ad49ba9cde52f7e48c5c22",
                                                                                                                  "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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                
                                                                                                                            Dictionary<string, object> form = new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                { "type", "return_packing_slip" },
                                                                                                                                { "barcode", "RMA12345678900" },
                                                                                                                                {
                                                                                                                                    "line_items", new List<Dictionary<string, object>>()
                                                                                                                                    {
                                                                                                                                        {
                                                                                                                                            new Dictionary<string, object>
                                                                                                                                            {
                                                                                                                                                { "title", "Square Reader" },
                                                                                                                                                { "barcode", "855658003251" }
                                                                                                                                            }
                                                                                                                                        }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                { "units", 8 }
                                                                                                                            };
                                                                                                                
                                                                                                                            await shipment.GenerateForm("return_packing_slip", form);
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:17:57Z",
                                                                                                                  "is_return": false,
                                                                                                                  "messages": [],
                                                                                                                  "mode": "test",
                                                                                                                  "options": {
                                                                                                                    "currency": "USD",
                                                                                                                    "payment": {
                                                                                                                      "type": "SENDER"
                                                                                                                    },
                                                                                                                    "date_advance": 0
                                                                                                                  },
                                                                                                                  "reference": null,
                                                                                                                  "status": "unknown",
                                                                                                                  "tracking_code": "9405500106068143633075",
                                                                                                                  "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_381a27daba534502889be3acd5589e68",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:17:57Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:57Z",
                                                                                                                    "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_01bdeca5ba3d4057bce062cbe9eac7e5",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:17:57Z",
                                                                                                                        "updated_at": "2022-10-17T17:17:57Z",
                                                                                                                        "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_a525bec24e3f11ed8908ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:57+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:57+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_4d110a16daf04c09ba4d8b0a52e74e9e",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:17:57Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:57Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": {
                                                                                                                    "object": "PostageLabel",
                                                                                                                    "id": "pl_bed6e3f2e31447829e082b9d2b3c9c14",
                                                                                                                    "created_at": "2022-10-17T17:17:58Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                    "date_advance": 0,
                                                                                                                    "integrated_form": "none",
                                                                                                                    "label_date": "2022-10-17T17:17:58Z",
                                                                                                                    "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/20221017/8a47d9778c1047eb82d009dfeddb72e1.png",
                                                                                                                    "label_pdf_url": null,
                                                                                                                    "label_zpl_url": null,
                                                                                                                    "label_epl2_url": null,
                                                                                                                    "label_file": null
                                                                                                                  },
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_5e25b0cdcea64e00b2c48a5d51d0f78d",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:58Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_d552fce238914554944a7432d3b7c662",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_736b32772e9a4d619f8879c1e7b92608",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:58Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_d552fce238914554944a7432d3b7c662",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_34003fbd76c148beaac91b51984ef7ef",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:17:58Z",
                                                                                                                      "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_d552fce238914554944a7432d3b7c662",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": {
                                                                                                                    "id": "rate_34003fbd76c148beaac91b51984ef7ef",
                                                                                                                    "object": "Rate",
                                                                                                                    "created_at": "2022-10-17T17:17:58Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                    "mode": "test",
                                                                                                                    "service": "Priority",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "rate": "10.07",
                                                                                                                    "currency": "USD",
                                                                                                                    "retail_rate": "13.45",
                                                                                                                    "retail_currency": "USD",
                                                                                                                    "list_rate": "10.07",
                                                                                                                    "list_currency": "USD",
                                                                                                                    "billing_type": "easypost",
                                                                                                                    "delivery_days": 2,
                                                                                                                    "delivery_date": null,
                                                                                                                    "delivery_date_guaranteed": false,
                                                                                                                    "est_delivery_days": 2,
                                                                                                                    "shipment_id": "shp_d552fce238914554944a7432d3b7c662",
                                                                                                                    "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                  },
                                                                                                                  "tracker": {
                                                                                                                    "id": "trk_797b64e929774dbc83369cbd033888c3",
                                                                                                                    "object": "Tracker",
                                                                                                                    "mode": "test",
                                                                                                                    "tracking_code": "9405500106068143633075",
                                                                                                                    "status": "pre_transit",
                                                                                                                    "status_detail": "status_update",
                                                                                                                    "created_at": "2022-10-17T17:17:58Z",
                                                                                                                    "updated_at": "2022-10-17T17:17:58Z",
                                                                                                                    "signed_by": null,
                                                                                                                    "weight": null,
                                                                                                                    "est_delivery_date": "2022-10-17T17:17:58Z",
                                                                                                                    "shipment_id": "shp_d552fce238914554944a7432d3b7c662",
                                                                                                                    "carrier": "USPS",
                                                                                                                    "tracking_details": [
                                                                                                                      {
                                                                                                                        "object": "TrackingDetail",
                                                                                                                        "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                        "description": null,
                                                                                                                        "status": "pre_transit",
                                                                                                                        "status_detail": "status_update",
                                                                                                                        "datetime": "2022-09-17T17:17:58Z",
                                                                                                                        "source": "USPS",
                                                                                                                        "carrier_code": null,
                                                                                                                        "tracking_location": {
                                                                                                                          "object": "TrackingLocation",
                                                                                                                          "city": null,
                                                                                                                          "state": null,
                                                                                                                          "country": null,
                                                                                                                          "zip": null
                                                                                                                        }
                                                                                                                      },
                                                                                                                      {
                                                                                                                        "object": "TrackingDetail",
                                                                                                                        "message": "Shipping Label Created",
                                                                                                                        "description": null,
                                                                                                                        "status": "pre_transit",
                                                                                                                        "status_detail": "status_update",
                                                                                                                        "datetime": "2022-09-18T05:54:58Z",
                                                                                                                        "source": "USPS",
                                                                                                                        "carrier_code": null,
                                                                                                                        "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/djE6dHJrXzc5N2I2NGU5Mjk3NzRkYmM4MzM2OWNiZDAzMzg4OGMz"
                                                                                                                  },
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_a5240b3e4e3f11edbe9fac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:57+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:58+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_a525bec24e3f11ed8908ac1f6b0a0d1e",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:57+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:57+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_a5240b3e4e3f11edbe9fac1f6bc7b362",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:17:57+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:17:58+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_7c2a0231740e457887e6a6b893967250",
                                                                                                                      "created_at": "2022-10-17T17:18:00Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:00Z",
                                                                                                                      "mode": "test",
                                                                                                                      "form_type": "return_packing_slip",
                                                                                                                      "form_url": "https://easypost-files.s3-us-west-2.amazonaws.com/files/form/20221017/ae040a1c44144ef197119771de234b54.pdf",
                                                                                                                      "submitted_electronically": null
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "fees": [
                                                                                                                    {
                                                                                                                      "object": "Fee",
                                                                                                                      "type": "LabelFee",
                                                                                                                      "amount": "0.00000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "object": "Fee",
                                                                                                                      "type": "PostageFee",
                                                                                                                      "amount": "10.07000",
                                                                                                                      "charged": true,
                                                                                                                      "refunded": false
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "id": "shp_d552fce238914554944a7432d3b7c662",
                                                                                                                  "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, see Carbon Offset which is provided by EasyPost and works with all Carriers.
                                                                                                                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 - "INDIRECT_SIGNATURE" - Requires the signature of someone at the delivery address or from somebody nearby, such as a neighbor.
                                                                                                                • USPS - additional options
                                                                                                                  • ADULT_SIGNATURE_RESTRICTED" - Requires the signature of the addressee only, who must be 21 years of age or older.
                                                                                                                  • SIGNATURE_RESTRICTED" - Requires the signature of the recipient or a responsible party.
                                                                                                                • 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.
                                                                                                                endorsementstringPossible values "ADDRESS_SERVICE_REQUESTED", "FORWARDING_SERVICE_REQUESTED", "CHANGE_SERVICE_REQUESTED", "RETURN_SERVICE_REQUESTED", "LEAVE_IF_NO_RESPONSE"
                                                                                                                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!".
                                                                                                                hazmatstringDangerous goods indicator. Possible values are "PRIMARY_CONTAINED", "PRIMARY_PACKED", "PRIMARY", "SECONDARY_CONTAINED", "SECONDARY_PACKED", "SECONDARY", "ORMD", "LIMITED_QUANTITY", "LITHIUM". Applies to USPS, FedEx and DHL eCommerce.
                                                                                                                hold_for_pickupbooleanPackage will wait at carrier facility for pickup.
                                                                                                                incotermstringIncoterm negotiated for shipment. Supported values are "EXW", "FCA", "CPT", "CIP", "DAT", "DAP", "DDP", "FAS", "FOB", "CFR", and "CIF". Setting this value to anything other than "DDP" will pass the cost and responsibility of duties on to the recipient of the package(s), as specified by Incoterms rules
                                                                                                                invoice_numberstringThis will print an invoice number on the postage label.
                                                                                                                label_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 allows you to request the following USPS mail classes: Media Mail and Library Mail. Set to 'USPS.MEDIAMAIL' or 'USPS.LIBRARYMAIL' respectively to return those rates. These mail classes have restrictions that must be followed. See the DMM for eligibility rules.
                                                                                                                smartpost_hubstringYou can use this to override the hub ID you have on your account.
                                                                                                                smartpost_manifeststringThe manifest ID is used to group SmartPost packages onto a manifest for each trailer.
                                                                                                                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
                                                                                                                using System;
                                                                                                                using System.Collections.Generic;
                                                                                                                using System.Threading.Tasks;
                                                                                                                using Newtonsoft.Json;
                                                                                                                using EasyPost;
                                                                                                                using EasyPost.Models.API;
                                                                                                                
                                                                                                                namespace EasyPostExamples
                                                                                                                {
                                                                                                                    public class Examples
                                                                                                                    {
                                                                                                                        public static async Task Main()
                                                                                                                        {
                                                                                                                            string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                
                                                                                                                            var client = new EasyPost.Client(apiKey);
                                                                                                                
                                                                                                                            Shipment shipment = await client.Shipment.Create(new Dictionary<string, object>()
                                                                                                                            {
                                                                                                                                {
                                                                                                                                    "to_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "adr_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "from_address", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "adr_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "parcel", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "id", "prcl_..." }
                                                                                                                                    }
                                                                                                                                },
                                                                                                                                {
                                                                                                                                    "options", new Dictionary<string, object>()
                                                                                                                                    {
                                                                                                                                        { "print_custom_1", "Custom label message" }
                                                                                                                                    }
                                                                                                                                }
                                                                                                                            });
                                                                                                                
                                                                                                                            Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                        }
                                                                                                                    }
                                                                                                                }
                                                                                                                {
                                                                                                                  "created_at": "2022-10-17T17:18:10Z",
                                                                                                                  "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": "2022-10-17T17:18:10Z",
                                                                                                                  "batch_id": null,
                                                                                                                  "batch_status": null,
                                                                                                                  "batch_message": null,
                                                                                                                  "customs_info": {
                                                                                                                    "id": "cstinfo_455727877713441eae37d0cf3e49b078",
                                                                                                                    "object": "CustomsInfo",
                                                                                                                    "created_at": "2022-10-17T17:18:10Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:10Z",
                                                                                                                    "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_748a5250e6a043dd9fa49719d3378062",
                                                                                                                        "object": "CustomsItem",
                                                                                                                        "created_at": "2022-10-17T17:18:10Z",
                                                                                                                        "updated_at": "2022-10-17T17:18:10Z",
                                                                                                                        "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_acae73684e3f11ed83acac1f6bc7bdc6",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:10+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:10+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_1bbb7ebc269f4f1f815ba3abb0381d89",
                                                                                                                    "object": "Parcel",
                                                                                                                    "created_at": "2022-10-17T17:18:10Z",
                                                                                                                    "updated_at": "2022-10-17T17:18:10Z",
                                                                                                                    "length": 20.2,
                                                                                                                    "width": 10.9,
                                                                                                                    "height": 5.0,
                                                                                                                    "predefined_package": null,
                                                                                                                    "weight": 65.9,
                                                                                                                    "mode": "test"
                                                                                                                  },
                                                                                                                  "postage_label": null,
                                                                                                                  "rates": [
                                                                                                                    {
                                                                                                                      "id": "rate_d56ea9cc34e44f86aed4d5b06f743d42",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:10Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:10Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "ParcelSelect",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "9.16",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "9.16",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "9.16",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 5,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 5,
                                                                                                                      "shipment_id": "shp_c40aadc091ac456a8d611bb978aaa323",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_75183f00ed5048379b293997cab050e4",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:10Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:10Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Priority",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "10.07",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "13.45",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "10.07",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": 2,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": 2,
                                                                                                                      "shipment_id": "shp_c40aadc091ac456a8d611bb978aaa323",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    },
                                                                                                                    {
                                                                                                                      "id": "rate_595855c1c20b4675ac0dd3ad6fa6b9bc",
                                                                                                                      "object": "Rate",
                                                                                                                      "created_at": "2022-10-17T17:18:10Z",
                                                                                                                      "updated_at": "2022-10-17T17:18:10Z",
                                                                                                                      "mode": "test",
                                                                                                                      "service": "Express",
                                                                                                                      "carrier": "USPS",
                                                                                                                      "rate": "44.55",
                                                                                                                      "currency": "USD",
                                                                                                                      "retail_rate": "51.30",
                                                                                                                      "retail_currency": "USD",
                                                                                                                      "list_rate": "44.55",
                                                                                                                      "list_currency": "USD",
                                                                                                                      "billing_type": "easypost",
                                                                                                                      "delivery_days": null,
                                                                                                                      "delivery_date": null,
                                                                                                                      "delivery_date_guaranteed": false,
                                                                                                                      "est_delivery_days": null,
                                                                                                                      "shipment_id": "shp_c40aadc091ac456a8d611bb978aaa323",
                                                                                                                      "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                    }
                                                                                                                  ],
                                                                                                                  "refund_status": null,
                                                                                                                  "scan_form": null,
                                                                                                                  "selected_rate": null,
                                                                                                                  "tracker": null,
                                                                                                                  "to_address": {
                                                                                                                    "id": "adr_acabfe634e3f11edaee3ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:10+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:10+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_acae73684e3f11ed83acac1f6bc7bdc6",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:10+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:10+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_acabfe634e3f11edaee3ac1f6bc72124",
                                                                                                                    "object": "Address",
                                                                                                                    "created_at": "2022-10-17T17:18:10+00:00",
                                                                                                                    "updated_at": "2022-10-17T17:18:10+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_c40aadc091ac456a8d611bb978aaa323",
                                                                                                                  "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
                                                                                                                carbon_offsetCarbonOffsetthe associated CarbonOffset object, if requested
                                                                                                                created_atdatetime
                                                                                                                updated_atdatetime

                                                                                                                Service Levels

                                                                                                                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
                                                                                                                Australia Post
                                                                                                                • ExpressPost
                                                                                                                • ExpressPostSignature
                                                                                                                • ParcelPost
                                                                                                                • ParcelPostSignature
                                                                                                                • ParcelPostExtra
                                                                                                                • ParcelPostWinePlusSignature
                                                                                                                AxlehireV3
                                                                                                                • AxleHireDelivery
                                                                                                                Better Trucks
                                                                                                                • NEXT_DAY
                                                                                                                Canada Post
                                                                                                                • DeliveredTonight
                                                                                                                • RegularParcel
                                                                                                                • ExpeditedParcel
                                                                                                                • Xpresspost
                                                                                                                • XpresspostCertified
                                                                                                                • Priority
                                                                                                                • LibraryBooks
                                                                                                                • ExpeditedParcelUSA
                                                                                                                • PriorityWorldwideEnvelopeUSA
                                                                                                                • PriorityWorldwidePakUSA
                                                                                                                • PriorityWorldwideParcelUSA
                                                                                                                • SmallPacketUSAAir
                                                                                                                • TrackedPacketUSA
                                                                                                                • TrackedPacketUSALVM
                                                                                                                • XpresspostUSA
                                                                                                                • XpresspostInternational
                                                                                                                • InternationalParcelAir
                                                                                                                • InternationalParcelSurface
                                                                                                                • PriorityWorldwideEnvelopeIntl
                                                                                                                • PriorityWorldwidePakIntl
                                                                                                                • PriorityWorldwideParcelIntl
                                                                                                                • SmallPacketInternationalAir
                                                                                                                • SmallPacketInternationalSurface
                                                                                                                • TrackedPacketInternational
                                                                                                                Canpar
                                                                                                                • Ground
                                                                                                                • SelectLetter
                                                                                                                • SelectPak
                                                                                                                • Select
                                                                                                                • OvernightLetter
                                                                                                                • OvernightPak
                                                                                                                • Overnight
                                                                                                                • SelectUSA
                                                                                                                • USAPak
                                                                                                                • USALetter
                                                                                                                • USA
                                                                                                                • International
                                                                                                                CDL Last Mile Solutions
                                                                                                                • DISTRIBUTION
                                                                                                                • Same Day
                                                                                                                Chronopost

                                                                                                                No service levels for Chronopost.

                                                                                                                  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
                                                                                                                    • 1KgParcel
                                                                                                                    • 10KgParcel
                                                                                                                    • 10KgParcelATL
                                                                                                                    • 15KgParcel
                                                                                                                    • 15KgParcelATL
                                                                                                                    • 1KgParcelATL
                                                                                                                    • 2KgParcel
                                                                                                                    • 25KgParcel
                                                                                                                    • 25KgParcelATL
                                                                                                                    • 2KgParcelATL
                                                                                                                    • 3KgParcel
                                                                                                                    • 3KgParcelATL
                                                                                                                    • 5KgParcel
                                                                                                                    • 5Kg Parcel ATL
                                                                                                                    • AustralianCityExpressSignature
                                                                                                                    • DomesticSaverSignature
                                                                                                                    • DomesticOffPeak
                                                                                                                    • DomesticSaver
                                                                                                                    • DomesticOffPeakSignature
                                                                                                                    • GoldDomesticSignature
                                                                                                                    • 1KgSatchelATL
                                                                                                                    • 1KgSatchel
                                                                                                                    • 3KgSatchel
                                                                                                                    • 5KgSatchel
                                                                                                                    • 3KgSatchelATL
                                                                                                                    • 5KgSatchelATL
                                                                                                                    • 500GramSatchelATL
                                                                                                                    • 500GramSatchel
                                                                                                                    • 5KSatchel
                                                                                                                    • ExpressInternationalPriority
                                                                                                                    • InternationalSaver
                                                                                                                    • InternationalExpressImport
                                                                                                                    • InternationalExpress
                                                                                                                    DAI Post
                                                                                                                    • ParcelMax
                                                                                                                    • InternationalEconomy
                                                                                                                    • InternationalStandard
                                                                                                                    • InternationalExpress
                                                                                                                    • DomesticTracked
                                                                                                                    DeliverIt
                                                                                                                    • Afternoon
                                                                                                                    • Early-It
                                                                                                                    • Economy
                                                                                                                    • Noon-It
                                                                                                                    • Saturday
                                                                                                                    Deutsche Post
                                                                                                                    • PacketPlus
                                                                                                                    Deutsche Post UK
                                                                                                                    • PriorityPacketPlus
                                                                                                                    • PriorityPacket
                                                                                                                    • PriorityPacketTracked
                                                                                                                    • BusinessMailRegistered
                                                                                                                    • StandardPacket
                                                                                                                    • BusinessMailStandard
                                                                                                                    DHL eCommerce Asia
                                                                                                                    • Packet
                                                                                                                    • PacketPlus
                                                                                                                    • ParcelDirect
                                                                                                                    • ParcelDirectExpedited
                                                                                                                    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
                                                                                                                    DHL SmartMail

                                                                                                                    No service levels for DHL SmartMail.

                                                                                                                      DPD
                                                                                                                      • DPDCLASSIC
                                                                                                                      • DPD8:30
                                                                                                                      • DPD10:00
                                                                                                                      • DPD12:00
                                                                                                                      • DPD18:00
                                                                                                                      • DPDEXPRESS
                                                                                                                      • DPDPARCELLETTER
                                                                                                                      • DPDPARCELLETTERPLUS
                                                                                                                      • DPDINTERNATIONALMAIL
                                                                                                                      DPDUK
                                                                                                                      • AirExpressInternationalAir
                                                                                                                      • AirClassicInternationalAir
                                                                                                                      • ParcelSunday
                                                                                                                      • FreightParcelSunday
                                                                                                                      • PalletSunday
                                                                                                                      • PalletDpdClassic
                                                                                                                      • ExpresspakDpdClassic
                                                                                                                      • ExpresspakSunday
                                                                                                                      • ParcelDpdClassic
                                                                                                                      • ParcelDpdTwoDay
                                                                                                                      • ParcelDpdNextDay
                                                                                                                      • ParcelDpd12
                                                                                                                      • ParcelDpd10
                                                                                                                      • ParcelReturnToShop
                                                                                                                      • ParcelSaturday
                                                                                                                      • ParcelSaturday12
                                                                                                                      • ParcelSaturday10
                                                                                                                      • ParcelSunday12
                                                                                                                      • FreightParcelDpdClassic
                                                                                                                      • FreightParcelSunday12
                                                                                                                      • ExpresspakDpdNextDay
                                                                                                                      • ExpresspakDpd12
                                                                                                                      • ExpresspakDpd10
                                                                                                                      • ExpresspakSaturday
                                                                                                                      • ExpresspakSaturday12
                                                                                                                      • ExpresspakSaturday10
                                                                                                                      • ExpresspakSunday12
                                                                                                                      • PalletSunday12
                                                                                                                      • PalletDpdTwoDay
                                                                                                                      • PalletDpdNextDay
                                                                                                                      • PalletDpd12
                                                                                                                      • PalletDpd10
                                                                                                                      • PalletSaturday
                                                                                                                      • PalletSaturday12
                                                                                                                      • PalletSaturday10
                                                                                                                      • FreightParcelDpdTwoDay
                                                                                                                      • FreightParcelDpdNextDay
                                                                                                                      • FreightParcelDpd12
                                                                                                                      • FreightParcelDpd10
                                                                                                                      • FreightParcelSaturday
                                                                                                                      • FreightParcelSaturday12
                                                                                                                      • FreightParcelSaturday10
                                                                                                                      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
                                                                                                                      Fastway
                                                                                                                      • Parcel
                                                                                                                      • Satchel
                                                                                                                      FedEx
                                                                                                                      • FEDEX_2_DAY_AM
                                                                                                                      • FEDEX_2_DAY
                                                                                                                      • FEDEX_DISTANCE_DEFERRED
                                                                                                                      • FEDEX_EXPRESS_SAVER
                                                                                                                      • FEDEX_FIRST_OVERNIGHT
                                                                                                                      • FEDEX_GROUND_HOME_DELIVERY
                                                                                                                      • FEDEX_GROUND
                                                                                                                      • FEDEX_INTERNATIONAL_CONNECT_PLUS
                                                                                                                      • FEDEX_INTERNATIONAL_ECONOMY
                                                                                                                      • FEDEX_INTERNATIONAL_FIRST
                                                                                                                      • FEDEX_INTERNATIONAL_PRIORITY
                                                                                                                      • FEDEX_PRIORITY_OVERNIGHT
                                                                                                                      • FEDEX_STANDARD_OVERNIGHT
                                                                                                                      FedEx Cross Border
                                                                                                                      • CBEC
                                                                                                                      • CBECL
                                                                                                                      • CBECP
                                                                                                                      FedEx Mailview

                                                                                                                      No service levels for FedEx Mailview.

                                                                                                                        FedEx SmartPost
                                                                                                                        • SMART_POST
                                                                                                                        FirstMile
                                                                                                                        • XParcelGround
                                                                                                                        • XParcelExpedited
                                                                                                                        • XParcelExpeditedPlus
                                                                                                                        • XParcelPriority
                                                                                                                        • XParcelReturns
                                                                                                                        GSO
                                                                                                                        • EarlyPriorityOvernight
                                                                                                                        • PriorityOvernight
                                                                                                                        • CaliforniaParcelService
                                                                                                                        • SaturdayDeliveryService
                                                                                                                        • EarlySaturdayService
                                                                                                                        • Ground
                                                                                                                        • Overnight
                                                                                                                        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
                                                                                                                        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
                                                                                                                              • GroundEarly
                                                                                                                              • GroundBasic
                                                                                                                              • PriorityBasic
                                                                                                                              • PriorityEarly
                                                                                                                              • PrioritySaturday
                                                                                                                              • Priority2ndDay
                                                                                                                              • SameDay
                                                                                                                              Maergo
                                                                                                                              • Standard
                                                                                                                              Newgistics
                                                                                                                              • ParcelSelect
                                                                                                                              • ParcelSelectLightweight
                                                                                                                              • Ground
                                                                                                                              • Express
                                                                                                                              • FirstClassMail
                                                                                                                              • PriorityMail
                                                                                                                              • BoundPrintedMatter
                                                                                                                              Ontrac
                                                                                                                              • Sunrise
                                                                                                                              • Gold
                                                                                                                              • OnTracGround
                                                                                                                              • SameDay
                                                                                                                              • PalletizedFreight
                                                                                                                              Optima
                                                                                                                              • NxtDay
                                                                                                                              OSM Worldwide
                                                                                                                              • First
                                                                                                                              • ParcelSelectLightweight
                                                                                                                              • Priority
                                                                                                                              • BPM
                                                                                                                              • ParcelSelect
                                                                                                                              • MediaMail
                                                                                                                              • MarketingParcel
                                                                                                                              • MarketingParcelTracked
                                                                                                                              Parcelforce
                                                                                                                              • Express9
                                                                                                                              • Express9Secure
                                                                                                                              • Express9CourierPack
                                                                                                                              • Express10
                                                                                                                              • Express10Secure
                                                                                                                              • Express10Exchange
                                                                                                                              • Express10SecureExchange
                                                                                                                              • Express10CourierPack
                                                                                                                              • ExpressAM
                                                                                                                              • ExpressAMSecure
                                                                                                                              • ExpressAMExchange
                                                                                                                              • ExpressAMSecureExchange
                                                                                                                              • ExpressAMCourierPack
                                                                                                                              • ExpressPM
                                                                                                                              • ExpressPMSecure
                                                                                                                              • Express24
                                                                                                                              • Express24Large
                                                                                                                              • Express24Secure
                                                                                                                              • Express24Exchange
                                                                                                                              • Express24SecureExchange
                                                                                                                              • Express24CourierPack
                                                                                                                              • Express48
                                                                                                                              • Express48Large
                                                                                                                              • ParcelRiderPlus
                                                                                                                              • GlobalBulkDirect
                                                                                                                              • GlobalExpress
                                                                                                                              • GlobalExpressEnvelopeDelivery
                                                                                                                              • GlobalExpressPackDelivery
                                                                                                                              • GlobalValue
                                                                                                                              • GlobalPriority
                                                                                                                              • GlobalPriorityReturns
                                                                                                                              • EuroPriorityHome
                                                                                                                              • EuroPriorityBusiness
                                                                                                                              • IrelandExpress
                                                                                                                              PARCLL
                                                                                                                              • ECOWE (Economy West)
                                                                                                                              • ECOCE (Economy Central)
                                                                                                                              • ECONE (Economy Northeast)
                                                                                                                              • ECOEA (Economy East)
                                                                                                                              • ECOSO (Economy South)
                                                                                                                              • EXPWE (Expedited West)
                                                                                                                              • EXPBNE (Expedited Northeast)
                                                                                                                              • REGWE (Regional West)
                                                                                                                              • REGCE (Regional Central)
                                                                                                                              • REGNE (Regional Northeast)
                                                                                                                              • REGEA (Regional East)
                                                                                                                              • REGSO (Regional South)
                                                                                                                              • CAECOWE (US to CA Economy)
                                                                                                                              • CAECOCE (US to CA Economy)
                                                                                                                              • CAECONE (US to CA Economy)
                                                                                                                              • EUECOWE (US to Europe Economy)
                                                                                                                              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
                                                                                                                                  Royal Mail
                                                                                                                                  • InternationalSigned
                                                                                                                                  • InternationalStandard
                                                                                                                                  • InternationalTracked
                                                                                                                                  • InternationalTrackedAndSigned
                                                                                                                                  • 1stClass
                                                                                                                                  • 1stClassSignedFor
                                                                                                                                  • 2ndClass
                                                                                                                                  • 2ndClassSignedFor
                                                                                                                                  • RoyalMail24
                                                                                                                                  • RoyalMail24SignedFor
                                                                                                                                  • RoyalMail48
                                                                                                                                  • RoyalMail48SignedFor
                                                                                                                                  • SpecialDeliveryGuaranteed1pm
                                                                                                                                  • SpecialDeliveryGuaranteed9am
                                                                                                                                  • StandardLetter1stClass
                                                                                                                                  • StandardLetter1stClassSignedFor
                                                                                                                                  • StandardLetter2ndClass
                                                                                                                                  • StandardLetter2ndClassSignedFor
                                                                                                                                  • Tracked24
                                                                                                                                  • Tracked24HighVolume
                                                                                                                                  • Tracked24HighVolumeSignature
                                                                                                                                  • Tracked24Signature
                                                                                                                                  • Tracked48
                                                                                                                                  • Tracked48HighVolume
                                                                                                                                  • Tracked48HighVolumeSignature
                                                                                                                                  • Tracked48Signature
                                                                                                                                  SEKO OmniParcel
                                                                                                                                  • Ecommerce Standard Tracked
                                                                                                                                  • Ecommerce Express Tracked
                                                                                                                                  • Domestic Express
                                                                                                                                  • Domestic Standard
                                                                                                                                  Sendle
                                                                                                                                  • Standard
                                                                                                                                  • Express
                                                                                                                                  SF Express
                                                                                                                                  • International Standard Express - Doc
                                                                                                                                  • International Standard Express - Parcel
                                                                                                                                  • International Economy Express - Pilot
                                                                                                                                  • International Economy Express - Doc
                                                                                                                                  SmartKargo
                                                                                                                                  • EPR
                                                                                                                                  Sonic
                                                                                                                                  • NEXTDAY
                                                                                                                                  • 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
                                                                                                                                    • First
                                                                                                                                    • Priority
                                                                                                                                    • ExpeditedMailInnovations
                                                                                                                                    • PriorityMailInnovations
                                                                                                                                    • EconomyMailInnovations
                                                                                                                                    USPS
                                                                                                                                    • First
                                                                                                                                    • Priority
                                                                                                                                    • Express
                                                                                                                                    • ParcelSelect
                                                                                                                                    • 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
                                                                                                                                      using System;
                                                                                                                                      using System.Collections.Generic;
                                                                                                                                      using System.Threading.Tasks;
                                                                                                                                      using Newtonsoft.Json;
                                                                                                                                      using EasyPost;
                                                                                                                                      using EasyPost.Models.API;
                                                                                                                                      
                                                                                                                                      namespace EasyPostExamples
                                                                                                                                      {
                                                                                                                                          public class Examples
                                                                                                                                          {
                                                                                                                                              public static async Task Main()
                                                                                                                                              {
                                                                                                                                                  string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                                      
                                                                                                                                                  var client = new EasyPost.Client(apiKey);
                                                                                                                                      
                                                                                                                                                  Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                                      
                                                                                                                                                  await shipment.RegenerateRates();
                                                                                                                                      
                                                                                                                                                  Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      }
                                                                                                                                      {
                                                                                                                                        "rates": [
                                                                                                                                          {
                                                                                                                                            "id": "rate_a3e303af85f44ec99ee59a6fe6ecdf67",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:17:47Z",
                                                                                                                                            "updated_at": "2022-10-17T17:17:47Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Priority",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "10.07",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "13.45",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "10.07",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "shipment_id": "shp_156e61f4875f4b07bba0a2fc8a31382a",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_9f9e6fb60b6d4677b71780c915458ec4",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:17:47Z",
                                                                                                                                            "updated_at": "2022-10-17T17:17:47Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Express",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "44.55",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "51.30",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "44.55",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": null,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": null,
                                                                                                                                            "shipment_id": "shp_156e61f4875f4b07bba0a2fc8a31382a",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_858f18770784480ea5d9252d0cff178f",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:17:47Z",
                                                                                                                                            "updated_at": "2022-10-17T17:17:47Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "ParcelSelect",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "9.16",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "9.16",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "9.16",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 5,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 5,
                                                                                                                                            "shipment_id": "shp_156e61f4875f4b07bba0a2fc8a31382a",
                                                                                                                                            "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
                                                                                                                                      using System;
                                                                                                                                      using System.Collections.Generic;
                                                                                                                                      using System.Threading.Tasks;
                                                                                                                                      using Newtonsoft.Json;
                                                                                                                                      using EasyPost;
                                                                                                                                      using EasyPost.Models.API;
                                                                                                                                      
                                                                                                                                      namespace EasyPostExamples
                                                                                                                                      {
                                                                                                                                          public class Examples
                                                                                                                                          {
                                                                                                                                              public static async Task Main()
                                                                                                                                              {
                                                                                                                                                  string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                                      
                                                                                                                                                  var client = new EasyPost.Client(apiKey);
                                                                                                                                      
                                                                                                                                                  Shipment shipment = await client.Shipment.Create(new Dictionary<string, object>()
                                                                                                                                                      {
                                                                                                                                                          {
                                                                                                                                                              "to_address", new Dictionary<string, object>()
                                                                                                                                                              {
                                                                                                                                                                  { "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" }
                                                                                                                                                              }
                                                                                                                                                          },
                                                                                                                                                          {
                                                                                                                                                              "from_address", new Dictionary<string, object>()
                                                                                                                                                              {
                                                                                                                                                                  { "name", "EasyPost" },
                                                                                                                                                                  { "street1", "417 Montgomery Street" },
                                                                                                                                                                  { "street2", "5th Floor" },
                                                                                                                                                                  { "city", "San Francisco" },
                                                                                                                                                                  { "state", "CA" },
                                                                                                                                                                  { "zip", "94104" },
                                                                                                                                                                  { "country", "US" },
                                                                                                                                                                  { "phone", "4153334445" },
                                                                                                                                                                  { "email", "support@easypost.com" }
                                                                                                                                                              }
                                                                                                                                                          },
                                                                                                                                                          {
                                                                                                                                                              "parcel", new Dictionary<string, object>()
                                                                                                                                                              {
                                                                                                                                                                  { "length", 20.2 },
                                                                                                                                                                  { "width", 10.9 },
                                                                                                                                                                  { "height", 5 },
                                                                                                                                                                  { "weight", 65.9 }
                                                                                                                                                              }
                                                                                                                                                          }
                                                                                                                                                      });
                                                                                                                                      
                                                                                                                                                  List<StatelessRate> rates = await client.Beta.Rate.RetrieveStatelessRates(shipment);
                                                                                                                                      
                                                                                                                                                  Console.WriteLine(JsonConvert.SerializeObject(rates, Formatting.Indented));
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      }
                                                                                                                                      {
                                                                                                                                        "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": "production",
                                                                                                                                            "service": "Express",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "44.55",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "51.30",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "44.55",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": null,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": null,
                                                                                                                                            "carrier_account_id": "ca_fe6c4f1489b545d49b698d4712fd4b95"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "ParcelSelect",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "9.16",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "9.16",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "9.16",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 5,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 5,
                                                                                                                                            "carrier_account_id": "ca_fe6c4f1489b545d49b698d4712fd4b95"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "Priority",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "10.07",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "13.45",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "10.07",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "carrier_account_id": "ca_fe6c4f1489b545d49b698d4712fd4b95"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "3DaySelect",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "11.38",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "30.21",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "31.89",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 3,
                                                                                                                                            "delivery_date": "2022-11-28T23:00:00Z",
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 3,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "NextDayAirEarlyAM",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "78.35",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "154.49",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "161.74",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 1,
                                                                                                                                            "delivery_date": "2022-11-23T08:00:00Z",
                                                                                                                                            "delivery_date_guaranteed": true,
                                                                                                                                            "est_delivery_days": 1,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "2ndDayAirAM",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "17.00",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "43.99",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "47.57",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": "2022-11-25T23:00:00Z",
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "Ground",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "9.25",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "15.05",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "16.04",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": "2022-11-25T23:00:00Z",
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "NextDayAirSaver",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "42.79",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "115.11",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "120.97",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 1,
                                                                                                                                            "delivery_date": "2022-11-23T23:00:00Z",
                                                                                                                                            "delivery_date_guaranteed": true,
                                                                                                                                            "est_delivery_days": 1,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "NextDayAir",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "48.35",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "118.71",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "125.96",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 1,
                                                                                                                                            "delivery_date": "2022-11-23T10:30:00Z",
                                                                                                                                            "delivery_date_guaranteed": true,
                                                                                                                                            "est_delivery_days": 1,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Rate",
                                                                                                                                            "mode": "production",
                                                                                                                                            "service": "2ndDayAir",
                                                                                                                                            "carrier": "UPSDAP",
                                                                                                                                            "rate": "15.49",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "39.28",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "42.92",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": "2022-11-25T23:00:00Z",
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "carrier_account_id": "ca_8f1074ead87444788a1664b90399bc0a"
                                                                                                                                          }
                                                                                                                                        ],
                                                                                                                                        "options": {
                                                                                                                                          "currency": "USD",
                                                                                                                                          "payment": {
                                                                                                                                            "type": "SENDER"
                                                                                                                                          },
                                                                                                                                          "date_advance": 0
                                                                                                                                        },
                                                                                                                                        "parcel": {
                                                                                                                                          "object": "Parcel",
                                                                                                                                          "length": 20.2,
                                                                                                                                          "width": 10.9,
                                                                                                                                          "height": 5,
                                                                                                                                          "weight": 65
                                                                                                                                        },
                                                                                                                                        "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
                                                                                                                                      using System;
                                                                                                                                      using System.Collections.Generic;
                                                                                                                                      using System.Threading.Tasks;
                                                                                                                                      using Newtonsoft.Json;
                                                                                                                                      using EasyPost;
                                                                                                                                      using EasyPost.Models.API;
                                                                                                                                      
                                                                                                                                      namespace EasyPostExamples
                                                                                                                                      {
                                                                                                                                          public class Examples
                                                                                                                                          {
                                                                                                                                              public static async Task Main()
                                                                                                                                              {
                                                                                                                                                  string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                                      
                                                                                                                                                  var client = new EasyPost.Client(apiKey);
                                                                                                                                      
                                                                                                                                                  Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                                      
                                                                                                                                                  await shipment.GetSmartrates();
                                                                                                                                      
                                                                                                                                                  Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      }
                                                                                                                                      {
                                                                                                                                        "result": [
                                                                                                                                          {
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                            "created_at": "2022-10-17T17:17:55Z",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "id": "rate_6493b85ff79d4715a3c7e4ee33e3b05f",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "list_rate": 10.07,
                                                                                                                                            "mode": "test",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "rate": 10.07,
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "retail_rate": 13.45,
                                                                                                                                            "service": "Priority",
                                                                                                                                            "shipment_id": "shp_366d663986a9411db28f50a414a71d94",
                                                                                                                                            "time_in_transit": {
                                                                                                                                              "percentile_50": 2,
                                                                                                                                              "percentile_75": 2,
                                                                                                                                              "percentile_85": 2,
                                                                                                                                              "percentile_90": 2,
                                                                                                                                              "percentile_95": 3,
                                                                                                                                              "percentile_97": 3,
                                                                                                                                              "percentile_99": 3
                                                                                                                                            },
                                                                                                                                            "updated_at": "2022-10-17T17:17:55Z"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                            "created_at": "2022-10-17T17:17:55Z",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "delivery_days": 5,
                                                                                                                                            "est_delivery_days": 5,
                                                                                                                                            "id": "rate_1c6d149e4267411eb8e7ce4466265db1",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "list_rate": 9.16,
                                                                                                                                            "mode": "test",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "rate": 9.16,
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "retail_rate": 9.16,
                                                                                                                                            "service": "ParcelSelect",
                                                                                                                                            "shipment_id": "shp_366d663986a9411db28f50a414a71d94",
                                                                                                                                            "time_in_transit": {
                                                                                                                                              "percentile_50": 1,
                                                                                                                                              "percentile_75": 2,
                                                                                                                                              "percentile_85": 2,
                                                                                                                                              "percentile_90": 3,
                                                                                                                                              "percentile_95": 4,
                                                                                                                                              "percentile_97": 5,
                                                                                                                                              "percentile_99": 9
                                                                                                                                            },
                                                                                                                                            "updated_at": "2022-10-17T17:17:55Z"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac",
                                                                                                                                            "created_at": "2022-10-17T17:17:55Z",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "delivery_days": null,
                                                                                                                                            "est_delivery_days": null,
                                                                                                                                            "id": "rate_a7c7bd25be7c4903a96e86ef1463b7f1",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "list_rate": 44.55,
                                                                                                                                            "mode": "test",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "rate": 44.55,
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "retail_rate": 51.3,
                                                                                                                                            "service": "Express",
                                                                                                                                            "shipment_id": "shp_366d663986a9411db28f50a414a71d94",
                                                                                                                                            "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": "2022-10-17T17:17:55Z"
                                                                                                                                          }
                                                                                                                                        ]
                                                                                                                                      }

                                                                                                                                      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
                                                                                                                                      using System;
                                                                                                                                      using System.Collections.Generic;
                                                                                                                                      using System.Threading.Tasks;
                                                                                                                                      using Newtonsoft.Json;
                                                                                                                                      using EasyPost;
                                                                                                                                      using EasyPost.Models.API;
                                                                                                                                      
                                                                                                                                      namespace EasyPostExamples
                                                                                                                                      {
                                                                                                                                          public class Examples
                                                                                                                                          {
                                                                                                                                              public static async Task Main()
                                                                                                                                              {
                                                                                                                                                  string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                                      
                                                                                                                                                  var client = new EasyPost.Client(apiKey);
                                                                                                                                      
                                                                                                                                                  Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                                      
                                                                                                                                                  await shipment.Insure(200);
                                                                                                                                      
                                                                                                                                                  Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      }
                                                                                                                                      {
                                                                                                                                        "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                        "is_return": false,
                                                                                                                                        "messages": [],
                                                                                                                                        "mode": "test",
                                                                                                                                        "options": {
                                                                                                                                          "currency": "USD",
                                                                                                                                          "payment": {
                                                                                                                                            "type": "SENDER"
                                                                                                                                          },
                                                                                                                                          "date_advance": 0
                                                                                                                                        },
                                                                                                                                        "reference": null,
                                                                                                                                        "status": "unknown",
                                                                                                                                        "tracking_code": "9405500106068143633037",
                                                                                                                                        "updated_at": "2022-10-17T17:17:52Z",
                                                                                                                                        "batch_id": null,
                                                                                                                                        "batch_status": null,
                                                                                                                                        "batch_message": null,
                                                                                                                                        "customs_info": {
                                                                                                                                          "id": "cstinfo_0f04d9d807d947469963c7736f83d20c",
                                                                                                                                          "object": "CustomsInfo",
                                                                                                                                          "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                          "updated_at": "2022-10-17T17:17:51Z",
                                                                                                                                          "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_0b24c580be42449eae7d829bc97f1595",
                                                                                                                                              "object": "CustomsItem",
                                                                                                                                              "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                              "updated_at": "2022-10-17T17:17:51Z",
                                                                                                                                              "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_a187bac64e3f11ed878cac1f6b0a0d1e",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:17:51+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:17:51+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": "100.00",
                                                                                                                                        "order_id": null,
                                                                                                                                        "parcel": {
                                                                                                                                          "id": "prcl_8fddeed324d74077ac053c064a9948bc",
                                                                                                                                          "object": "Parcel",
                                                                                                                                          "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                          "updated_at": "2022-10-17T17:17:51Z",
                                                                                                                                          "length": 20.2,
                                                                                                                                          "width": 10.9,
                                                                                                                                          "height": 5.0,
                                                                                                                                          "predefined_package": null,
                                                                                                                                          "weight": 65.9,
                                                                                                                                          "mode": "test"
                                                                                                                                        },
                                                                                                                                        "postage_label": {
                                                                                                                                          "object": "PostageLabel",
                                                                                                                                          "id": "pl_9eb27c6359d44c1b9231a7222128611c",
                                                                                                                                          "created_at": "2022-10-17T17:17:52Z",
                                                                                                                                          "updated_at": "2022-10-17T17:17:52Z",
                                                                                                                                          "date_advance": 0,
                                                                                                                                          "integrated_form": "none",
                                                                                                                                          "label_date": "2022-10-17T17:17:52Z",
                                                                                                                                          "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/20221017/ad88313e07e24f9381adc20863f7d658.png",
                                                                                                                                          "label_pdf_url": null,
                                                                                                                                          "label_zpl_url": null,
                                                                                                                                          "label_epl2_url": null,
                                                                                                                                          "label_file": null
                                                                                                                                        },
                                                                                                                                        "rates": [
                                                                                                                                          {
                                                                                                                                            "id": "rate_fcbd520d801d435eadba4941200e6f40",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                            "updated_at": "2022-10-17T17:17:51Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "ParcelSelect",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "9.16",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "9.16",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "9.16",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 5,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 5,
                                                                                                                                            "shipment_id": "shp_520cd2ca0ca347bf94572e3e99ddc92e",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_f41c223a424245a2904a2a9b0554f22a",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                            "updated_at": "2022-10-17T17:17:51Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Express",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "44.55",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "51.30",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "44.55",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": null,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": null,
                                                                                                                                            "shipment_id": "shp_520cd2ca0ca347bf94572e3e99ddc92e",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_2c834529a62a4527b0ac63d7d10fc875",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:17:51Z",
                                                                                                                                            "updated_at": "2022-10-17T17:17:51Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Priority",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "10.07",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "13.45",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "10.07",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "shipment_id": "shp_520cd2ca0ca347bf94572e3e99ddc92e",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          }
                                                                                                                                        ],
                                                                                                                                        "refund_status": null,
                                                                                                                                        "scan_form": null,
                                                                                                                                        "selected_rate": {
                                                                                                                                          "id": "rate_2c834529a62a4527b0ac63d7d10fc875",
                                                                                                                                          "object": "Rate",
                                                                                                                                          "created_at": "2022-10-17T17:17:52Z",
                                                                                                                                          "updated_at": "2022-10-17T17:17:52Z",
                                                                                                                                          "mode": "test",
                                                                                                                                          "service": "Priority",
                                                                                                                                          "carrier": "USPS",
                                                                                                                                          "rate": "10.07",
                                                                                                                                          "currency": "USD",
                                                                                                                                          "retail_rate": "13.45",
                                                                                                                                          "retail_currency": "USD",
                                                                                                                                          "list_rate": "10.07",
                                                                                                                                          "list_currency": "USD",
                                                                                                                                          "billing_type": "easypost",
                                                                                                                                          "delivery_days": 2,
                                                                                                                                          "delivery_date": null,
                                                                                                                                          "delivery_date_guaranteed": false,
                                                                                                                                          "est_delivery_days": 2,
                                                                                                                                          "shipment_id": "shp_520cd2ca0ca347bf94572e3e99ddc92e",
                                                                                                                                          "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                        },
                                                                                                                                        "tracker": {
                                                                                                                                          "id": "trk_88f6d7f440d34317a46d67c837d172f3",
                                                                                                                                          "object": "Tracker",
                                                                                                                                          "mode": "test",
                                                                                                                                          "tracking_code": "9405500106068143633037",
                                                                                                                                          "status": "pre_transit",
                                                                                                                                          "status_detail": "status_update",
                                                                                                                                          "created_at": "2022-10-17T17:17:52Z",
                                                                                                                                          "updated_at": "2022-10-17T17:17:52Z",
                                                                                                                                          "signed_by": null,
                                                                                                                                          "weight": null,
                                                                                                                                          "est_delivery_date": "2022-10-17T17:17:52Z",
                                                                                                                                          "shipment_id": "shp_520cd2ca0ca347bf94572e3e99ddc92e",
                                                                                                                                          "carrier": "USPS",
                                                                                                                                          "tracking_details": [
                                                                                                                                            {
                                                                                                                                              "object": "TrackingDetail",
                                                                                                                                              "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                                              "description": null,
                                                                                                                                              "status": "pre_transit",
                                                                                                                                              "status_detail": "status_update",
                                                                                                                                              "datetime": "2022-09-17T17:17:52Z",
                                                                                                                                              "source": "USPS",
                                                                                                                                              "carrier_code": null,
                                                                                                                                              "tracking_location": {
                                                                                                                                                "object": "TrackingLocation",
                                                                                                                                                "city": null,
                                                                                                                                                "state": null,
                                                                                                                                                "country": null,
                                                                                                                                                "zip": null
                                                                                                                                              }
                                                                                                                                            },
                                                                                                                                            {
                                                                                                                                              "object": "TrackingDetail",
                                                                                                                                              "message": "Shipping Label Created",
                                                                                                                                              "description": null,
                                                                                                                                              "status": "pre_transit",
                                                                                                                                              "status_detail": "status_update",
                                                                                                                                              "datetime": "2022-09-18T05:54:52Z",
                                                                                                                                              "source": "USPS",
                                                                                                                                              "carrier_code": null,
                                                                                                                                              "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/djE6dHJrXzg4ZjZkN2Y0NDBkMzQzMTdhNDZkNjdjODM3ZDE3MmYz"
                                                                                                                                        },
                                                                                                                                        "to_address": {
                                                                                                                                          "id": "adr_a18503e74e3f11edab1cac1f6bc72124",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:17:51+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:17: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"
                                                                                                                                              }
                                                                                                                                            }
                                                                                                                                          }
                                                                                                                                        },
                                                                                                                                        "usps_zone": 4,
                                                                                                                                        "return_address": {
                                                                                                                                          "id": "adr_a187bac64e3f11ed878cac1f6b0a0d1e",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:17:51+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:17:51+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_a18503e74e3f11edab1cac1f6bc72124",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:17:51+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:17: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"
                                                                                                                                              }
                                                                                                                                            }
                                                                                                                                          }
                                                                                                                                        },
                                                                                                                                        "forms": [],
                                                                                                                                        "fees": [
                                                                                                                                          {
                                                                                                                                            "object": "Fee",
                                                                                                                                            "type": "LabelFee",
                                                                                                                                            "amount": "0.00000",
                                                                                                                                            "charged": true,
                                                                                                                                            "refunded": false
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Fee",
                                                                                                                                            "type": "PostageFee",
                                                                                                                                            "amount": "10.07000",
                                                                                                                                            "charged": true,
                                                                                                                                            "refunded": false
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Fee",
                                                                                                                                            "type": "InsuranceFee",
                                                                                                                                            "amount": "0.50000",
                                                                                                                                            "charged": true,
                                                                                                                                            "refunded": false
                                                                                                                                          }
                                                                                                                                        ],
                                                                                                                                        "id": "shp_520cd2ca0ca347bf94572e3e99ddc92e",
                                                                                                                                        "object": "Shipment"
                                                                                                                                      }

                                                                                                                                      Refunds

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

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

                                                                                                                                      POST/shipments/:id/refund

                                                                                                                                      Refund a Shipment

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

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

                                                                                                                                      Example
                                                                                                                                      using System;
                                                                                                                                      using System.Collections.Generic;
                                                                                                                                      using System.Threading.Tasks;
                                                                                                                                      using Newtonsoft.Json;
                                                                                                                                      using EasyPost;
                                                                                                                                      using EasyPost.Models.API;
                                                                                                                                      
                                                                                                                                      namespace EasyPostExamples
                                                                                                                                      {
                                                                                                                                          public class Examples
                                                                                                                                          {
                                                                                                                                              public static async Task Main()
                                                                                                                                              {
                                                                                                                                                  string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                                      
                                                                                                                                                  var client = new EasyPost.Client(apiKey);
                                                                                                                                      
                                                                                                                                                  Shipment shipment = await client.Shipment.Retrieve("shp_...");
                                                                                                                                      
                                                                                                                                                  await shipment.Refund();
                                                                                                                                      
                                                                                                                                                  Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      }
                                                                                                                                      {
                                                                                                                                        "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                        "is_return": false,
                                                                                                                                        "messages": [],
                                                                                                                                        "mode": "test",
                                                                                                                                        "options": {
                                                                                                                                          "currency": "USD",
                                                                                                                                          "payment": {
                                                                                                                                            "type": "SENDER"
                                                                                                                                          },
                                                                                                                                          "date_advance": 0
                                                                                                                                        },
                                                                                                                                        "reference": null,
                                                                                                                                        "status": "unknown",
                                                                                                                                        "tracking_code": "9400100109361133189649",
                                                                                                                                        "updated_at": "2022-08-15T18:52:33Z",
                                                                                                                                        "batch_id": null,
                                                                                                                                        "batch_status": null,
                                                                                                                                        "batch_message": null,
                                                                                                                                        "customs_info": null,
                                                                                                                                        "from_address": {
                                                                                                                                          "id": "adr_6b3a95e91ccb11ed8d52ac1f6bc7b362",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "name": "Elizabeth Swan",
                                                                                                                                          "company": null,
                                                                                                                                          "street1": "179 N Harbor Dr",
                                                                                                                                          "street2": null,
                                                                                                                                          "city": "Redondo Beach",
                                                                                                                                          "state": "CA",
                                                                                                                                          "zip": "90277",
                                                                                                                                          "country": "US",
                                                                                                                                          "phone": "5555555555",
                                                                                                                                          "email": "test@example.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_5a5f599c461e4fb4b3a4203287d33b20",
                                                                                                                                          "object": "Parcel",
                                                                                                                                          "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                          "length": 10.0,
                                                                                                                                          "width": 8.0,
                                                                                                                                          "height": 4.0,
                                                                                                                                          "predefined_package": null,
                                                                                                                                          "weight": 15.4,
                                                                                                                                          "mode": "test"
                                                                                                                                        },
                                                                                                                                        "postage_label": {
                                                                                                                                          "object": "PostageLabel",
                                                                                                                                          "id": "pl_ec258275b23b442188418453e9fb5676",
                                                                                                                                          "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                          "date_advance": 0,
                                                                                                                                          "integrated_form": "none",
                                                                                                                                          "label_date": "2022-08-15T18:52:32Z",
                                                                                                                                          "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/20220815/58181e1d8470458091e20461157e59fb.png",
                                                                                                                                          "label_pdf_url": null,
                                                                                                                                          "label_zpl_url": null,
                                                                                                                                          "label_epl2_url": null,
                                                                                                                                          "label_file": null
                                                                                                                                        },
                                                                                                                                        "rates": [
                                                                                                                                          {
                                                                                                                                            "id": "rate_a644f6d8009042fe973945aedba3d145",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Express",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "29.50",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "33.55",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "29.50",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": null,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": null,
                                                                                                                                            "shipment_id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                            "carrier_account_id": "ca_b25657e9896e4d63ac8151ac346ac41e"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_99a5b1199ce14a56bcaab7897d289e52",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "ParcelSelect",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "7.75",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "7.75",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "7.75",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 5,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 5,
                                                                                                                                            "shipment_id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                            "carrier_account_id": "ca_b25657e9896e4d63ac8151ac346ac41e"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_d983c201994c4db2a79fdd8e2a627a88",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Priority",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "7.90",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "9.45",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "7.90",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "shipment_id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                            "carrier_account_id": "ca_b25657e9896e4d63ac8151ac346ac41e"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_bda77e7e3393400a845ae5c3c18a34dd",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "First",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "5.57",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "5.57",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "5.57",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 3,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 3,
                                                                                                                                            "shipment_id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                            "carrier_account_id": "ca_b25657e9896e4d63ac8151ac346ac41e"
                                                                                                                                          }
                                                                                                                                        ],
                                                                                                                                        "refund_status": "submitted",
                                                                                                                                        "scan_form": null,
                                                                                                                                        "selected_rate": {
                                                                                                                                          "id": "rate_bda77e7e3393400a845ae5c3c18a34dd",
                                                                                                                                          "object": "Rate",
                                                                                                                                          "created_at": "2022-08-15T18:52:32Z",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32Z",
                                                                                                                                          "mode": "test",
                                                                                                                                          "service": "First",
                                                                                                                                          "carrier": "USPS",
                                                                                                                                          "rate": "5.57",
                                                                                                                                          "currency": "USD",
                                                                                                                                          "retail_rate": "5.57",
                                                                                                                                          "retail_currency": "USD",
                                                                                                                                          "list_rate": "5.57",
                                                                                                                                          "list_currency": "USD",
                                                                                                                                          "billing_type": "easypost",
                                                                                                                                          "delivery_days": 3,
                                                                                                                                          "delivery_date": null,
                                                                                                                                          "delivery_date_guaranteed": false,
                                                                                                                                          "est_delivery_days": 3,
                                                                                                                                          "shipment_id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                          "carrier_account_id": "ca_b25657e9896e4d63ac8151ac346ac41e"
                                                                                                                                        },
                                                                                                                                        "tracker": {
                                                                                                                                          "id": "trk_8aa496f0b9e24b14a0e83f4d795b72ea",
                                                                                                                                          "object": "Tracker",
                                                                                                                                          "mode": "test",
                                                                                                                                          "tracking_code": "9400100109361133189649",
                                                                                                                                          "status": "pre_transit",
                                                                                                                                          "status_detail": "status_update",
                                                                                                                                          "created_at": "2022-08-15T18:52:33Z",
                                                                                                                                          "updated_at": "2022-08-15T18:52:33Z",
                                                                                                                                          "signed_by": null,
                                                                                                                                          "weight": null,
                                                                                                                                          "est_delivery_date": "2022-08-15T18:52:33Z",
                                                                                                                                          "shipment_id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                          "carrier": "USPS",
                                                                                                                                          "tracking_details": [
                                                                                                                                            {
                                                                                                                                              "object": "TrackingDetail",
                                                                                                                                              "message": "Pre-Shipment Info Sent to USPS",
                                                                                                                                              "description": null,
                                                                                                                                              "status": "pre_transit",
                                                                                                                                              "status_detail": "status_update",
                                                                                                                                              "datetime": "2022-07-15T18:52:33Z",
                                                                                                                                              "source": "USPS",
                                                                                                                                              "carrier_code": null,
                                                                                                                                              "tracking_location": {
                                                                                                                                                "object": "TrackingLocation",
                                                                                                                                                "city": null,
                                                                                                                                                "state": null,
                                                                                                                                                "country": null,
                                                                                                                                                "zip": null
                                                                                                                                              }
                                                                                                                                            },
                                                                                                                                            {
                                                                                                                                              "object": "TrackingDetail",
                                                                                                                                              "message": "Shipping Label Created",
                                                                                                                                              "description": null,
                                                                                                                                              "status": "pre_transit",
                                                                                                                                              "status_detail": "status_update",
                                                                                                                                              "datetime": "2022-07-16T07:29:33Z",
                                                                                                                                              "source": "USPS",
                                                                                                                                              "carrier_code": null,
                                                                                                                                              "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/djE6dHJrXzhhYTQ5NmYwYjllMjRiMTRhMGU4M2Y0ZDc5NWI3MmVh"
                                                                                                                                        },
                                                                                                                                        "to_address": {
                                                                                                                                          "id": "adr_6b38cc6b1ccb11ed89d1ac1f6b0a0d1e",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "name": "JACK SPARROW",
                                                                                                                                          "company": null,
                                                                                                                                          "street1": "388 TOWNSEND ST APT 20",
                                                                                                                                          "street2": null,
                                                                                                                                          "city": "SAN FRANCISCO",
                                                                                                                                          "state": "CA",
                                                                                                                                          "zip": "94107-1670",
                                                                                                                                          "country": "US",
                                                                                                                                          "phone": "5555555555",
                                                                                                                                          "email": "TEST@EXAMPLE.COM",
                                                                                                                                          "mode": "test",
                                                                                                                                          "carrier_facility": null,
                                                                                                                                          "residential": true,
                                                                                                                                          "federal_tax_id": null,
                                                                                                                                          "state_tax_id": null,
                                                                                                                                          "verifications": {
                                                                                                                                            "zip4": {
                                                                                                                                              "success": true,
                                                                                                                                              "errors": [],
                                                                                                                                              "details": null
                                                                                                                                            },
                                                                                                                                            "delivery": {
                                                                                                                                              "success": true,
                                                                                                                                              "errors": [],
                                                                                                                                              "details": {
                                                                                                                                                "latitude": 37.77551,
                                                                                                                                                "longitude": -122.39697,
                                                                                                                                                "time_zone": "America/Los_Angeles"
                                                                                                                                              }
                                                                                                                                            }
                                                                                                                                          }
                                                                                                                                        },
                                                                                                                                        "usps_zone": 4,
                                                                                                                                        "return_address": {
                                                                                                                                          "id": "adr_6b3a95e91ccb11ed8d52ac1f6bc7b362",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "name": "Elizabeth Swan",
                                                                                                                                          "company": null,
                                                                                                                                          "street1": "179 N Harbor Dr",
                                                                                                                                          "street2": null,
                                                                                                                                          "city": "Redondo Beach",
                                                                                                                                          "state": "CA",
                                                                                                                                          "zip": "90277",
                                                                                                                                          "country": "US",
                                                                                                                                          "phone": "5555555555",
                                                                                                                                          "email": "test@example.com",
                                                                                                                                          "mode": "test",
                                                                                                                                          "carrier_facility": null,
                                                                                                                                          "residential": null,
                                                                                                                                          "federal_tax_id": null,
                                                                                                                                          "state_tax_id": null,
                                                                                                                                          "verifications": {}
                                                                                                                                        },
                                                                                                                                        "buyer_address": {
                                                                                                                                          "id": "adr_6b38cc6b1ccb11ed89d1ac1f6b0a0d1e",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "updated_at": "2022-08-15T18:52:32+00:00",
                                                                                                                                          "name": "JACK SPARROW",
                                                                                                                                          "company": null,
                                                                                                                                          "street1": "388 TOWNSEND ST APT 20",
                                                                                                                                          "street2": null,
                                                                                                                                          "city": "SAN FRANCISCO",
                                                                                                                                          "state": "CA",
                                                                                                                                          "zip": "94107-1670",
                                                                                                                                          "country": "US",
                                                                                                                                          "phone": "5555555555",
                                                                                                                                          "email": "TEST@EXAMPLE.COM",
                                                                                                                                          "mode": "test",
                                                                                                                                          "carrier_facility": null,
                                                                                                                                          "residential": true,
                                                                                                                                          "federal_tax_id": null,
                                                                                                                                          "state_tax_id": null,
                                                                                                                                          "verifications": {
                                                                                                                                            "zip4": {
                                                                                                                                              "success": true,
                                                                                                                                              "errors": [],
                                                                                                                                              "details": null
                                                                                                                                            },
                                                                                                                                            "delivery": {
                                                                                                                                              "success": true,
                                                                                                                                              "errors": [],
                                                                                                                                              "details": {
                                                                                                                                                "latitude": 37.77551,
                                                                                                                                                "longitude": -122.39697,
                                                                                                                                                "time_zone": "America/Los_Angeles"
                                                                                                                                              }
                                                                                                                                            }
                                                                                                                                          }
                                                                                                                                        },
                                                                                                                                        "forms": [],
                                                                                                                                        "fees": [
                                                                                                                                          {
                                                                                                                                            "object": "Fee",
                                                                                                                                            "type": "LabelFee",
                                                                                                                                            "amount": "0.00000",
                                                                                                                                            "charged": true,
                                                                                                                                            "refunded": false
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "object": "Fee",
                                                                                                                                            "type": "PostageFee",
                                                                                                                                            "amount": "5.57000",
                                                                                                                                            "charged": true,
                                                                                                                                            "refunded": false
                                                                                                                                          }
                                                                                                                                        ],
                                                                                                                                        "id": "shp_9bdbc6ac0f3e4d9f87443f249d3c187b",
                                                                                                                                        "object": "Shipment"
                                                                                                                                      }

                                                                                                                                      Returns

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

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

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

                                                                                                                                      POST/shipments

                                                                                                                                      Create Return for a Shipment

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

                                                                                                                                      Request Parameters
                                                                                                                                      paramexample
                                                                                                                                      is_returntrue
                                                                                                                                      to_addressthe original Shipment's to_address
                                                                                                                                      from_addressthe original Shipment's from_address
                                                                                                                                      Example
                                                                                                                                      using System;
                                                                                                                                      using System.Collections.Generic;
                                                                                                                                      using System.Threading.Tasks;
                                                                                                                                      using Newtonsoft.Json;
                                                                                                                                      using EasyPost;
                                                                                                                                      using EasyPost.Models.API;
                                                                                                                                      
                                                                                                                                      namespace EasyPostExamples
                                                                                                                                      {
                                                                                                                                          public class Examples
                                                                                                                                          {
                                                                                                                                              public static async Task Main()
                                                                                                                                              {
                                                                                                                                                  string apiKey = Environment.GetEnvironmentVariable("EASYPOST_API_KEY")!;
                                                                                                                                      
                                                                                                                                                  var client = new EasyPost.Client(apiKey);
                                                                                                                                      
                                                                                                                                                  Shipment shipment = await client.Shipment.Create(new Dictionary<string, object>()
                                                                                                                                                  {
                                                                                                                                                      {
                                                                                                                                                          "to_address", new Dictionary<string, object>()
                                                                                                                                                          {
                                                                                                                                                              { "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" }
                                                                                                                                                          }
                                                                                                                                                      },
                                                                                                                                                      {
                                                                                                                                                          "from_address", new Dictionary<string, object>()
                                                                                                                                                          {
                                                                                                                                                              { "name", "EasyPost" },
                                                                                                                                                              { "street1", "417 Montgomery Street" },
                                                                                                                                                              { "street2", "5th Floor" },
                                                                                                                                                              { "city", "San Francisco" },
                                                                                                                                                              { "state", "CA" },
                                                                                                                                                              { "zip", "94104" },
                                                                                                                                                              { "country", "US" },
                                                                                                                                                              { "phone", "4153334445" },
                                                                                                                                                              { "email", "support@easypost.com" }
                                                                                                                                                          }
                                                                                                                                                      },
                                                                                                                                                      {
                                                                                                                                                          "parcel", new Dictionary<string, object>()
                                                                                                                                                          {
                                                                                                                                                              { "length", 20.2 },
                                                                                                                                                              { "width", 10.9 },
                                                                                                                                                              { "height", 5 },
                                                                                                                                                              { "weight", 65.9 }
                                                                                                                                                          }
                                                                                                                                                      },
                                                                                                                                                      { "is_return", true }
                                                                                                                                                  });
                                                                                                                                      
                                                                                                                                                  Console.WriteLine(JsonConvert.SerializeObject(shipment, Formatting.Indented));
                                                                                                                                              }
                                                                                                                                          }
                                                                                                                                      }
                                                                                                                                      {
                                                                                                                                        "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                        "is_return": true,
                                                                                                                                        "messages": [],
                                                                                                                                        "mode": "test",
                                                                                                                                        "options": {
                                                                                                                                          "currency": "USD",
                                                                                                                                          "payment": {
                                                                                                                                            "type": "SENDER"
                                                                                                                                          },
                                                                                                                                          "date_advance": 0
                                                                                                                                        },
                                                                                                                                        "reference": null,
                                                                                                                                        "status": "unknown",
                                                                                                                                        "tracking_code": null,
                                                                                                                                        "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                        "batch_id": null,
                                                                                                                                        "batch_status": null,
                                                                                                                                        "batch_message": null,
                                                                                                                                        "customs_info": {
                                                                                                                                          "id": "cstinfo_590a2a6ab6cd48bea0214a119ffc0321",
                                                                                                                                          "object": "CustomsInfo",
                                                                                                                                          "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                          "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                          "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_c7b5fd5c26724cecb525fd982c632aa0",
                                                                                                                                              "object": "CustomsItem",
                                                                                                                                              "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                              "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                              "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_ad3786924e3f11edaf1dac1f6bc72124",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:18:11+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:18:11+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_0146cfe66d34413d9fcde06e41c41ed6",
                                                                                                                                          "object": "Parcel",
                                                                                                                                          "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                          "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                          "length": 20.2,
                                                                                                                                          "width": 10.9,
                                                                                                                                          "height": 5.0,
                                                                                                                                          "predefined_package": null,
                                                                                                                                          "weight": 65.9,
                                                                                                                                          "mode": "test"
                                                                                                                                        },
                                                                                                                                        "postage_label": null,
                                                                                                                                        "rates": [
                                                                                                                                          {
                                                                                                                                            "id": "rate_66e38b23ffd841eb94dea3ffb1af0931",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                            "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Priority",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "10.07",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "13.45",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "10.07",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 2,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 2,
                                                                                                                                            "shipment_id": "shp_aa62909ea3a547c5a6747469c3ee7592",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_3c95fcb2bde8483990253e36b0971499",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                            "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "Express",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "44.55",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "51.30",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "44.55",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": null,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": null,
                                                                                                                                            "shipment_id": "shp_aa62909ea3a547c5a6747469c3ee7592",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          },
                                                                                                                                          {
                                                                                                                                            "id": "rate_0fb2337b022a4b68811e3dcf8bb9f8c9",
                                                                                                                                            "object": "Rate",
                                                                                                                                            "created_at": "2022-10-17T17:18:11Z",
                                                                                                                                            "updated_at": "2022-10-17T17:18:11Z",
                                                                                                                                            "mode": "test",
                                                                                                                                            "service": "ParcelSelect",
                                                                                                                                            "carrier": "USPS",
                                                                                                                                            "rate": "9.16",
                                                                                                                                            "currency": "USD",
                                                                                                                                            "retail_rate": "9.16",
                                                                                                                                            "retail_currency": "USD",
                                                                                                                                            "list_rate": "9.16",
                                                                                                                                            "list_currency": "USD",
                                                                                                                                            "billing_type": "easypost",
                                                                                                                                            "delivery_days": 5,
                                                                                                                                            "delivery_date": null,
                                                                                                                                            "delivery_date_guaranteed": false,
                                                                                                                                            "est_delivery_days": 5,
                                                                                                                                            "shipment_id": "shp_aa62909ea3a547c5a6747469c3ee7592",
                                                                                                                                            "carrier_account_id": "ca_9685a1198a75477885a3cdca37559bac"
                                                                                                                                          }
                                                                                                                                        ],
                                                                                                                                        "refund_status": null,
                                                                                                                                        "scan_form": null,
                                                                                                                                        "selected_rate": null,
                                                                                                                                        "tracker": null,
                                                                                                                                        "to_address": {
                                                                                                                                          "id": "adr_ad355a994e3f11ed8177ac1f6bc7b362",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:18:11+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:18:11+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_ad3786924e3f11edaf1dac1f6bc72124",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:18:11+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:18:11+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_ad355a994e3f11ed8177ac1f6bc7b362",
                                                                                                                                          "object": "Address",
                                                                                                                                          "created_at": "2022-10-17T17:18:11+00:00",
                                                                                                                                          "updated_at": "2022-10-17T17:18:11+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_aa62909ea3a547c5a6747469c3ee7592",
                                                                                                                                        "object": "Shipment"
                                                                                                                                      }

                                                                                                                                      TaxIdentifiers

                                                                                                                                      TaxIdentifiers are identifying numbers or IDs that are used to charge a specific party when dealing with the importing or exporting of good across international borders.

                                                                                                                                      TaxIdentifiers is a list of TaxIdentifier objects, which allows you to supply up to 8 Tax Identification numbers. The fields for the TaxIdentifier object are outlined below.

                                                                                                                                      TaxIdentifier Object

                                                                                                                                      attributetypespecification
                                                                                                                                      entitystringWhich entity the tax id belongs to ("SENDER" or "RECEIVER")
                                                                                                                                      tax_idstringThe actual tax id number
                                                                                                                                      tax_id_typestringThe type of tax id that is being used with the shipment (see possible types by carrier here)
                                                                                                                                      issuing_countrystringThe issuing country of the tax id number