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
This endpoint returns a list of labels that you've [created]. You can optionally filter the results as well as control their sort order and the number of results returned at a time.
By default, all labels are returned, 25 at a time, starting with the most recently created ones. You can combine multiple filter options to narrow-down the results. For example, if you only want to get your UPS labels for your east coast warehouse you could query by both warehouse_id and carrier_id
Only return labels that are currently in the specified status
Only return labels for a specific [carrier service]
Carrier ID
The tracking number associated with a shipment
Shipment ID
Warehouse 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)
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/labels?batch_id=se-28529731&carrier_id=se-28529731&created_at_end=2019-08-24T14%3A15%3A22Z&created_at_start=2019-08-24T14%3A15%3A22Z&label_status=processing&page=1&page_size=25&rate_id=se-28529731&service_code=usps_first_class_mail&shipment_id=se-28529731&sort_by=modified_at&sort_dir=desc&tracking_number=string&warehouse_id=se-28529731' \ -H 'api-key: YOUR_API_KEY_HERE'
The response includes a labels array containing a page of results (as determined by the page_size query parameter). It also includes other useful information, such as the total number of labels that match the query criteria, the number of pages of results, and the URLs of the first, last, next, and previous pages of results.
The labels that matched the query criteria. If no matching labels were found, then this array is empty; otherwise, it contains one page of results. The last page of results may have fewer labels than the page_size.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible statuses that a [shipping label] can be in.
| Status | Description |
|---|---|
processing | When labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been [voided] |
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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.
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.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
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.
Determines when the user's account will be charged for the label.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, 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.
An ISO 8601 string that represents a date and time.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.
Used to identify an image resource.
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The different statuses that can apply to a shipment.
Reference to the various downloadable file formats for the generated label
A link to a related resource, or an empty object if there is no resource to link to
The paperless details which may contain elements like href, instructions and handoff_code.
A link to a related resource, or an empty object if there is no resource to link to
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
The current page number of results. For example, if there are 80 results, and the page size is 25, then page could be 1, 2, 3, or 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.
The total number of pages of results. For example, if there are 80 results, and the page size is 25, then pages would be 4. The first three pages would contain 25 items each, and the fourth page would contain the five remaining items. If there are no results, then pages will be zero.
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
{ "labels": [ { … } ], "total": 2750, "page": 1, "pages": 4, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
A unique identifier for a carrier service point where the shipment will be delivered by the carrier. This will take precedence over a shipment's ship to address.
A unique identifier for a carrier drop off point where a merchant plans to deliver packages. This will take precedence over a shipment's ship from address.
The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.
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 .
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 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.
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 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.
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
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 [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 short description of the package content. Required for shipments moving to, from, and through Mexico.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Determines when the user's account will be charged for the label.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible validate address values
There are two different ways to [download a label]:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. This is the default if label_download_type is unspecified. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Used to identify an image resource.
curl -i -X POST \ https://docs.shipstation.com/_mock/openapi/v2/labels \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "ship_to_service_point_id": "614940", "ship_from_service_point_id": "614940", "shipment": { "carrier_id": "se-1234567", "service_code": "se_1234567", "shipping_rule_id": "se-1234", "external_order_id": "1232434", "items": [], "tax_identifiers": [ { "taxable_entity_type": "shipper", "identifier_type": "vat", "issuing_authority": "US", "value": "value" } ], "external_shipment_id": "1234556", "shipment_number": "se-1234545", "ship_date": "2018-09-23", "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": [ { "type": "what3words", "value": "cats.with.thumbs" } ] }, "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": { "value": 23, "unit": "pound" }, "non_machinable": true, "saturday_delivery": true, "fedex_freight": { "shipper_load_and_count": "shipper_load_and_count", "booking_confirmation": "today" }, "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": { "payment_type": "any", "payment_amount": { "currency": "USD", "amount": 12 } }, "third_party_consignee": true, "dangerous_goods": true, "dangerous_goods_contact": { "name": "Michael Robinson", "phone": "123456578789" }, "windsor_framework_details": { "movement_indicator": "b2b", "not_at_risk": true } }, "insurance_provider": "none", "order_source_code": "amazon_ca", "packages": [ { "package_id": "se-123456", "package_code": "thick_envelope", "package_name": "Flat Rate Envelope", "weight": { "value": 23, "unit": "pound" }, "dimensions": { "unit": "inch", "length": 2, "width": 2, "height": 1 }, "insured_value": [ { "currency": "usd", "amount": 0 } ], "label_messages": { "reference1": "Reference", "reference2": "Reference 2", "reference3": "Reference 3" }, "external_package_id": "se-1234545", "content_description": "Hand knitted wool socks", "products": [] } ], "comparison_rate_type": "retail" }, "is_return_label": true, "rma_number": "asd12323", "charge_event": "carrier_default", "outbound_label_id": "se-28529731", "test_label": true, "validate_address": "validate_and_clean", "label_download_type": "url", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK" }'
The requested object creation was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible statuses that a [shipping label] can be in.
| Status | Description |
|---|---|
processing | When labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been [voided] |
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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.
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.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
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.
Determines when the user's account will be charged for the label.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, 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.
An ISO 8601 string that represents a date and time.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.
Used to identify an image resource.
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The different statuses that can apply to a shipment.
Reference to the various downloadable file formats for the generated label
A URL
A URL
A URL
A link to a related resource, or an empty object if there is no resource to link to
The paperless details which may contain elements like href, instructions and handoff_code.
A URL
The instructions for the paperless download.
A link to a related resource, or an empty object if there is no resource to link to
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
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.
A tracking number for a package. The format depends on the carrier.
Reference to the various downloadable file formats for the generated label
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
The paperless details which may contain elements like href, instructions and handoff_code.
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 short description of the package content. Required for shipments moving to, from, and through Mexico.
Whether the package has label documents available for download
Whether the package has form documents available for download
Whether the package has QR code documents available for download
Whether the package has paperless documents available for download
Additional information some carriers may provide by which to identify a given label in their system.
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 12 }, "insurance_cost": { "currency": "string", "amount": 12 }, "requested_comparison_amount": { "currency": "string", "amount": 12 }, "tracking_number": "782758401696", "is_return_label": true, "rma_number": "asd12323", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-1234567", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "label_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "pdf": "http://api.shipstation.com/v2/labels/se-28529731", "png": "http://api.shipstation.com/v2/labels/se-28529731", "zpl": "http://api.shipstation.com/v2/labels/se-28529731" }, "form_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "paperless_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "instructions": "any instructions", "handoff_code": "122334" }, "insurance_claim": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234" }
The possible validate address values
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
There are two different ways to [download a label]:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. This is the default if label_download_type is unspecified. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
curl -i -X POST \ 'https://docs.shipstation.com/_mock/openapi/v2/labels/rates/{rate_id}' \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "validate_address": "no_validation", "label_layout": "4x6", "label_format": "pdf", "label_download_type": "url", "display_scheme": "label" }'
The requested object creation was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible statuses that a [shipping label] can be in.
| Status | Description |
|---|---|
processing | When labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been [voided] |
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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.
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.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
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.
Determines when the user's account will be charged for the label.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, 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.
An ISO 8601 string that represents a date and time.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.
Used to identify an image resource.
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The different statuses that can apply to a shipment.
Reference to the various downloadable file formats for the generated label
A link to a related resource, or an empty object if there is no resource to link to
The paperless details which may contain elements like href, instructions and handoff_code.
A link to a related resource, or an empty object if there is no resource to link to
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 12 }, "insurance_cost": { "currency": "string", "amount": 12 }, "requested_comparison_amount": { "currency": "string", "amount": 12 }, "tracking_number": "782758401696", "is_return_label": true, "rma_number": "asd12323", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-1234567", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "label_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "pdf": "http://api.shipstation.com/v2/labels/se-28529731", "png": "http://api.shipstation.com/v2/labels/se-28529731", "zpl": "http://api.shipstation.com/v2/labels/se-28529731" }, "form_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "paperless_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "instructions": "any instructions", "handoff_code": "122334" }, "insurance_claim": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234" }
The possible validate address values
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
There are two different ways to [download a label]:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. This is the default if label_download_type is unspecified. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
curl -i -X POST \ 'https://docs.shipstation.com/_mock/openapi/v2/labels/shipment/{shipment_id}' \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "validate_address": "no_validation", "label_layout": "4x6", "label_format": "pdf", "label_download_type": "url", "display_scheme": "label" }'
The requested object creation was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible statuses that a [shipping label] can be in.
| Status | Description |
|---|---|
processing | When labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been [voided] |
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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.
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.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
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.
Determines when the user's account will be charged for the label.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, 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.
An ISO 8601 string that represents a date and time.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.
Used to identify an image resource.
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The different statuses that can apply to a shipment.
Reference to the various downloadable file formats for the generated label
A link to a related resource, or an empty object if there is no resource to link to
The paperless details which may contain elements like href, instructions and handoff_code.
A link to a related resource, or an empty object if there is no resource to link to
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 12 }, "insurance_cost": { "currency": "string", "amount": 12 }, "requested_comparison_amount": { "currency": "string", "amount": 12 }, "tracking_number": "782758401696", "is_return_label": true, "rma_number": "asd12323", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-1234567", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "label_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "pdf": "http://api.shipstation.com/v2/labels/se-28529731", "png": "http://api.shipstation.com/v2/labels/se-28529731", "zpl": "http://api.shipstation.com/v2/labels/se-28529731" }, "form_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "paperless_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "instructions": "any instructions", "handoff_code": "122334" }, "insurance_claim": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234" }
There are two different ways to [download a label]:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. This is the default if label_download_type is unspecified. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}?label_download_type=url' \ -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.
The possible statuses that a [shipping label] can be in.
| Status | Description |
|---|---|
processing | When labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been [voided] |
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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.
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.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
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.
Determines when the user's account will be charged for the label.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, 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.
An ISO 8601 string that represents a date and time.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.
Used to identify an image resource.
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The different statuses that can apply to a shipment.
Reference to the various downloadable file formats for the generated label
A link to a related resource, or an empty object if there is no resource to link to
The paperless details which may contain elements like href, instructions and handoff_code.
A link to a related resource, or an empty object if there is no resource to link to
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 12 }, "insurance_cost": { "currency": "string", "amount": 12 }, "requested_comparison_amount": { "currency": "string", "amount": 12 }, "tracking_number": "782758401696", "is_return_label": true, "rma_number": "asd12323", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-1234567", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "label_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "pdf": "http://api.shipstation.com/v2/labels/se-28529731", "png": "http://api.shipstation.com/v2/labels/se-28529731", "zpl": "http://api.shipstation.com/v2/labels/se-28529731" }, "form_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "paperless_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "instructions": "any instructions", "handoff_code": "122334" }, "insurance_claim": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234" }
Determines when the user's account will be charged for the label.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
There are two different ways to [download a label]:
| Label Download Type | Description |
|---|---|
url | You will receive a URL, which you can use to download the label in a separate request. The URL will remain valid for 90 days. This is the default if label_download_type is unspecified. |
inline | You will receive the Base64-encoded label as part of the response. No need for a second request to download the label. |
The display format that the label should be shown in.
curl -i -X POST \ 'https://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}/return' \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "charge_event": "carrier_default", "label_layout": "4x6", "label_format": "pdf", "label_download_type": "url", "display_scheme": "label", "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK" }'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
The possible statuses that a [shipping label] can be in.
| Status | Description |
|---|---|
processing | When labels are created in a [batch], it may take a few minutes for all of the labels in the batch to be created. During this period, they will be in processing status. |
completed | The label was successfully created |
error | The label could not be created due to an error, such as an invalid delivery address |
voided | The label has been [voided] |
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
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.
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.
The tracking number for the package. Tracking number formats vary across carriers.
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
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.
Determines when the user's account will be charged for the label.
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, 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.
An ISO 8601 string that represents a date and time.
The possible file formats in which shipping labels can be downloaded. We recommend pdf format because it is supported by all carriers, whereas some carriers do not support the png or zpl formats.
| Label Format | Supported Carriers |
|---|---|
pdf | All carriers |
png | fedex stamps_com ups usps |
zpl | access_worldwide apc asendia dhl_global_mail dhl_express dhl_express_australia dhl_express_canada dhl_express_worldwide dhl_express_uk dpd endicia fedex fedex_uk firstmile imex newgistics ontrac rr_donnelley stamps_com ups usps |
The display format that the label should be shown in.
The available layouts (sizes) in which shipping labels can be downloaded. The label format determines which sizes are supported. 4x6 is supported for all label formats, whereas letter (8.5" x 11") is only supported for pdf format.
Indicates whether the shipment is trackable, in which case the tracking_status field will reflect the current status and each package will have a tracking_number.
Used to identify an image resource.
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The different statuses that can apply to a shipment.
Reference to the various downloadable file formats for the generated label
A link to a related resource, or an empty object if there is no resource to link to
The paperless details which may contain elements like href, instructions and handoff_code.
A link to a related resource, or an empty object if there is no resource to link to
The label's package(s).
Note: Some carriers only allow one package per label. If you attempt to create a multi-package label for a carrier that doesn't allow it, an error will be returned.
Additional information some carriers may provide by which to identify a given label in their system.
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "ship_date": "2018-09-23", "created_at": "2018-09-23T15:00:00.000Z", "shipment_cost": { "currency": "string", "amount": 12 }, "insurance_cost": { "currency": "string", "amount": 12 }, "requested_comparison_amount": { "currency": "string", "amount": 12 }, "tracking_number": "782758401696", "is_return_label": true, "rma_number": "asd12323", "is_international": true, "batch_id": "se-28529731", "carrier_id": "se-1234567", "charge_event": "carrier_default", "service_code": "usps_first_class_mail", "package_code": "small_flat_rate_box", "voided": true, "voided_at": "2018-09-23T15:00:00.000Z", "label_format": "pdf", "display_scheme": "label", "label_layout": "4x6", "trackable": true, "label_image_id": "img_DtBXupDBxREpHnwEXhTfgK", "carrier_code": "dhl_express", "tracking_status": "unknown", "label_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "pdf": "http://api.shipstation.com/v2/labels/se-28529731", "png": "http://api.shipstation.com/v2/labels/se-28529731", "zpl": "http://api.shipstation.com/v2/labels/se-28529731" }, "form_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "paperless_download": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "instructions": "any instructions", "handoff_code": "122334" }, "insurance_claim": { "href": "http://api.shipstation.com/v2/labels/se-28529731", "type": "child" }, "packages": [ { … } ], "alternative_identifiers": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234" }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}/track' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
A tracking number for a package. The format depends on the carrier.
Carrier Tracking Url, if available
The tracking status detail codes
| Value | Description |
|---|---|
COLLECTION_FAILED | Shipment pickup failed. The delivery company will try again soon. |
AWAITING_DESPATCH | Your shipment is ready to go and is waiting for pickup. |
COLLECTION_REQUESTED | Your shipment pickup has been scheduled. |
DESPATCHED | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. |
ELEC_ADVICE_RECD_BY_CARRIER | Your shipment is now in the carrier's system. |
NOT_YET_RECEIVED_BY_CARRIER | The sender couldn't hand over your shipment. The delivery company will try to collect it again. |
COLLECTION_MADE | Your shipment has been picked up by the carrier. |
ATTEMPTED_DELIVERY | Delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_2ND | Second delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_3RD | Third delivery attempt failed. Please check the carrier's instructions for next steps. |
COD_AMOUNT_NOT_PAID | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. |
COD_AMOUNT_PAID | Cash on delivery payment received. |
CUSTOMER_CARDED | Delivery attempt failed. Please check for delivery instructions left by the carrier. |
CUSTOMER_IDENTIFICATION_FAILED | There was a recipient identification issue. Please check carrier instructions. |
INVALID_METHOD_OF_PAYMENT | Delivery failed due to incorrect payment. Please check carrier instructions. |
NO_ACCESS_TO_RECIPIENTS_ADDRESS | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. |
OUT_FOR_DELIVERY | Your shipment is out for delivery. |
DELIVERED | Your shipment has been delivered. |
DELIVERED_DAMAGED | Your shipment was delivered but arrived damaged. |
DELIVERED_IN_PART | Part of your shipment has been delivered. Check for updates on the rest. |
DELIVERED_SPECIFIED_SAFE_PLACE | Your shipment has been left in your designated safe place. |
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. |
DELIVERED_TO_NEIGHBOUR | Your shipment was delivered to your neighbor. |
DELIVERED_TO_PO_BOX | Your shipment was delivered to your PO Box. |
PARCEL_COLLECTED_FROM_PICKUP_POINT | Your package has been picked up from the collection point. |
POST_TRANSIT_STATUS | The carrier has added more information about your delivery. |
PROOF_OF_DELIVERY | Delivery confirmed. |
CANCELLED | Your shipment has been cancelled. |
CANCELLED_BEFORE_DESPATCH | Your shipment was cancelled before pickup. Contact the sender if unexpected. |
CUSTOMER_MOVED | Recipient not at address. Your shipment is being returned. |
HAZARDOUS_PROHIBITED | Your parcel contained a prohibited item and is being returned. Contact the sender. |
NOT_COLLECTED_FROM_PICKUP_POINT | Shipment not collected from the pickup point. Your parcel is being returned to the sender. |
NOT_DELIVERED | Delivery attempts failed. Your parcel is being returned to the sender. |
NOT_DELIVERED_ADDRESSEE_DECEASED | Delivery not possible due to recipient's passing. |
PARCEL_DAMAGED | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. |
PARCEL_DISPOSED | Shipment was disposed of. Contact the sender for details. |
PARCEL_LOST | Your parcel is lost. Contact the sender for next steps. |
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY | Shipment is too large/heavy for delivery. Being returned. Contact sender. |
REFUSED_BY_CUSTOMER | Delivery refused. Shipment being returned. Contact the sender. |
RETURN_TO_SENDER | Your shipment is being returned to the sender. Contact them for details. |
ADDRESS_QUERY | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. |
CARRIER_DELAYS | There's a delivery delay. We'll update you when there's more info. |
CUSTOMS_CLEARED | Your shipment has passed customs clearance. |
CUSTOMS_PROCESSING | Your shipment is going through customs. |
DELAYED_NOT_CARRIER | Unexpected delivery delay. We'll update you soon. |
DELIVERY_ARRANGED_WITH_RECIPIENT | Delivery arranged by recipient. |
HELD_BY_CARRIER | Your shipment is on hold due to a carrier issue. We'll update you soon. |
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING | Your shipment is held by carrier due to customs issues. We'll update you. |
HELD_BY_CUSTOMS | Your shipment is held in customs. We'll update you. |
HELD_BY_EXPORT_CUSTOMS | Your shipment is held in export customs. We'll update you. |
HELD_BY_IMPORT_CUSTOMS | Your shipment is held in import customs. We'll update you. |
HUB_SCAN_OUT | Your shipment is at the main delivery depot. |
IN_TRANSIT | Your shipment is on its way between depots. |
INCORRECT_DECLARATION | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. |
INFORMATION | The carrier has shared additional shipment information. |
MISSORTED | Your shipment was missorted. There might be a delivery delay. We'll update you. |
PARCEL_OVER_LABELLED | Your shipment was over labelled by the delivery company to improve processing. |
PARCEL_REPACKED | Your shipment packaging was damaged. It's being repacked. This might delay delivery. |
PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL | You've received an email with a shipment update. |
PARCEL_UPDATE_NOTIFICATION_VIA_SMS | You've received a text message with a shipment update. |
RECEIVED_BY_CARRIER | Your shipment has been received by the carrier. |
RECEIVED_LOCAL_DELIVERY_DEPOT | Your shipment is at the local delivery depot, ready for delivery. |
ROUTING_ERROR | Your shipment was sent to the wrong place. There might be a delay. |
SUB_CONTRACTOR_EVENT | Your shipment is with the local delivery partner. |
SUB_CONTRACTOR_RECEIVED | Your shipment has been received by the local delivery partner. |
RECD_BY_CARRIER_NO_ELEC_ADVICE | There's a system issue with your shipment. Tracking updates might be delayed. |
AWAITING_ELECTRONIC_ADVICE | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. |
AWAITING_COLLECTION_FROM_PICKUP_POINT | Your shipment is ready for pickup at the specified location. |
COLLECT_AT_LOCAL_PO | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. |
CUSTOMER_TO_COLLECT_FROM_CARRIER | Your shipment is being held for pickup. Check carrier instructions. |
DELIVERED_TO_LOCKER_COLLECTION_POINT | Your shipment has been delivered to your locker. |
CARRIER_STATUS_NOT_MAPPED | Status not mapped. Please check the carrier's website for updates. |
The tracking status detail codes
| Value | Description |
|---|---|
COLLECTION_FAILED | Shipment pickup failed. The delivery company will try again soon. |
AWAITING_DESPATCH | Your shipment is ready to go and is waiting for pickup. |
COLLECTION_REQUESTED | Your shipment pickup has been scheduled. |
DESPATCHED | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. |
ELEC_ADVICE_RECD_BY_CARRIER | Your shipment is now in the carrier's system. |
NOT_YET_RECEIVED_BY_CARRIER | The sender couldn't hand over your shipment. The delivery company will try to collect it again. |
COLLECTION_MADE | Your shipment has been picked up by the carrier. |
ATTEMPTED_DELIVERY | Delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_2ND | Second delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_3RD | Third delivery attempt failed. Please check the carrier's instructions for next steps. |
COD_AMOUNT_NOT_PAID | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. |
COD_AMOUNT_PAID | Cash on delivery payment received. |
CUSTOMER_CARDED | Delivery attempt failed. Please check for delivery instructions left by the carrier. |
CUSTOMER_IDENTIFICATION_FAILED | There was a recipient identification issue. Please check carrier instructions. |
INVALID_METHOD_OF_PAYMENT | Delivery failed due to incorrect payment. Please check carrier instructions. |
NO_ACCESS_TO_RECIPIENTS_ADDRESS | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. |
OUT_FOR_DELIVERY | Your shipment is out for delivery. |
DELIVERED | Your shipment has been delivered. |
DELIVERED_DAMAGED | Your shipment was delivered but arrived damaged. |
DELIVERED_IN_PART | Part of your shipment has been delivered. Check for updates on the rest. |
DELIVERED_SPECIFIED_SAFE_PLACE | Your shipment has been left in your designated safe place. |
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. |
DELIVERED_TO_NEIGHBOUR | Your shipment was delivered to your neighbor. |
DELIVERED_TO_PO_BOX | Your shipment was delivered to your PO Box. |
PARCEL_COLLECTED_FROM_PICKUP_POINT | Your package has been picked up from the collection point. |
POST_TRANSIT_STATUS | The carrier has added more information about your delivery. |
PROOF_OF_DELIVERY | Delivery confirmed. |
CANCELLED | Your shipment has been cancelled. |
CANCELLED_BEFORE_DESPATCH | Your shipment was cancelled before pickup. Contact the sender if unexpected. |
CUSTOMER_MOVED | Recipient not at address. Your shipment is being returned. |
HAZARDOUS_PROHIBITED | Your parcel contained a prohibited item and is being returned. Contact the sender. |
NOT_COLLECTED_FROM_PICKUP_POINT | Shipment not collected from the pickup point. Your parcel is being returned to the sender. |
NOT_DELIVERED | Delivery attempts failed. Your parcel is being returned to the sender. |
NOT_DELIVERED_ADDRESSEE_DECEASED | Delivery not possible due to recipient's passing. |
PARCEL_DAMAGED | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. |
PARCEL_DISPOSED | Shipment was disposed of. Contact the sender for details. |
PARCEL_LOST | Your parcel is lost. Contact the sender for next steps. |
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY | Shipment is too large/heavy for delivery. Being returned. Contact sender. |
REFUSED_BY_CUSTOMER | Delivery refused. Shipment being returned. Contact the sender. |
RETURN_TO_SENDER | Your shipment is being returned to the sender. Contact them for details. |
ADDRESS_QUERY | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. |
CARRIER_DELAYS | There's a delivery delay. We'll update you when there's more info. |
CUSTOMS_CLEARED | Your shipment has passed customs clearance. |
CUSTOMS_PROCESSING | Your shipment is going through customs. |
DELAYED_NOT_CARRIER | Unexpected delivery delay. We'll update you soon. |
DELIVERY_ARRANGED_WITH_RECIPIENT | Delivery arranged by recipient. |
HELD_BY_CARRIER | Your shipment is on hold due to a carrier issue. We'll update you soon. |
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING | Your shipment is held by carrier due to customs issues. We'll update you. |
HELD_BY_CUSTOMS | Your shipment is held in customs. We'll update you. |
HELD_BY_EXPORT_CUSTOMS | Your shipment is held in export customs. We'll update you. |
HELD_BY_IMPORT_CUSTOMS | Your shipment is held in import customs. We'll update you. |
HUB_SCAN_OUT | Your shipment is at the main delivery depot. |
IN_TRANSIT | Your shipment is on its way between depots. |
INCORRECT_DECLARATION | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. |
INFORMATION | The carrier has shared additional shipment information. |
MISSORTED | Your shipment was missorted. There might be a delivery delay. We'll update you. |
PARCEL_OVER_LABELLED | Your shipment was over labelled by the delivery company to improve processing. |
PARCEL_REPACKED | Your shipment packaging was damaged. It's being repacked. This might delay delivery. |
PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL | You've received an email with a shipment update. |
PARCEL_UPDATE_NOTIFICATION_VIA_SMS | You've received a text message with a shipment update. |
RECEIVED_BY_CARRIER | Your shipment has been received by the carrier. |
RECEIVED_LOCAL_DELIVERY_DEPOT | Your shipment is at the local delivery depot, ready for delivery. |
ROUTING_ERROR | Your shipment was sent to the wrong place. There might be a delay. |
SUB_CONTRACTOR_EVENT | Your shipment is with the local delivery partner. |
SUB_CONTRACTOR_RECEIVED | Your shipment has been received by the local delivery partner. |
RECD_BY_CARRIER_NO_ELEC_ADVICE | There's a system issue with your shipment. Tracking updates might be delayed. |
AWAITING_ELECTRONIC_ADVICE | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. |
AWAITING_COLLECTION_FROM_PICKUP_POINT | Your shipment is ready for pickup at the specified location. |
COLLECT_AT_LOCAL_PO | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. |
CUSTOMER_TO_COLLECT_FROM_CARRIER | Your shipment is being held for pickup. Check carrier instructions. |
DELIVERED_TO_LOCKER_COLLECTION_POINT | Your shipment has been delivered to your locker. |
CARRIER_STATUS_NOT_MAPPED | Status not mapped. Please check the carrier's website for updates. |
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
The unique ID of the [carrier account] that was used to create this label
Status detail description
carrier status description
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
Exception description
The events that have occured during the lifetime of this tracking number.
An ISO 8601 string that represents a date and time.
An ISO 8601 string that represents a date and time.
Event description
A two-letter ISO 3166-1 country code
The tracking status detail codes
| Value | Description |
|---|---|
COLLECTION_FAILED | Shipment pickup failed. The delivery company will try again soon. |
AWAITING_DESPATCH | Your shipment is ready to go and is waiting for pickup. |
COLLECTION_REQUESTED | Your shipment pickup has been scheduled. |
DESPATCHED | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. |
ELEC_ADVICE_RECD_BY_CARRIER | Your shipment is now in the carrier's system. |
NOT_YET_RECEIVED_BY_CARRIER | The sender couldn't hand over your shipment. The delivery company will try to collect it again. |
COLLECTION_MADE | Your shipment has been picked up by the carrier. |
ATTEMPTED_DELIVERY | Delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_2ND | Second delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_3RD | Third delivery attempt failed. Please check the carrier's instructions for next steps. |
COD_AMOUNT_NOT_PAID | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. |
COD_AMOUNT_PAID | Cash on delivery payment received. |
CUSTOMER_CARDED | Delivery attempt failed. Please check for delivery instructions left by the carrier. |
CUSTOMER_IDENTIFICATION_FAILED | There was a recipient identification issue. Please check carrier instructions. |
INVALID_METHOD_OF_PAYMENT | Delivery failed due to incorrect payment. Please check carrier instructions. |
NO_ACCESS_TO_RECIPIENTS_ADDRESS | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. |
OUT_FOR_DELIVERY | Your shipment is out for delivery. |
DELIVERED | Your shipment has been delivered. |
DELIVERED_DAMAGED | Your shipment was delivered but arrived damaged. |
DELIVERED_IN_PART | Part of your shipment has been delivered. Check for updates on the rest. |
DELIVERED_SPECIFIED_SAFE_PLACE | Your shipment has been left in your designated safe place. |
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. |
DELIVERED_TO_NEIGHBOUR | Your shipment was delivered to your neighbor. |
DELIVERED_TO_PO_BOX | Your shipment was delivered to your PO Box. |
PARCEL_COLLECTED_FROM_PICKUP_POINT | Your package has been picked up from the collection point. |
POST_TRANSIT_STATUS | The carrier has added more information about your delivery. |
PROOF_OF_DELIVERY | Delivery confirmed. |
CANCELLED | Your shipment has been cancelled. |
CANCELLED_BEFORE_DESPATCH | Your shipment was cancelled before pickup. Contact the sender if unexpected. |
CUSTOMER_MOVED | Recipient not at address. Your shipment is being returned. |
HAZARDOUS_PROHIBITED | Your parcel contained a prohibited item and is being returned. Contact the sender. |
NOT_COLLECTED_FROM_PICKUP_POINT | Shipment not collected from the pickup point. Your parcel is being returned to the sender. |
NOT_DELIVERED | Delivery attempts failed. Your parcel is being returned to the sender. |
NOT_DELIVERED_ADDRESSEE_DECEASED | Delivery not possible due to recipient's passing. |
PARCEL_DAMAGED | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. |
PARCEL_DISPOSED | Shipment was disposed of. Contact the sender for details. |
PARCEL_LOST | Your parcel is lost. Contact the sender for next steps. |
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY | Shipment is too large/heavy for delivery. Being returned. Contact sender. |
REFUSED_BY_CUSTOMER | Delivery refused. Shipment being returned. Contact the sender. |
RETURN_TO_SENDER | Your shipment is being returned to the sender. Contact them for details. |
ADDRESS_QUERY | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. |
CARRIER_DELAYS | There's a delivery delay. We'll update you when there's more info. |
CUSTOMS_CLEARED | Your shipment has passed customs clearance. |
CUSTOMS_PROCESSING | Your shipment is going through customs. |
DELAYED_NOT_CARRIER | Unexpected delivery delay. We'll update you soon. |
DELIVERY_ARRANGED_WITH_RECIPIENT | Delivery arranged by recipient. |
HELD_BY_CARRIER | Your shipment is on hold due to a carrier issue. We'll update you soon. |
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING | Your shipment is held by carrier due to customs issues. We'll update you. |
HELD_BY_CUSTOMS | Your shipment is held in customs. We'll update you. |
HELD_BY_EXPORT_CUSTOMS | Your shipment is held in export customs. We'll update you. |
HELD_BY_IMPORT_CUSTOMS | Your shipment is held in import customs. We'll update you. |
HUB_SCAN_OUT | Your shipment is at the main delivery depot. |
IN_TRANSIT | Your shipment is on its way between depots. |
INCORRECT_DECLARATION | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. |
INFORMATION | The carrier has shared additional shipment information. |
MISSORTED | Your shipment was missorted. There might be a delivery delay. We'll update you. |
PARCEL_OVER_LABELLED | Your shipment was over labelled by the delivery company to improve processing. |
PARCEL_REPACKED | Your shipment packaging was damaged. It's being repacked. This might delay delivery. |
PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL | You've received an email with a shipment update. |
PARCEL_UPDATE_NOTIFICATION_VIA_SMS | You've received a text message with a shipment update. |
RECEIVED_BY_CARRIER | Your shipment has been received by the carrier. |
RECEIVED_LOCAL_DELIVERY_DEPOT | Your shipment is at the local delivery depot, ready for delivery. |
ROUTING_ERROR | Your shipment was sent to the wrong place. There might be a delay. |
SUB_CONTRACTOR_EVENT | Your shipment is with the local delivery partner. |
SUB_CONTRACTOR_RECEIVED | Your shipment has been received by the local delivery partner. |
RECD_BY_CARRIER_NO_ELEC_ADVICE | There's a system issue with your shipment. Tracking updates might be delayed. |
AWAITING_ELECTRONIC_ADVICE | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. |
AWAITING_COLLECTION_FROM_PICKUP_POINT | Your shipment is ready for pickup at the specified location. |
COLLECT_AT_LOCAL_PO | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. |
CUSTOMER_TO_COLLECT_FROM_CARRIER | Your shipment is being held for pickup. Check carrier instructions. |
DELIVERED_TO_LOCKER_COLLECTION_POINT | Your shipment has been delivered to your locker. |
CARRIER_STATUS_NOT_MAPPED | Status not mapped. Please check the carrier's website for updates. |
The tracking status detail codes
| Value | Description |
|---|---|
COLLECTION_FAILED | Shipment pickup failed. The delivery company will try again soon. |
AWAITING_DESPATCH | Your shipment is ready to go and is waiting for pickup. |
COLLECTION_REQUESTED | Your shipment pickup has been scheduled. |
DESPATCHED | Your shipment has been handed over to the carrier or dropped off at collection point. It will soon start its journey. |
ELEC_ADVICE_RECD_BY_CARRIER | Your shipment is now in the carrier's system. |
NOT_YET_RECEIVED_BY_CARRIER | The sender couldn't hand over your shipment. The delivery company will try to collect it again. |
COLLECTION_MADE | Your shipment has been picked up by the carrier. |
ATTEMPTED_DELIVERY | Delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_2ND | Second delivery attempt failed. Please check the carrier's instructions for next steps. |
ATTEMPTED_DELIVERY_3RD | Third delivery attempt failed. Please check the carrier's instructions for next steps. |
COD_AMOUNT_NOT_PAID | Delivery failed due to unpaid cash on delivery. Please check carrier instructions. |
COD_AMOUNT_PAID | Cash on delivery payment received. |
CUSTOMER_CARDED | Delivery attempt failed. Please check for delivery instructions left by the carrier. |
CUSTOMER_IDENTIFICATION_FAILED | There was a recipient identification issue. Please check carrier instructions. |
INVALID_METHOD_OF_PAYMENT | Delivery failed due to incorrect payment. Please check carrier instructions. |
NO_ACCESS_TO_RECIPIENTS_ADDRESS | Delivery couldn't be completed due to issues with accessing address. Please follow carrier instructions. |
OUT_FOR_DELIVERY | Your shipment is out for delivery. |
DELIVERED | Your shipment has been delivered. |
DELIVERED_DAMAGED | Your shipment was delivered but arrived damaged. |
DELIVERED_IN_PART | Part of your shipment has been delivered. Check for updates on the rest. |
DELIVERED_SPECIFIED_SAFE_PLACE | Your shipment has been left in your designated safe place. |
DELIVERED_TO_ALTERNATIVE_DELIVERY_LOCATION | Your shipment was delivered to an alternative location due to the delivery company being unable to deliver it to the specified address. Check carrier instructions for pickup details. |
DELIVERED_TO_NEIGHBOUR | Your shipment was delivered to your neighbor. |
DELIVERED_TO_PO_BOX | Your shipment was delivered to your PO Box. |
PARCEL_COLLECTED_FROM_PICKUP_POINT | Your package has been picked up from the collection point. |
POST_TRANSIT_STATUS | The carrier has added more information about your delivery. |
PROOF_OF_DELIVERY | Delivery confirmed. |
CANCELLED | Your shipment has been cancelled. |
CANCELLED_BEFORE_DESPATCH | Your shipment was cancelled before pickup. Contact the sender if unexpected. |
CUSTOMER_MOVED | Recipient not at address. Your shipment is being returned. |
HAZARDOUS_PROHIBITED | Your parcel contained a prohibited item and is being returned. Contact the sender. |
NOT_COLLECTED_FROM_PICKUP_POINT | Shipment not collected from the pickup point. Your parcel is being returned to the sender. |
NOT_DELIVERED | Delivery attempts failed. Your parcel is being returned to the sender. |
NOT_DELIVERED_ADDRESSEE_DECEASED | Delivery not possible due to recipient's passing. |
PARCEL_DAMAGED | Your parcel was damaged and can't be delivered. It's being returned. Contact the sender. |
PARCEL_DISPOSED | Shipment was disposed of. Contact the sender for details. |
PARCEL_LOST | Your parcel is lost. Contact the sender for next steps. |
PARCEL_OUTSIDE_OF_SERVICE_CAPABILITY | Shipment is too large/heavy for delivery. Being returned. Contact sender. |
REFUSED_BY_CUSTOMER | Delivery refused. Shipment being returned. Contact the sender. |
RETURN_TO_SENDER | Your shipment is being returned to the sender. Contact them for details. |
ADDRESS_QUERY | There's an issue with your delivery address. This may cause a delay or return. Contact sender or carrier. |
CARRIER_DELAYS | There's a delivery delay. We'll update you when there's more info. |
CUSTOMS_CLEARED | Your shipment has passed customs clearance. |
CUSTOMS_PROCESSING | Your shipment is going through customs. |
DELAYED_NOT_CARRIER | Unexpected delivery delay. We'll update you soon. |
DELIVERY_ARRANGED_WITH_RECIPIENT | Delivery arranged by recipient. |
HELD_BY_CARRIER | Your shipment is on hold due to a carrier issue. We'll update you soon. |
HELD_BY_CARRIER_FOR_CLEARANCE_PRE_PROCESSING | Your shipment is held by carrier due to customs issues. We'll update you. |
HELD_BY_CUSTOMS | Your shipment is held in customs. We'll update you. |
HELD_BY_EXPORT_CUSTOMS | Your shipment is held in export customs. We'll update you. |
HELD_BY_IMPORT_CUSTOMS | Your shipment is held in import customs. We'll update you. |
HUB_SCAN_OUT | Your shipment is at the main delivery depot. |
IN_TRANSIT | Your shipment is on its way between depots. |
INCORRECT_DECLARATION | Incorrect shipment dimensions. Delivery may be delayed or returned. We'll update you. |
INFORMATION | The carrier has shared additional shipment information. |
MISSORTED | Your shipment was missorted. There might be a delivery delay. We'll update you. |
PARCEL_OVER_LABELLED | Your shipment was over labelled by the delivery company to improve processing. |
PARCEL_REPACKED | Your shipment packaging was damaged. It's being repacked. This might delay delivery. |
PARCEL_UPDATE_NOTIFICATION_VIA_EMAIL | You've received an email with a shipment update. |
PARCEL_UPDATE_NOTIFICATION_VIA_SMS | You've received a text message with a shipment update. |
RECEIVED_BY_CARRIER | Your shipment has been received by the carrier. |
RECEIVED_LOCAL_DELIVERY_DEPOT | Your shipment is at the local delivery depot, ready for delivery. |
ROUTING_ERROR | Your shipment was sent to the wrong place. There might be a delay. |
SUB_CONTRACTOR_EVENT | Your shipment is with the local delivery partner. |
SUB_CONTRACTOR_RECEIVED | Your shipment has been received by the local delivery partner. |
RECD_BY_CARRIER_NO_ELEC_ADVICE | There's a system issue with your shipment. Tracking updates might be delayed. |
AWAITING_ELECTRONIC_ADVICE | Your tracking number is ready. Your shipment is waiting to be registered in the carrier system and scheduled for pickup. |
AWAITING_COLLECTION_FROM_PICKUP_POINT | Your shipment is ready for pickup at the specified location. |
COLLECT_AT_LOCAL_PO | Your shipment has been redirected to the local post office for pickup. Check carrier instructions. |
CUSTOMER_TO_COLLECT_FROM_CARRIER | Your shipment is being held for pickup. Check carrier instructions. |
DELIVERED_TO_LOCKER_COLLECTION_POINT | Your shipment has been delivered to your locker. |
CARRIER_STATUS_NOT_MAPPED | Status not mapped. Please check the carrier's website for updates. |
Event Status Description
Event Status Detail Description
carrier status description
{ "tracking_number": "1Z932R800392060079", "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "status_code": "COLLECTION_FAILED", "status_detail_code": "DELIVERED", "carrier_code": "dhl_express", "carrier_id": 1234567, "status_description": "Delivered", "status_detail_description": "Your shipment has been delivered.", "carrier_status_code": "1", "carrier_detail_code": "OT", "carrier_status_description": "Your item was delivered in or at the mailbox at 9:10 am on March", "ship_date": "2024-12-23T00:00:00.000Z", "estimated_delivery_date": "2018-09-23T15:00:00.000Z", "actual_delivery_date": "2018-09-23T15:00:00.000Z", "exception_description": "this is exception description", "events": [ { … } ] }
curl -i -X PUT \ 'https://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}/void' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
Indicates whether the attempt to void the label was successful
The possible normalized reasons a label void request may not have been approved
{ "approved": false, "message": "Unable to delete FedEx shipment. Unable to retrieve record from database.", "reason_code": "label_not_found_within_void_period" }
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.