First-time users and those looking for specific integration tutorials,
see our full API documentation and guides.
Download the API Specification yaml file
For example, the /addresses/
resource is reachable at https://api.goshippo.com/addresses/
.
In order to authenticate properly, please put Authorization: ShippoToken <token>
in your header. You can find your token on the
Shippo API settings page.
For more information about authentication and test mode, please visit our Authentication guide.
The API is available via Secure Socket Layer (SSL) only. All requests to the Shippo API must use TLS version 1.2 or higher.
Response data also formatted as JSON object. You can specify how many results per page are to be returned. For instance,
/rates/?results=25
will return up to 25 results.
Only the Carrier Accounts object can be updated via PUT requests. All other objects such as Addresses, Parcels, Shipments, Rates, Transactions, Refunds, Customs Items, and Customs Declarations are disposable. This means that once you have created an object, you cannot change it. Instead, create a new one with the desired values.
This reference guide supports the Shippo API version: 2018-02-08
.
To see reference guides for older API versions, see our legacy reference guide. For more information about Shippo API versions, see our API versions guide.
Addresses are the locations a parcel is being shipped from and to. They represent company and residential places. Among other things, you can use address objects to create shipments, calculate shipping rates, and purchase shipping labels.
Address represents the address as retrieved from the database
name | string required for purchase |
company | string Company Name |
street1 | string required for purchase |
street2 | string Second street line, 35 character limit. |
street3 | string Third street line, 35 character limit. Only accepted for USPS international shipments, UPS domestic and UPS international shipments. |
street_no | string Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany. |
city | string required for purchase |
state | string required for purchase for some countries |
zip | string required for purchase |
country required | string ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we reccomend using country codes like |
phone | string Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. |
string E-mail address of the contact person, RFC3696/5321-compliant. | |
is_residential | boolean |
metadata | string A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
is_complete | boolean Complete addresses contain all required values. |
latitude | number or string Latitude of address |
longitude | number or string Longitude of address |
object_created | string <date-time> Date and time of Address creation. |
object_id | string Unique identifier of the given Address object. This ID is required to create a Shipment object. |
object_owner | string Username of the user who created the Address object. |
object_updated | string <date-time> Date and time of last Address update. Since you cannot update Addresses after they were created, this time stamp reflects the time when the Address was changed by Shippo's systems for the last time, e.g., during the approximation of one or more values. |
object (AddressValidationResults) Object that contains information regarding if an address had been validated or not. Also contains any messages
generated during validation. Children keys are | |
test | boolean Indicates whether the object has been created in test mode. |
{- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}
Returns a list of all address objects that have been created in this account.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/addresses/ \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "next": "baseurl?page=3&results=10",
- "previous": "baseurl?page=1&results=10",
- "results": [
- {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}
]
}
Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
Address details.
name | string required for purchase |
company | string Company Name |
street1 | string required for purchase |
street2 | string Second street line, 35 character limit. |
street3 | string Third street line, 35 character limit. Only accepted for USPS international shipments, UPS domestic and UPS international shipments. |
street_no | string Street number of the addressed building. This field can be included in street1 for all carriers except for DHL Germany. |
city | string required for purchase |
state | string required for purchase for some countries |
zip | string required for purchase |
country required | string ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we reccomend using country codes like |
phone | string Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. |
string E-mail address of the contact person, RFC3696/5321-compliant. | |
is_residential | boolean |
metadata | string A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
validate | boolean Set to true to validate Address object. |
{- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "validate": true
}
{- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}
Returns an existing address using an object ID.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/addresses/d799c2679e644279b59fe661ac8fa488/ \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}
Validates an existing address using an object ID
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/addresses/d799c2679e644279b59fe661ac8fa488/validate/ \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}
A parcel is an item you are shipping. The parcel object includes details about its physical make-up of the parcel. It includes dimensions and weight that Shippo uses to calculate rates.
object (ParcelExtra) An object holding optional extra services to be requested for each parcel in a multi-piece shipment. See the Parcel Extra table below for all available services. | |
metadata | string |
mass_unit required | string (WeightUnitEnum) The unit used for weight. |
weight required | string Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
distance_unit required | string (DistanceUnitEnum) The measure unit used for length, width and height. |
height required | string Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
length required | string Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
width required | string Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
object_created | string <date-time> Date and time of Parcel creation. |
object_id | string Unique identifier of the given Parcel object. This ID is required to create a Shipment object. |
object_owner | string Username of the user who created the Parcel object. |
object_state | string A Parcel will only be valid when all required values have been sent and validated successfully. |
object_updated | string <date-time> Date and time of last Parcel update. Since you cannot update Parcels after they were created, this time stamp reflects the time when the Parcel was changed by Shippo's systems for the last time, e.g., during sorting the dimensions given. |
FedEx Parcel Template (string) or UPS Parcel Template (string) or USPS Parcel Template (string) or DHL eCommerce Parcel Template (string) or DPD UK Parcel Template (string) or Couriers Please Parcel Template (string) or Aramex Australia Parcel Template (string) (ParcelTemplateEnumSet) | |
test | boolean Indicates whether the object has been created in test mode. |
{- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
The following values are supported for the extra
field of the parcel object.
An object holding optional extra services to be requested for each parcel in a multi-piece shipment. See the Parcel Extra table below for all available services.
object (COD) Specify collection on delivery details (UPS only). | |
object (ParcelInsurance) To add insurace to your parcel, specify | |
reference_1 | string Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. |
reference_2 | string Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. |
{- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}
Returns a list of all parcel objects.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/parcels/ \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "next": "baseurl?page=3&results=10",
- "previous": "baseurl?page=1&results=10",
- "results": [
- {
- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
]
}
Creates a new parcel object.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
Parcel details.
object (ParcelExtra) An object holding optional extra services to be requested for each parcel in a multi-piece shipment. See the Parcel Extra table below for all available services. | |
metadata | string |
mass_unit required | string (WeightUnitEnum) The unit used for weight. |
weight required | string Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
distance_unit required | string (DistanceUnitEnum) The measure unit used for length, width and height. |
height required | string Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
length required | string Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
width required | string Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted. |
{- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1"
}
{- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
Returns parcel details using an existing parcel object ID (this will not return parcel details associated with un-purchased shipment/rate parcel object IDs).
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/parcels/7df2ecf8b4224763ab7c71fae7ec8274/ \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
A carrier parcel template represents a package used for shipping that has preset dimensions defined by a carrier. Some examples of a carrier parcel template include USPS Flat Rate Box and Fedex Small Pak. When using a carrier parcel template, the rates returned may be limited to the carrier that provides the box. You can create user parcel templates using a carrier parcel template. Shippo takes the dimensions of the carrier parcel template but you must configure the weight.
carrier | string The name of the carrier that provides this parcel template |
distance_unit | string (DistanceUnitEnum) The measure unit used for length, width and height. |
height | string The height of the package, in units specified by the distance_unit attribute |
is_variable_dimensions | boolean True if the carrier parcel template allows custom dimensions, such as USPS Softpack. |
length | string The length of the package, in units specified by the distance_unit attribute |
name | string The name of the carrier parcel template |
token | string The unique string representation of the carrier parcel template |
width | string The width of the package, in units specified by the distance_unit attribute |
{- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
List all carrier parcel template objects.
Use the following query string params to filter the results as needed.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/parcel-templates \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396" \ -H "Content-Type: application/json"
{- "results": [
- {
- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
]
}
Fetches the parcel template information for a specific carrier parcel template, identified by the token.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/parcel-templates/Fedex_Box_Small_1 \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396" \ -H "Content-Type: application/json"
{- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
A user parcel template represents a package used for shipping that has preset dimensions and attributes defined by you. They are useful for capturing attributes of parcel-types you frequently use for shipping, allowing them to be defined once and then used for many shipments. These parcel templates can also be used for live rates.
User parcel templates can also be created using a carrier parcel template, where the dimensions will be copied from the carrier presets, but the weight can be configured by you.
distance_unit | string (DistanceUnitEnum) The measure unit used for length, width and height. Required, but if using a preset carrier template then this field must be empty. |
height | string The height of the package, in units specified by the |
length | string The length of the package, in units specified by the |
name | string The name of the User Parcel Template |
weight | string The weight of the package, in units specified by the weight_unit attribute. |
weight_unit | string (WeightUnitEnum) The unit used for weight. |
width | string The width of the package, in units specified by the |
object_created | string <date-time> Date and time of User Parcel Template creation |
object_id | string Unique identifier of the given User Parcel Template object |
object_owner | string Username of the user who created the User Parcel Template object |
object_updated | string <date-time> Date and time of last update on User Parcel Template |
object (CarrierParcelTemplate) |
{- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8",
- "object_created": "2013-12-11T19:38:09.729Z",
- "object_id": "b958d3690bb04bb8b2986724872750f5",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2013-12-12T19:38:09.729Z",
- "template": {
- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
}
Returns a list all of all user parcel template objects.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/user-parcel-templates \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396" \ -H "Content-Type: application/json"
{- "results": [
- {
- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8",
- "object_created": "2013-12-11T19:38:09.729Z",
- "object_id": "b958d3690bb04bb8b2986724872750f5",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2013-12-12T19:38:09.729Z",
- "template": {
- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
}
]
}
Creates a new user parcel template.
You can choose to create a
parcel template using a preset carrier template as a starting point, or
you can create an entirely custom one. To use a preset carrier template,
pass in a unique template token from this list
plus the weight fields (weight and weight_unit). Otherwise, omit
the template field and pass the other fields, for the weight, length, height,
and depth, as well as their units."
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
{- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8"
}
{- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8",
- "object_created": "2013-12-11T19:38:09.729Z",
- "object_id": "b958d3690bb04bb8b2986724872750f5",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2013-12-12T19:38:09.729Z",
- "template": {
- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
}
Deletes a user parcel template using an object ID.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
The user parcel template was successfully deleted.
curl -X DELETE https://api.goshippo.com/user-parcel-templates/{UserParcelTemplateObjectId} \ -H "Authorization: ShippoToken <API_TOKEN>"
{ }
Returns the parcel template information for a specific user parcel template, identified by the object ID.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl /user-parcel-templates/{UserParcelTemplateToken} \ -H "Authorization: ShippoToken <API_TOKEN>" \ -H "Content-Type: application/json"
{- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8",
- "object_created": "2013-12-11T19:38:09.729Z",
- "object_id": "b958d3690bb04bb8b2986724872750f5",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2013-12-12T19:38:09.729Z",
- "template": {
- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
}
Updates an existing user parcel template.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
{- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8"
}
{- "distance_unit": "in",
- "height": "6",
- "length": "10",
- "name": "My Custom Template",
- "weight": "12",
- "weight_unit": "lb",
- "width": "8",
- "object_created": "2013-12-11T19:38:09.729Z",
- "object_id": "b958d3690bb04bb8b2986724872750f5",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2013-12-12T19:38:09.729Z",
- "template": {
- "carrier": "FedEx",
- "distance_unit": "in",
- "height": "1.5",
- "is_variable_dimensions": false,
- "length": "12.375",
- "name": "FedEx® Small Box (S1)",
- "token": "FedEx_Box_Small_1",
- "width": "10.875"
}
}
A shipment is the act of transporting goods. A shipment object contains to and from addresses, and the parcel details that you are shipping. You can use the shipment object to retrieve shipping rates and purchase a shipping label.
Shipment represents the parcel as retrieved from the database
object (ShipmentExtra) An object holding optional extra services to be requested. | |
metadata required | string A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
shipment_date | string Date the shipment will be tendered to the carrier. Must be in the format |
required | object (AddressFrom) Address object of the sender / seller. Will be returned expanded by default. |
object (AddressReturn) ID of the Address object where the shipment will be sent back to if it is not delivered
(Only available for UPS, USPS, and Fedex shipments). | |
required | object (AddressTo) Address object of the recipient / buyer. Will be returned expanded by default. |
carrier_accounts required | Array of strings An array of object_ids of the carrier account objects to be used for getting shipping rates for this shipment.
If no carrier account object_ids are set in this field, Shippo will attempt to generate rates using all the
carrier accounts that have the |
object (CustomsDeclaration) | |
required | Array of objects (ResponseMessageList) |
object_created required | string <date-time> Date and time of Shipment creation. |
object_id required | string Unique identifier of the given Shipment object. |
object_owner required | string Username of the user who created the Shipment object. |
object_updated required | string <date-time> Date and time of last Shipment update. |
required | Array of objects (Parcel) List of Parcel objects to be shipped. |
required | Array of objects (Rate) An array with all available rates. If |
status required | string
|
test | boolean Indicates whether the object has been created in test mode. |
{- "extra": {
- "accounts_receivable_customer_account": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "alcohol": {
- "contains_alcohol": true,
- "recipient_type": "licensee"
}, - "ancillary_endorsement": "FORWARDING_SERVICE_REQUESTED",
- "appropriation_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "authority_to_leave": true,
- "bill_of_lading_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "billing": {
- "account": "string",
- "country": "string",
- "participation_code": "string",
- "type": "SENDER",
- "zip": "string"
}, - "bypass_address_validation": true,
- "carbon_neutral": true,
- "carrier_hub_id": "string",
- "carrier_hub_travel_time": 0,
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "cod_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "container_type": "string",
- "critical_pull_time": "string",
- "customer_branch": "string",
- "customer_reference": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "dangerous_goods": {
- "contains": true,
- "biological_material": {
- "contains": true
}, - "lithium_batteries": {
- "contains": true
}
}, - "dangerous_goods_code": "01",
- "dealer_order_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "delivery_instructions": "string",
- "dept_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 3
}, - "dry_ice": {
- "contains_dry_ice": true,
- "weight": "string"
}, - "fda_product_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "fulfillment_center": "string",
- "insurance": {
- "amount": "5.5",
- "content": "string",
- "currency": "USD",
- "provider": "FEDEX"
}, - "invoice_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "is_return": true,
- "lasership_attrs": [
- "TwoPersonDelivery"
], - "lasership_declared_value": "string",
- "manifest_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "model_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "part_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "po_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "preferred_delivery_timeframe": "10001200",
- "premium": true,
- "production_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "purchase_request_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "qr_code_requested": true,
- "reference_1": "string",
- "reference_2": "string",
- "request_retail_rates": true,
- "return_service_type": "PRINT_AND_MAIL",
- "rma_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "saturday_delivery": true,
- "salesperson_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "serial_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "signature_confirmation": "STANDARD",
- "store_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "transaction_reference_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}
}, - "metadata": "Customer ID 123456",
- "shipment_date": "2021-03-22T12:00:00Z",
- "address_from": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "address_return": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "address_to": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "carrier_accounts": [
- "string"
], - "customs_declaration": {
- "aes_itn": "string",
- "b13a_filing_option": "FILED_ELECTRONICALLY",
- "b13a_number": "string",
- "certificate": "string",
- "certify": true,
- "certify_signer": "Shawn Ippotle",
- "commercial_invoice": true,
- "contents_explanation": "T-Shirt purchase",
- "disclaimer": "string",
- "duties_payor": {
- "account": "2323434543",
- "type": "THIRD_PARTY",
- "address": {
- "name": "Patrick Kavanagh",
- "zip": "80331",
- "country": "DE"
}
}, - "exporter_identification": {
- "eori_number": "PL123456790ABCDE",
- "tax_id": {
- "number": "123456789",
- "type": "EIN"
}
}, - "exporter_reference": "string",
- "importer_reference": "string",
- "is_vat_collected": true,
- "invoice": "#123123",
- "license": "string",
- "metadata": "Order ID #123123",
- "notes": "string",
- "address_importer": "257ba08436604d2aaf069caafe7acb2a",
- "contents_type": "MERCHANDISE",
- "eel_pfc": "NOEEI_30_37_a",
- "incoterm": "DDP",
- "invoiced_charges": {
- "currency": "string",
- "total_shipping": "string",
- "total_taxes": "string",
- "total_duties": "string",
- "other_fees": "string"
}, - "items": [
- "5087f181d1dc4b14b73fdbf636498886"
], - "non_delivery_option": "RETURN",
- "object_created": "2014-07-17T01:01:08.306Z",
- "object_id": "e2197a54da9d470480f4f8796cc419cb",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-17T01:01:08.306Z",
- "test": true
}, - "messages": [
- {
- "source": "UPS",
- "code": "carrier_timeout",
- "text": "UPS API did not respond. Please try again in a few minutes."
}
], - "object_created": "2019-08-24T14:15:22Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "pp@gmail.com",
- "object_updated": "2019-08-24T14:15:22Z",
- "parcels": [
- {
- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
], - "rates": [
- {
- "amount": "5.5",
- "amount_local": "5.5",
- "currency": "USD",
- "currency_local": "USD",
- "arrives_by": "08:30:00",
- "attributes": [
- "BESTVALUE"
], - "carrier_account": "078870331023437cb917f5187429b093",
- "duration_terms": "Delivery in 1 to 3 business days",
- "estimated_days": 2,
- "included_insurance_price": "1.05",
- "messages": [
- {
- "source": "UPS",
- "code": "carrier_timeout",
- "text": "UPS API did not respond. Please try again in a few minutes."
}
], - "object_created": "2019-08-24T14:15:22Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "pp@gmail.com",
- "provider": "USPS",
- "servicelevel": {
- "name": "Priority Mail Express",
- "terms": "string",
- "token": "usps_priority_express",
- "extended_token": "string",
- "parent_servicelevel": {
- "name": "Priority Mail Express",
- "terms": "string",
- "token": "usps_priority_express",
- "extended_token": "string"
}
}, - "shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
- "test": true,
- "zone": "1"
}
], - "status": "QUEUED",
- "test": true
}
The following values are supported for the extra
field of the shipment object.
An object holding optional extra services to be requested.
object (UPSReferenceFields) UPS only. Adds custom accounts receivable customer account reference to UPS labels. | |
object (Alcohol) Indicates that a shipment contains Alcohol (Fedex and UPS only). | |
ancillary_endorsement | any Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only). |
object (UPSReferenceFields) UPS only. Adds custom appropriation number reference to UPS labels. | |
authority_to_leave | boolean Request |
object (UPSReferenceFields) UPS only. Adds custom bill of lading number reference to UPS labels. | |
object (Billing) Specify billing details (UPS, FedEx, and DHL Germany only). | |
bypass_address_validation | boolean Bypasses address validation (USPS, UPS, & LaserShip only). |
carbon_neutral | boolean Request carbon offsets by passing true (UPS only). |
carrier_hub_id | string Identifies the carrier injection site. |
carrier_hub_travel_time | integer Travel time in hours from fulfillment center to carrier injection site. |
object (COD) Specify collection on delivery details (UPS only). | |
object (UPSReferenceFields) UPS only. Adds custom COD number reference to UPS labels. | |
container_type | string Specify container type. |
critical_pull_time | string Carrier arrival time to pickup packages from the fulfillment center.
UTC format: |
customer_branch | string Specify customer branch (Lasership only). |
object (CustomerReference) Specify the reference field on the label (FedEx and UPS only). | |
object (DangerousGoodsObject) Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents are provided, only certain USPS service levels will be eligible. For more information, see our guide on hazardous or dangerous materials shipping. | |
dangerous_goods_code | any Dangerous Goods Code (DHL eCommerce only). See Category Codes |
object (UPSReferenceFields) UPS only. Adds custom dealer order number reference to UPS labels. | |
delivery_instructions | string Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only). |
object (DepartmentNumber) Specify the department number field on the label (FedEx and UPS only). | |
object (DryIce) Specify that the package contains Dry Ice (FedEx, Veho, and UPS only). | |
object (UPSReferenceFields) UPS only. Adds custom FDA product code reference to UPS labels. | |
fulfillment_center | string The fulfilment center where the package originates from. |
object (Insurance) To add 3rd party insurance powered by XCover,
specify | |
object (InvoiceNumber) Specify the invoice number field on the label (FedEx and UPS only). | |
is_return | boolean This field specifies if it is a scan-based return shipment. See the Create a return shipment section for more details. |
lasership_attrs | Array of strings (ShipmentExtraLasershipAttributesEnum) Specify Lasership Attributes (Lasership only). Multiple options accepted. |
lasership_declared_value | string Declared value (Lasership only). Defaults to |
object (UPSReferenceFields) UPS only. Adds custom manifest number reference to UPS labels. | |
object (UPSReferenceFields) UPS only. Adds custom model number reference to UPS labels. | |
object (UPSReferenceFields) UPS only. Adds custom part number reference to UPS labels. | |
object (PoNumber) Specify the PO number field on the label (FedEx and UPS only). | |
preferred_delivery_timeframe | any Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is |
premium | boolean Add premium service to a shipment (DHL Germany international shipments only). |
object (UPSReferenceFields) UPS only. Adds custom product code reference to UPS labels. | |
object (UPSReferenceFields) UPS only. Adds custom purchase request number reference to UPS labels. | |
qr_code_requested | boolean Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only). |
reference_1 | string Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. |
reference_2 | string Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. For DHL eCommerce, this field can be used for billing reference. |
request_retail_rates | boolean Returns retail rates instead of account-based rates (UPS and FedEx only). |
ShipmentExtraReturnServiceTypeUPSEnum (string) or ShipmentExtraReturnServiceTypeLasershipEnum (string) Request additional return option for return shipments (UPS and Lasership only). | |
object (RmaNumber) Specify the RMA number field on the label (FedEx and UPS only). | |
saturday_delivery | boolean Marks shipment as to be delivered on a Saturday. |
object (UPSReferenceFields) UPS only. Adds custom salesperson number reference to UPS labels. | |
object (UPSReferenceFields) UPS only. Adds custom serial number reference to UPS labels. | |
signature_confirmation | any Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) or Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only). |
object (UPSReferenceFields) UPS only. Adds custom store number reference to UPS labels. | |
object (UPSReferenceFields) UPS only. Adds custom transaction reference number to UPS labels. |
{- "accounts_receivable_customer_account": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "alcohol": {
- "contains_alcohol": true,
- "recipient_type": "licensee"
}, - "ancillary_endorsement": "FORWARDING_SERVICE_REQUESTED",
- "appropriation_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "authority_to_leave": true,
- "bill_of_lading_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "billing": {
- "account": "string",
- "country": "string",
- "participation_code": "string",
- "type": "SENDER",
- "zip": "string"
}, - "bypass_address_validation": true,
- "carbon_neutral": true,
- "carrier_hub_id": "string",
- "carrier_hub_travel_time": 0,
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "cod_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "container_type": "string",
- "critical_pull_time": "string",
- "customer_branch": "string",
- "customer_reference": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "dangerous_goods": {
- "contains": true,
- "biological_material": {
- "contains": true
}, - "lithium_batteries": {
- "contains": true
}
}, - "dangerous_goods_code": "01",
- "dealer_order_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "delivery_instructions": "string",
- "dept_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 3
}, - "dry_ice": {
- "contains_dry_ice": true,
- "weight": "string"
}, - "fda_product_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "fulfillment_center": "string",
- "insurance": {
- "amount": "5.5",
- "content": "string",
- "currency": "USD",
- "provider": "FEDEX"
}, - "invoice_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "is_return": true,
- "lasership_attrs": [
- "TwoPersonDelivery"
], - "lasership_declared_value": "string",
- "manifest_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "model_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "part_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "po_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "preferred_delivery_timeframe": "10001200",
- "premium": true,
- "production_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "purchase_request_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "qr_code_requested": true,
- "reference_1": "string",
- "reference_2": "string",
- "request_retail_rates": true,
- "return_service_type": "PRINT_AND_MAIL",
- "rma_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "saturday_delivery": true,
- "salesperson_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "serial_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "signature_confirmation": "STANDARD",
- "store_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "transaction_reference_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}
}
Returns a list of all shipment objects.
In order to filter results, you must use the below path parameters.
A maximum date range of 90 days is permitted.
Provided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).
Optional path parameters:
object_created_gt
- object(s) created greater than a provided date time
object_created_gte
- object(s) created greater than or equal to a provided date time
object_created_lt
- object(s) created less than a provided date time
object_created_lte
- object(s) created less than or equal to a provided date time
Date format examples:
2017-01-01
2017-01-01T03:30:30
or 2017-01-01T03:30:30.5
2017-01-01T03:30:30Z
Example URL:
https://api.goshippo.com/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/shipments/ \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "next": "baseurl?page=3&results=10",
- "previous": "baseurl?page=1&results=10",
- "results": [
- {
- "extra": {
- "accounts_receivable_customer_account": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "alcohol": {
- "contains_alcohol": true,
- "recipient_type": "licensee"
}, - "ancillary_endorsement": "FORWARDING_SERVICE_REQUESTED",
- "appropriation_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "authority_to_leave": true,
- "bill_of_lading_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "billing": {
- "account": "string",
- "country": "string",
- "participation_code": "string",
- "type": "SENDER",
- "zip": "string"
}, - "bypass_address_validation": true,
- "carbon_neutral": true,
- "carrier_hub_id": "string",
- "carrier_hub_travel_time": 0,
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "cod_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "container_type": "string",
- "critical_pull_time": "string",
- "customer_branch": "string",
- "customer_reference": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "dangerous_goods": {
- "contains": true,
- "biological_material": {
- "contains": true
}, - "lithium_batteries": {
- "contains": true
}
}, - "dangerous_goods_code": "01",
- "dealer_order_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "delivery_instructions": "string",
- "dept_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 3
}, - "dry_ice": {
- "contains_dry_ice": true,
- "weight": "string"
}, - "fda_product_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "fulfillment_center": "string",
- "insurance": {
- "amount": "5.5",
- "content": "string",
- "currency": "USD",
- "provider": "FEDEX"
}, - "invoice_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "is_return": true,
- "lasership_attrs": [
- "TwoPersonDelivery"
], - "lasership_declared_value": "string",
- "manifest_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "model_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "part_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "po_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "preferred_delivery_timeframe": "10001200",
- "premium": true,
- "production_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "purchase_request_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "qr_code_requested": true,
- "reference_1": "string",
- "reference_2": "string",
- "request_retail_rates": true,
- "return_service_type": "PRINT_AND_MAIL",
- "rma_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "saturday_delivery": true,
- "salesperson_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "serial_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "signature_confirmation": "STANDARD",
- "store_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "transaction_reference_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}
}, - "metadata": "Customer ID 123456",
- "shipment_date": "2021-03-22T12:00:00Z",
- "address_from": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "address_return": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "address_to": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "carrier_accounts": [
- "string"
], - "customs_declaration": {
- "aes_itn": "string",
- "b13a_filing_option": "FILED_ELECTRONICALLY",
- "b13a_number": "string",
- "certificate": "string",
- "certify": true,
- "certify_signer": "Shawn Ippotle",
- "commercial_invoice": true,
- "contents_explanation": "T-Shirt purchase",
- "disclaimer": "string",
- "duties_payor": {
- "account": "2323434543",
- "type": "THIRD_PARTY",
- "address": {
- "name": "Patrick Kavanagh",
- "zip": "80331",
- "country": "DE"
}
}, - "exporter_identification": {
- "eori_number": "PL123456790ABCDE",
- "tax_id": {
- "number": "123456789",
- "type": "EIN"
}
}, - "exporter_reference": "string",
- "importer_reference": "string",
- "is_vat_collected": true,
- "invoice": "#123123",
- "license": "string",
- "metadata": "Order ID #123123",
- "notes": "string",
- "address_importer": "257ba08436604d2aaf069caafe7acb2a",
- "contents_type": "MERCHANDISE",
- "eel_pfc": "NOEEI_30_37_a",
- "incoterm": "DDP",
- "invoiced_charges": {
- "currency": "string",
- "total_shipping": "string",
- "total_taxes": "string",
- "total_duties": "string",
- "other_fees": "string"
}, - "items": [
- "5087f181d1dc4b14b73fdbf636498886"
], - "non_delivery_option": "RETURN",
- "object_created": "2014-07-17T01:01:08.306Z",
- "object_id": "e2197a54da9d470480f4f8796cc419cb",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-17T01:01:08.306Z",
- "test": true
}, - "messages": [
- {
- "source": "UPS",
- "code": "carrier_timeout",
- "text": "UPS API did not respond. Please try again in a few minutes."
}
], - "object_created": "2019-08-24T14:15:22Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "pp@gmail.com",
- "object_updated": "2019-08-24T14:15:22Z",
- "parcels": [
- {
- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
], - "rates": [
- {
- "amount": "5.5",
- "amount_local": "5.5",
- "currency": "USD",
- "currency_local": "USD",
- "arrives_by": "08:30:00",
- "attributes": [
- "BESTVALUE"
], - "carrier_account": "078870331023437cb917f5187429b093",
- "duration_terms": "Delivery in 1 to 3 business days",
- "estimated_days": 2,
- "included_insurance_price": "1.05",
- "messages": [
- {
- "source": "UPS",
- "code": "carrier_timeout",
- "text": "UPS API did not respond. Please try again in a few minutes."
}
], - "object_created": "2019-08-24T14:15:22Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "pp@gmail.com",
- "provider": "USPS",
- "servicelevel": {
- "name": "Priority Mail Express",
- "terms": "string",
- "token": "usps_priority_express",
- "extended_token": "string",
- "parent_servicelevel": {
- "name": "Priority Mail Express",
- "terms": "string",
- "token": "usps_priority_express",
- "extended_token": "string"
}
}, - "shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
- "test": true,
- "zone": "1"
}
], - "status": "QUEUED",
- "test": true
}
]
}
Creates a new shipment object.
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
Shipment details and contact info.
object (ShipmentExtra) An object holding optional extra services to be requested. | |
metadata | string A string of up to 100 characters that can be filled with any additional information you want to attach to the object. |
shipment_date | string Date the shipment will be tendered to the carrier. Must be in the format |
required | AddressCreateRequest (object) or string |
AddressCreateRequest (object) or string | |
required | AddressCreateRequest (object) or string |
CustomsDeclarationCreateRequest (object) or string | |
async | boolean |
carrier_accounts | Array of strings List of Carrier Accounts |
required | Array of ParcelCreateRequest (object) or ParcelCreateFromTemplateRequest (object) or strings |
{- "extra": {
- "accounts_receivable_customer_account": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "alcohol": {
- "contains_alcohol": true,
- "recipient_type": "licensee"
}, - "ancillary_endorsement": "FORWARDING_SERVICE_REQUESTED",
- "appropriation_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "authority_to_leave": true,
- "bill_of_lading_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "billing": {
- "account": "string",
- "country": "string",
- "participation_code": "string",
- "type": "SENDER",
- "zip": "string"
}, - "bypass_address_validation": true,
- "carbon_neutral": true,
- "carrier_hub_id": "string",
- "carrier_hub_travel_time": 0,
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "cod_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "container_type": "string",
- "critical_pull_time": "string",
- "customer_branch": "string",
- "customer_reference": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "dangerous_goods": {
- "contains": true,
- "biological_material": {
- "contains": true
}, - "lithium_batteries": {
- "contains": true
}
}, - "dangerous_goods_code": "01",
- "dealer_order_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "delivery_instructions": "string",
- "dept_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 3
}, - "dry_ice": {
- "contains_dry_ice": true,
- "weight": "string"
}, - "fda_product_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "fulfillment_center": "string",
- "insurance": {
- "amount": "5.5",
- "content": "string",
- "currency": "USD",
- "provider": "FEDEX"
}, - "invoice_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "is_return": true,
- "lasership_attrs": [
- "TwoPersonDelivery"
], - "lasership_declared_value": "string",
- "manifest_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "model_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "part_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "po_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "preferred_delivery_timeframe": "10001200",
- "premium": true,
- "production_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "purchase_request_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "qr_code_requested": true,
- "reference_1": "string",
- "reference_2": "string",
- "request_retail_rates": true,
- "return_service_type": "PRINT_AND_MAIL",
- "rma_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "saturday_delivery": true,
- "salesperson_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "serial_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "signature_confirmation": "STANDARD",
- "store_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "transaction_reference_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}
}, - "metadata": "Customer ID 123456",
- "shipment_date": "2021-03-22T12:00:00Z",
- "address_from": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "validate": true
}, - "address_return": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "validate": true
}, - "address_to": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "validate": true
}, - "customs_declaration": {
- "aes_itn": "string",
- "b13a_filing_option": "FILED_ELECTRONICALLY",
- "b13a_number": "string",
- "certificate": "string",
- "certify": true,
- "certify_signer": "Shawn Ippotle",
- "commercial_invoice": true,
- "contents_explanation": "T-Shirt purchase",
- "disclaimer": "string",
- "duties_payor": {
- "account": "2323434543",
- "type": "THIRD_PARTY",
- "address": {
- "name": "Patrick Kavanagh",
- "zip": "80331",
- "country": "DE"
}
}, - "exporter_identification": {
- "eori_number": "PL123456790ABCDE",
- "tax_id": {
- "number": "123456789",
- "type": "EIN"
}
}, - "exporter_reference": "string",
- "importer_reference": "string",
- "is_vat_collected": true,
- "invoice": "#123123",
- "license": "string",
- "metadata": "Order ID #123123",
- "notes": "string",
- "address_importer": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "Blumenstraße",
- "street2": "string",
- "street3": "",
- "street_no": "22",
- "city": "München",
- "state": "CA",
- "zip": "80331",
- "country": "DE",
- "phone": "80331",
- "email": "shippotle@shippo.com",
- "is_residential": true
}, - "contents_type": "DOCUMENTS",
- "eel_pfc": "NOEEI_30_37_a",
- "incoterm": "DDP",
- "items": [
- {
- "description": "T-Shirt",
- "eccn_ear99": "string",
- "mass_unit": "lb",
- "metadata": "Order ID \"123454\"",
- "net_weight": "5",
- "origin_country": "string",
- "quantity": 20,
- "sku_code": "HM-123",
- "hs_code": "0901.21",
- "tariff_number": "string",
- "value_amount": "200",
- "value_currency": "USD"
}
], - "non_delivery_option": "ABANDON",
- "test": true
}, - "async": true,
- "carrier_accounts": [
- "065a4a8c10d24a34ab932163a1b87f52",
- "73f706f4bdb94b54a337563840ce52b0"
], - "parcels": [
- {
- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1"
}
]
}
{- "extra": {
- "accounts_receivable_customer_account": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "alcohol": {
- "contains_alcohol": true,
- "recipient_type": "licensee"
}, - "ancillary_endorsement": "FORWARDING_SERVICE_REQUESTED",
- "appropriation_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "authority_to_leave": true,
- "bill_of_lading_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "billing": {
- "account": "string",
- "country": "string",
- "participation_code": "string",
- "type": "SENDER",
- "zip": "string"
}, - "bypass_address_validation": true,
- "carbon_neutral": true,
- "carrier_hub_id": "string",
- "carrier_hub_travel_time": 0,
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "cod_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "container_type": "string",
- "critical_pull_time": "string",
- "customer_branch": "string",
- "customer_reference": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "dangerous_goods": {
- "contains": true,
- "biological_material": {
- "contains": true
}, - "lithium_batteries": {
- "contains": true
}
}, - "dangerous_goods_code": "01",
- "dealer_order_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "delivery_instructions": "string",
- "dept_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 3
}, - "dry_ice": {
- "contains_dry_ice": true,
- "weight": "string"
}, - "fda_product_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "fulfillment_center": "string",
- "insurance": {
- "amount": "5.5",
- "content": "string",
- "currency": "USD",
- "provider": "FEDEX"
}, - "invoice_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "is_return": true,
- "lasership_attrs": [
- "TwoPersonDelivery"
], - "lasership_declared_value": "string",
- "manifest_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "model_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "part_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "po_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "preferred_delivery_timeframe": "10001200",
- "premium": true,
- "production_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "purchase_request_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "qr_code_requested": true,
- "reference_1": "string",
- "reference_2": "string",
- "request_retail_rates": true,
- "return_service_type": "PRINT_AND_MAIL",
- "rma_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "saturday_delivery": true,
- "salesperson_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "serial_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "signature_confirmation": "STANDARD",
- "store_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "transaction_reference_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}
}, - "metadata": "Customer ID 123456",
- "shipment_date": "2021-03-22T12:00:00Z",
- "address_from": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "address_return": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "address_to": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",
- "is_residential": true,
- "metadata": "Customer ID 123456",
- "is_complete": true,
- "latitude": 0,
- "longitude": 0,
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "d799c2679e644279b59fe661ac8fa488",
- "object_owner": "shippotle@shippo.com",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "validation_results": {
- "is_valid": false,
- "messages": [
- {
- "code": "Unknown Street",
- "source": "Shippo Address Validator",
- "text": "City, State and ZIP Code are valid, but street address is not a match.",
- "type": "address_warning"
}
]
}, - "test": false
}, - "carrier_accounts": [
- "string"
], - "customs_declaration": {
- "aes_itn": "string",
- "b13a_filing_option": "FILED_ELECTRONICALLY",
- "b13a_number": "string",
- "certificate": "string",
- "certify": true,
- "certify_signer": "Shawn Ippotle",
- "commercial_invoice": true,
- "contents_explanation": "T-Shirt purchase",
- "disclaimer": "string",
- "duties_payor": {
- "account": "2323434543",
- "type": "THIRD_PARTY",
- "address": {
- "name": "Patrick Kavanagh",
- "zip": "80331",
- "country": "DE"
}
}, - "exporter_identification": {
- "eori_number": "PL123456790ABCDE",
- "tax_id": {
- "number": "123456789",
- "type": "EIN"
}
}, - "exporter_reference": "string",
- "importer_reference": "string",
- "is_vat_collected": true,
- "invoice": "#123123",
- "license": "string",
- "metadata": "Order ID #123123",
- "notes": "string",
- "address_importer": "257ba08436604d2aaf069caafe7acb2a",
- "contents_type": "MERCHANDISE",
- "eel_pfc": "NOEEI_30_37_a",
- "incoterm": "DDP",
- "invoiced_charges": {
- "currency": "string",
- "total_shipping": "string",
- "total_taxes": "string",
- "total_duties": "string",
- "other_fees": "string"
}, - "items": [
- "5087f181d1dc4b14b73fdbf636498886"
], - "non_delivery_option": "RETURN",
- "object_created": "2014-07-17T01:01:08.306Z",
- "object_id": "e2197a54da9d470480f4f8796cc419cb",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-17T01:01:08.306Z",
- "test": true
}, - "messages": [
- {
- "source": "UPS",
- "code": "carrier_timeout",
- "text": "UPS API did not respond. Please try again in a few minutes."
}
], - "object_created": "2019-08-24T14:15:22Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "pp@gmail.com",
- "object_updated": "2019-08-24T14:15:22Z",
- "parcels": [
- {
- "extra": {
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "insurance": {
- "amount": "5.5",
- "content": "Laptop",
- "currency": "USD",
- "provider": "UPS"
}, - "reference_1": "string",
- "reference_2": "string"
}, - "metadata": "Customer ID 123456",
- "mass_unit": "lb",
- "weight": "1",
- "distance_unit": "in",
- "height": "1",
- "length": "1",
- "width": "1",
- "object_created": "2014-07-09T02:19:13.174Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "shippotle@shippo.com",
- "object_state": "VALID",
- "object_updated": "2014-07-09T02:19:13.174Z",
- "template": "FedEx_Box_10kg",
- "test": true
}
], - "rates": [
- {
- "amount": "5.5",
- "amount_local": "5.5",
- "currency": "USD",
- "currency_local": "USD",
- "arrives_by": "08:30:00",
- "attributes": [
- "BESTVALUE"
], - "carrier_account": "078870331023437cb917f5187429b093",
- "duration_terms": "Delivery in 1 to 3 business days",
- "estimated_days": 2,
- "included_insurance_price": "1.05",
- "messages": [
- {
- "source": "UPS",
- "code": "carrier_timeout",
- "text": "UPS API did not respond. Please try again in a few minutes."
}
], - "object_created": "2019-08-24T14:15:22Z",
- "object_id": "adcfdddf8ec64b84ad22772bce3ea37a",
- "object_owner": "pp@gmail.com",
- "provider": "USPS",
- "servicelevel": {
- "name": "Priority Mail Express",
- "terms": "string",
- "token": "usps_priority_express",
- "extended_token": "string",
- "parent_servicelevel": {
- "name": "Priority Mail Express",
- "terms": "string",
- "token": "usps_priority_express",
- "extended_token": "string"
}
}, - "shipment": "adcfdddf8ec64b84ad22772bce3ea37a",
- "test": true,
- "zone": "1"
}
], - "status": "QUEUED",
- "test": true
}
Returns an existing shipment using an object ID
SHIPPO-API-VERSION | string Optional string used to pick a non-default API version to use. See our API version guide. Example: 2018-02-08 |
curl https://api.goshippo.com/shipments/7c47d12aa95a4cbb9d90c167cca7bea7 \ -H "Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396"
{- "extra": {
- "accounts_receivable_customer_account": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "alcohol": {
- "contains_alcohol": true,
- "recipient_type": "licensee"
}, - "ancillary_endorsement": "FORWARDING_SERVICE_REQUESTED",
- "appropriation_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "authority_to_leave": true,
- "bill_of_lading_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "billing": {
- "account": "string",
- "country": "string",
- "participation_code": "string",
- "type": "SENDER",
- "zip": "string"
}, - "bypass_address_validation": true,
- "carbon_neutral": true,
- "carrier_hub_id": "string",
- "carrier_hub_travel_time": 0,
- "COD": {
- "amount": "5.5",
- "currency": "USD",
- "payment_method": "CASH"
}, - "cod_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "container_type": "string",
- "critical_pull_time": "string",
- "customer_branch": "string",
- "customer_reference": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "dangerous_goods": {
- "contains": true,
- "biological_material": {
- "contains": true
}, - "lithium_batteries": {
- "contains": true
}
}, - "dangerous_goods_code": "01",
- "dealer_order_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "delivery_instructions": "string",
- "dept_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 3
}, - "dry_ice": {
- "contains_dry_ice": true,
- "weight": "string"
}, - "fda_product_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "fulfillment_center": "string",
- "insurance": {
- "amount": "5.5",
- "content": "string",
- "currency": "USD",
- "provider": "FEDEX"
}, - "invoice_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "is_return": true,
- "lasership_attrs": [
- "TwoPersonDelivery"
], - "lasership_declared_value": "string",
- "manifest_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "model_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "part_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "po_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 2
}, - "preferred_delivery_timeframe": "10001200",
- "premium": true,
- "production_code": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "purchase_request_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "qr_code_requested": true,
- "reference_1": "string",
- "reference_2": "string",
- "request_retail_rates": true,
- "return_service_type": "PRINT_AND_MAIL",
- "rma_number": {
- "prefix": "string",
- "value": "string",
- "ref_sort": 1
}, - "saturday_delivery": true,
- "salesperson_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "serial_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "signature_confirmation": "STANDARD",
- "store_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}, - "transaction_reference_number": {
- "prefix": "ABC",
- "value": "value",
- "ref_sort": 1
}
}, - "metadata": "Customer ID 123456",
- "shipment_date": "2021-03-22T12:00:00Z",
- "address_from": {
- "name": "Shwan Ippotle",
- "company": "Shippo",
- "street1": "215 Clayton St.",
- "street2": "string",
- "street3": "",
- "street_no": "",
- "city": "San Francisco",
- "state": "CA",
- "zip": "94117",
- "country": "US",
- "phone": "+1 555 341 9393",
- "email": "shippotle@shippo.com",