Process labels in bulk and receive a large number of labels and customs forms in bulk responses. Batching is ideal for workflows that need to process hundreds or thousands of labels quickly.
License MIT
The possible shipment status values
Pickup Resource ID
Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an empty page is returned.
The number of results to return per response.
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments?batch_id=se-28529731&created_at_end=2019-08-24T14%3A15%3A22Z&created_at_start=2019-08-24T14%3A15%3A22Z&modified_at_end=2019-08-24T14%3A15%3A22Z&modified_at_start=2019-08-24T14%3A15%3A22Z&page=1&page_size=25&pickup_id=pik_3YcKU5zdtJuCqoeNwyqqbW&sales_order_id=string&shipment_status=pending&sort_by=modified_at&sort_dir=desc' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
The list of shipments returned by the api call
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
Warning: The
external_shipment_idis limited to 50 characters. Any additional characters will be truncated.
A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.
Warning: The
shipment_numberis limited to 50 characters. Any additional characters will be truncated.
An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The possible shipment status values
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Email for the address owner.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
postal code
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
Additional text about how to handle the shipment at this address.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Email for the address owner.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
postal code
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Email for the address owner.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The name of the city or locality
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
postal code
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
The possible delivery confirmation values
Options for international shipments, such as customs declarations.
The possible package contents values
Explanation for contents (required if the contents is provided as other)
The possible non delivery values
Specifies the supported terms of trade code (incoterms)
Declaration statement to be placed on the commercial invoice
The additional information to put on commercial invoice
importer of records address, anywhere in the world.
Advanced shipment options
This field is used to [bill shipping costs to a third party]. This field must be used in conjunction with the bill_to_country_code, bill_to_party, and bill_to_postal_code fields.
The possible bill to party values
The postal code of the third-party that is responsible for shipping costs.
Indicates that the shipment contains alcohol.
Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.
Indicates if the shipment contain dry ice
Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See Section 1.2 of the USPS parcel standards for details.
Enables Saturday delivery, if supported by the carrier.
Whether to use [UPS Ground Freight pricing] If enabled, then a freight_class must also be specified.
The National Motor Freight Traffic Association freight class, such as "77.5", "110", or "250".
An arbitrary field that can be used to store information about the shipment.
An arbitrary field that can be used to store information about the shipment.
An arbitrary field that can be used to store information about the shipment.
Indicates if the package will be picked up or dropped off by the carrier
Indicate to the carrier that this shipment requires additional handling.
Defer payment until package is delivered, instead of when it is ordered.
Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached
Indicates if the Dangerous goods are present in the shipment
The possible insurance provider values
Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
The order sources that are supported by ShipStation
The packages in the shipment.
Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The name of the of the [package type]
The weight of a package
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
An external package id.
A tracking number for a package. The format depends on the carrier.
A short description of the package content. Required for shipments moving to, from, and through Mexico.
The weight of a package
Total number of shipments returned by the api call
Helpful links to other pages of results
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
A link to a related resource, or an empty object if there is no resource to link to
{ "shipments": [ { … } ], "total": 1990, "page": 12, "pages": 4, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments/external_shipment_id/{external_shipment_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
Warning: The
external_shipment_idis limited to 50 characters. Any additional characters will be truncated.
A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.
Warning: The
shipment_numberis limited to 50 characters. Any additional characters will be truncated.
An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The possible shipment status values
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
Additional text about how to handle the shipment at this address.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
The possible delivery confirmation values
Options for international shipments, such as customs declarations.
The possible package contents values
Explanation for contents (required if the contents is provided as other)
The possible non delivery values
Specifies the supported terms of trade code (incoterms)
Declaration statement to be placed on the commercial invoice
The additional information to put on commercial invoice
importer of records address, anywhere in the world.
Advanced shipment options
This field is used to [bill shipping costs to a third party]. This field must be used in conjunction with the bill_to_country_code, bill_to_party, and bill_to_postal_code fields.
The possible bill to party values
The postal code of the third-party that is responsible for shipping costs.
Indicates that the shipment contains alcohol.
Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.
Indicates if the shipment contain dry ice
Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See Section 1.2 of the USPS parcel standards for details.
Enables Saturday delivery, if supported by the carrier.
Whether to use [UPS Ground Freight pricing] If enabled, then a freight_class must also be specified.
The National Motor Freight Traffic Association freight class, such as "77.5", "110", or "250".
An arbitrary field that can be used to store information about the shipment.
An arbitrary field that can be used to store information about the shipment.
An arbitrary field that can be used to store information about the shipment.
Indicates if the package will be picked up or dropped off by the carrier
Indicate to the carrier that this shipment requires additional handling.
Defer payment until package is delivered, instead of when it is ordered.
Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached
Indicates if the Dangerous goods are present in the shipment
The possible insurance provider values
Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
The order sources that are supported by ShipStation
The packages in the shipment.
Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The weight of a package
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
A tracking number for a package. The format depends on the carrier.
A short description of the package content. Required for shipments moving to, from, and through Mexico.
The weight of a package
{ "shipment_id": "se-28529731", "carrier_id": "se-1234567", "service_code": "se_1234567", "shipping_rule_id": "se-1234", "external_order_id": "1232434", "items": [], "tax_identifiers": [ { … } ], "external_shipment_id": "1234556", "shipment_number": "se-1234545", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "modified_at": "2018-09-23T15:00:00.000Z", "shipment_status": "pending", "ship_to": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "no", "instructions": "any instruction", "geolocation": [ … ] }, "ship_from": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "no", "instructions": "any instructions" }, "warehouse_id": null, "return_to": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "no", "instructions": "any instructions" }, "is_return": true, "confirmation": "none", "customs": null, "advanced_options": { "bill_to_account": "123456789", "bill_to_country_code": "US", "bill_to_party": "third_party", "bill_to_postal_code": "28005", "contains_alcohol": true, "delivered_duty_paid": true, "dry_ice": true, "dry_ice_weight": { … }, "non_machinable": true, "saturday_delivery": true, "fedex_freight": { … }, "use_ups_ground_freight_pricing": true, "freight_class": "77.5", "custom_field1": "custom field 1", "custom_field2": "custom field 2", "custom_field3": "custom field 3", "origin_type": null, "additional_handling": true, "shipper_release": true, "collect_on_delivery": { … }, "third_party_consignee": true, "dangerous_goods": true, "dangerous_goods_contact": { … }, "windsor_framework_details": { … } }, "insurance_provider": "none", "tags": [], "order_source_code": "amazon_ca", "packages": [ { … } ], "total_weight": { "value": 3, "unit": "pound" }, "comparison_rate_type": "retail" }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments/{shipment_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
A unique user-defined key to identify a shipment. This can be used to retrieve the shipment.
Warning: The
external_shipment_idis limited to 50 characters. Any additional characters will be truncated.
A non-unique user-defined number used to identify a shipment. If undefined, this will match the external_shipment_id of the shipment.
Warning: The
shipment_numberis limited to 50 characters. Any additional characters will be truncated.
An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
The possible shipment status values
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
Additional text about how to handle the shipment at this address.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A complete or partial mailing address.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
If this is a business address, then the company name should be specified here.
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
The second line of the street address. For some addresses, this line may not be needed.
The third line of the street address. For some addresses, this line may not be needed.
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
A two-letter ISO 3166-1 country code
Indicates whether an address is residential.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
The possible delivery confirmation values
Options for international shipments, such as customs declarations.
The possible package contents values
Explanation for contents (required if the contents is provided as other)
The possible non delivery values
Specifies the supported terms of trade code (incoterms)
Declaration statement to be placed on the commercial invoice
The additional information to put on commercial invoice
importer of records address, anywhere in the world.
Advanced shipment options
This field is used to [bill shipping costs to a third party]. This field must be used in conjunction with the bill_to_country_code, bill_to_party, and bill_to_postal_code fields.
The possible bill to party values
The postal code of the third-party that is responsible for shipping costs.
Indicates that the shipment contains alcohol.
Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.
Indicates if the shipment contain dry ice
Indicates that the package cannot be processed automatically because it is too large or irregularly shaped. This is primarily for USPS shipments. See Section 1.2 of the USPS parcel standards for details.
Enables Saturday delivery, if supported by the carrier.
Whether to use [UPS Ground Freight pricing] If enabled, then a freight_class must also be specified.
The National Motor Freight Traffic Association freight class, such as "77.5", "110", or "250".
An arbitrary field that can be used to store information about the shipment.
An arbitrary field that can be used to store information about the shipment.
An arbitrary field that can be used to store information about the shipment.
Indicates if the package will be picked up or dropped off by the carrier
Indicate to the carrier that this shipment requires additional handling.
Defer payment until package is delivered, instead of when it is ordered.
Third Party Consignee option is a value-added service that allows the shipper to supply goods without commercial invoices being attached
Indicates if the Dangerous goods are present in the shipment
The possible insurance provider values
Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags.
The order sources that are supported by ShipStation
The packages in the shipment.
Note: Some carriers only allow one package per shipment. If you attempt to create a multi-package shipment for a carrier that doesn't allow it, an error will be returned.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
The weight of a package
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Custom messages to print on the shipping label for the package. These are typically used to print invoice numbers, product numbers, or other internal reference numbers. Not all carriers support label messages. The number of lines and the maximum length of each line also varies by carrier.
| Carrier | Max lines | Max line length |
|---|---|---|
| USPS (Stamps.com) | 3 | 60 |
| FedEx | 3 | 35 for the first line. 30 for additional lines. |
| UPS | 2 | 35 |
| OnTrac | 2 | 25 |
A tracking number for a package. The format depends on the carrier.
A short description of the package content. Required for shipments moving to, from, and through Mexico.
The weight of a package
{ "shipment_id": "se-28529731", "carrier_id": "se-1234567", "service_code": "se_1234567", "shipping_rule_id": "se-1234", "external_order_id": "1232434", "items": [], "tax_identifiers": [ { … } ], "external_shipment_id": "1234556", "shipment_number": "se-1234545", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "modified_at": "2018-09-23T15:00:00.000Z", "shipment_status": "pending", "ship_to": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "no", "instructions": "any instruction", "geolocation": [ … ] }, "ship_from": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "no", "instructions": "any instructions" }, "warehouse_id": null, "return_to": { "name": "John Doe", "phone": "+1 204-253-9411 ext. 123", "email": "example@example.com", "company_name": "The Home Depot", "address_line1": "1999 Bishop Grandin Blvd.", "address_line2": "Unit 408", "address_line3": "Building #7", "city_locality": "Winnipeg", "state_province": "Manitoba", "postal_code": "78756-3717", "country_code": "CA", "address_residential_indicator": "no", "instructions": "any instructions" }, "is_return": true, "confirmation": "none", "customs": null, "advanced_options": { "bill_to_account": "123456789", "bill_to_country_code": "US", "bill_to_party": "third_party", "bill_to_postal_code": "28005", "contains_alcohol": true, "delivered_duty_paid": true, "dry_ice": true, "dry_ice_weight": { … }, "non_machinable": true, "saturday_delivery": true, "fedex_freight": { … }, "use_ups_ground_freight_pricing": true, "freight_class": "77.5", "custom_field1": "custom field 1", "custom_field2": "custom field 2", "custom_field3": "custom field 3", "origin_type": null, "additional_handling": true, "shipper_release": true, "collect_on_delivery": { … }, "third_party_consignee": true, "dangerous_goods": true, "dangerous_goods_contact": { … }, "windsor_framework_details": { … } }, "insurance_provider": "none", "tags": [], "order_source_code": "amazon_ca", "packages": [ { … } ], "total_weight": { "value": 3, "unit": "pound" }, "comparison_rate_type": "retail" }
Mark a shipment cancelled, if it is no longer needed or being used by your organized. Any label associated with the shipment needs to be voided first An example use case would be if a batch label creation job is going to run at a set time and only queries pending shipments. Marking a shipment as cancelled would remove it from this process
curl -i -X PUT \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments/{shipment_id}/cancel' \ -H 'api-key: YOUR_API_KEY_HERE'
No response example
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments/{shipment_id}/rates?created_at_start=2019-08-24T14%3A15%3A22Z' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
An array of shipment rates
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible rate type values
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Certain carriers base their rates off of custom zones that vary depending upon the ship_to and ship_from location
package type that this rate was estimated for
The number of days estimated for delivery, this will show the actual delivery time if for example, the package gets shipped on a Friday
Indicates if the rate is guaranteed.
An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .
Indicates if the rates been negotiated
service code for the rate
The possible validation status values
An array of invalid shipment rates
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible rate type values
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The currencies that are supported by ShipStation are the ones that specified by ISO 4217: https://www.iso.org/iso-4217-currency-codes.html
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Certain carriers base their rates off of custom zones that vary depending upon the ship_to and ship_from location
package type that this rate was estimated for
The number of days estimated for delivery, this will show the actual delivery time if for example, the package gets shipped on a Friday
Indicates if the rate is guaranteed.
An ISO 8601 string that represents a date, but not a specific time. The value may contain a time component, but it will be set to 00:00:00 UTC by ShipStation .
The carrier delivery days
Indicates if the rates been negotiated
service code for the rate
carrier friendly name
The possible validation status values
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible rate response status values
The source of the error, as indicated by the name this informs us if the API call failed because of the carrier, the order source, or the ShipStation API itself.
The type of error
The error code specified for the failed API Call
{ "rates": [ { … } ], "invalid_rates": [], "rate_request_id": "se-28529731", "shipment_id": "se-28529731", "created_at": "se-28529731", "status": "working", "errors": [ { … } ] }
Shipment ID
Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
curl -i -X POST \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments/{shipment_id}/tags/{tag_name}' \ -H 'api-key: YOUR_API_KEY_HERE'
The requested object creation was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
{ "shipment_id": "se-28529731", "tag": { "name": "Fragile" } }
Shipment ID
Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic and international shipments, or between insured and uninsured shipments. Or maybe you want to create a tag for each of your customers so you can easily retrieve every shipment for a customer.
curl -i -X DELETE \ 'https://docs.shipstation.com/_mock/openapi/v2/shipments/{shipment_id}/tags/{tag_name}' \ -H 'api-key: YOUR_API_KEY_HERE'
No response example
Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.