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.
ShipStation API v2 (2.0.0)
Download OpenAPI description
Overview
License
Languages
Servers
Mock server
https://docs.shipstation.com/_mock/openapi/
Production
https://api.shipstation.com/
Request
This method 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 your UPS labels for your east coast warehouse you could query by both warehouse_id and carrier_id.
Security
api_keys
Query
Only return labels that are currently in the specified status.
Enum"processing""completed""error""voided"
Only return labels for a specific carrier service.
Example: service_code=usps_first_class_mail
Only return labels for a specific carrier account.
Example: carrier_id=se-28529731
Only return labels with a specific tracking number.
Example: tracking_number=9405511899223197428490
Only return labels that were created in a specific batch.
Example: batch_id=se-28529731
Shipment ID
Example: shipment_id=se-28529731
Only return labels that originate from a specific warehouse.
Example: warehouse_id=se-28529731
Only return labels that were created on or after a specific date/time.
Example: created_at_start=2019-03-12T19:24:13.657Z
Only return labels that were created on or before a specific date/time.
Example: created_at_end=2019-03-12T19:24:13.657Z
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.
Default 1
Example: page=2
The number of results to return per response.
Default 25
Example: page_size=50
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels
- Productionhttps://api.shipstation.com/v2/labels
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.shipstation.com/_mock/openapi/v2/labels?label_status=processing&service_code=usps_first_class_mail&carrier_id=se-28529731&tracking_number=9405511899223197428490&batch_id=se-28529731&rate_id=se-28529731&shipment_id=se-28529731&warehouse_id=se-28529731&created_at_start=2019-03-12T19%3A24%3A13.657Z&created_at_end=2019-03-12T19%3A24%3A13.657Z&page=2&page_size=50&sort_dir=desc&sort_by=modified_at' \
-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 the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
labels[].created_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
labels[].voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The QR code download for the package
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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 URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
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.
Example: 1
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.
Example: 4
Helpful links to other pages of results
The link to the first page of results. This object will always have an href field. If there are no results, then the first page will contain an empty array of items.
The link to the final page of results. This object will always have an href field. If there are no results, then the final page will contain an empty array of items.
The link to the previous page of results. The href field will only be set when the page is 2 or greater.
The link to the next page of results. The href field will only be set when the page is less than pages.
Response
application/json
{ "labels": [ { … } ], "total": 2750, "page": 1, "pages": 4, "links": { "first": { … }, "last": { … }, "prev": { … }, "next": { … } } }
Bodyapplication/jsonrequired
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.
Example: "614940"
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.
Example: "614940"
The information necessary to ship a package, such as the origin, the destination, the carrier service, and the package dimensions and weight.
Note: Either
ship_fromorwarehouse_idmust be set.
The carrier account that is billed for the shipping charges
Example: "se-28529731"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
The requested shipment service
Example: "usps_priority_mail"
ID of the shipping rule, which you want to use to automate carrier/carrier service selection for the shipment
Example: "se-28529731"
Date to hold the shipment until
Example: "2025-01-15T00:00:00.000Z"
Date by which the shipment should be shipped
Example: "2025-01-15T00:00:00.000Z"
The store ID associated with the shipment
Example: "se-28529731"
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
Default []
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.
Example: "1234556"
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.
Example: "10001"
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 .
Example: "2018-09-23T00:00:00Z"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
Example: "John Doe"
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Example: "+1 204-253-9411 ext. 123"
If this is a business address, then the company name should be specified here.
Example: "The Home Depot"
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
Example: "1999 Bishop Grandin Blvd."
The second line of the street address. For some addresses, this line may not be needed.
Example: "Unit 408"
The third line of the street address. For some addresses, this line may not be needed.
Example: "Building #7"
The name of the city or locality
Example: "Winnipeg"
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
Example: "Manitoba"
A two-letter ISO 3166-1 country code
Example: "CA"
Indicates whether this is a residential address.
Default "unknown"
Enum"unknown""yes""no"
Example: "yes"
Additional text about how to handle the shipment at this address.
Example: "any instruction"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
Example: "John Doe"
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Example: "+1 204-253-9411 ext. 123"
If this is a business address, then the company name should be specified here.
Example: "The Home Depot"
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
Example: "1999 Bishop Grandin Blvd."
The second line of the street address. For some addresses, this line may not be needed.
Example: "Unit 408"
The third line of the street address. For some addresses, this line may not be needed.
Example: "Building #7"
The name of the city or locality
Example: "Winnipeg"
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
Example: "Manitoba"
postal code
Example: "78756-3717"
A two-letter ISO 3166-1 country code
Example: "CA"
Indicates whether this is a residential address.
Default "unknown"
Enum"unknown""yes""no"
Example: "yes"
The [warehouse] that the shipment is being shipped from. Either warehouse_id or ship_from must be specified.
Default null
Example: "se-28529731"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The name of a contact person at this address. This field may be set instead of - or in addition to - the company_name field.
Example: "John Doe"
The phone number of a contact person at this address. The format of this phone number varies depending on the country.
Example: "+1 204-253-9411 ext. 123"
If this is a business address, then the company name should be specified here.
Example: "The Home Depot"
The first line of the street address. For some addresses, this may be the only line. Other addresses may require 2 or 3 lines.
Example: "1999 Bishop Grandin Blvd."
The second line of the street address. For some addresses, this line may not be needed.
Example: "Unit 408"
The third line of the street address. For some addresses, this line may not be needed.
Example: "Building #7"
The name of the city or locality
Example: "Winnipeg"
The state or province. For some countries (including the U.S.) only abbreviations are allowed. Other countries allow the full name or abbreviation.
Example: "Manitoba"
postal code
Example: "78756-3717"
A two-letter ISO 3166-1 country code
Example: "CA"
Indicates whether this is a residential address.
Default "unknown"
Enum"unknown""yes""no"
Example: "yes"
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
Default false
Example: true
The type of delivery confirmation that is required for this shipment
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
Customs information. This is usually only needed for international shipments.
Default null
Advanced shipment options. These are entirely optional.
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.
Default null
Example: "123456789"
Indicates whether to bill shipping costs to the recipient or to a third-party. When billing to a third-party, the bill_to_account, bill_to_country_code, and bill_to_postal_code fields must also be set.
Default null
Enum"recipient""third_party"
Example: "third_party"
The postal code of the third-party that is responsible for shipping costs.
Default null
Example: "28005"
Indicates that the shipment contains alcohol.
Default false
Example: true
Indicates that the shipper is paying the international delivery duties for this shipment. This option is supported by UPS, FedEx, and DHL Express.
Default false
Example: true
Indicates if the shipment contain dry ice
Default false
Example: true
The weight of the dry ice in the shipment
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.
Default false
Example: true
Enables Saturday delivery, if supported by the carrier.
Default false
Example: true
Whether to use [UPS Ground Freight pricing] If enabled, then a freight_class must also be specified.
Default null
Example: true
The National Motor Freight Traffic Association freight class, such as "77.5", "110", or "250".
Default null
Example: "77.5"
An arbitrary field that can be used to store information about the shipment.
Default null
Example: "custom field 1"
An arbitrary field that can be used to store information about the shipment.
Default null
Example: "custom field 2"
An arbitrary field that can be used to store information about the shipment.
Default null
Example: "custom field 3"
Indicates if the package will be picked up or dropped off by the carrier
Default null
Enum"pickup""drop_off"
Indicate to the carrier that this shipment requires additional handling.
Default null
Example: true
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
Default false
Example: true
Indicates if the Dangerous goods are present in the shipment
Default false
Example: true
The Windsor framework is a new regulation in the UK that simplifies customs procedures for goods moved from the UK mainland to Northern Ireland.
Ancillary endorsements option for the shipment
Example: "forward"
Number of return pickup attempts
Example: 3
Indicates if own document upload is enabled
Default false
Example: false
Indicates if the shipment contains limited quantities
Default false
Example: false
Indicates if event notifications are enabled
Default false
Example: false
Instructs the carrier to deliver the package only to the exact address provided
Default false
Example: false
The insurance provider to use for any insured packages in the shipment.
Default "none"
Enum"none""shipsurance""carrier""third_party"
Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. Note: Tags require object structure with name property, not simple strings.
Default []
The order sources that are supported by ShipStation
Enum"amazon_ca""amazon_us""brightpearl""channel_advisor""cratejoy""ebay""etsy""jane""groupon_goods""magento"
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 this [package type]
Example: "se-28529731"
shipment.packages[].package_codestring(package_code)[ 1 .. 50 ] characters^[a-z0-9]+(_[a-z0-9]+)*$
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
The name of the of the [package type]
Example: "Flat Rate Envelope"
The package weight
The insured value of the package. Requires the insurance_provider field of the shipment to be set.
Default [{"currency":"usd","amount":0}]
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.
Example: "se-1234545"
A short description of the package content. Required for shipments moving to, from, and through Mexico.
Example: "Hand knitted wool socks"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
The label_id of the original (outgoing) label that the return label is for. This associates the two labels together, which is required by some carriers.
Example: "se-28529731"
The possible validate address values
Default "no_validation"
Enum"no_validation""validate_only""validate_and_clean"
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. |
Default "url"
Enum"url""inline"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels
- Productionhttps://api.shipstation.com/v2/labels
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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",
"requested_shipment_service": "usps_priority_mail",
"shipping_rule_id": "se-1234",
"external_order_id": "1232434",
"hold_until_date": "2025-01-15T00:00:00.000Z",
"ship_by_date": "2025-01-15T00:00:00.000Z",
"retail_rate": {
"currency": "string",
"amount": 12
},
"store_id": "se-12345",
"items": [],
"notes_from_buyer": "Please handle with care",
"notes_for_gift": "Happy Birthday!",
"is_gift": true,
"assigned_user": "user@example.com",
"amount_paid": {
"currency": "string",
"amount": 12
},
"shipping_paid": {
"currency": "string",
"amount": 12
},
"tax_paid": {
"currency": "string",
"amount": 12
},
"zone": 1,
"display_scheme": "label",
"tax_identifiers": [
{
"taxable_entity_type": "shipper",
"identifier_type": "vat",
"issuing_authority": "US",
"value": "value"
}
],
"external_shipment_id": "1234556",
"shipment_number": "10001",
"ship_date": "2018-09-23T00:00:00Z",
"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": "yes",
"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": "yes",
"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": "yes",
"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
},
"ancillary_endorsements_option": "forward",
"return_pickup_attempts": 3,
"own_document_upload": false,
"limited_quantity": false,
"event_notification": false,
"delivery_as_addressed": false,
"return_after_first_attempt": false
},
"insurance_provider": "none",
"tags": [],
"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": "no_validation",
"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 the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
created_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-onlyrequired
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-onlyrequired
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The URL of the linked resource, if any
Example: "http://api.shipstation.com/v2/labels/se-28529731"
The URL for the pdf generated label
Example: "http://api.shipstation.com/v2/labels/se-28529731"
The URL for the png generated label
Example: "http://api.shipstation.com/v2/labels/se-28529731"
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The URL of the linked resource, if any
Example: "http://api.shipstation.com/v2/labels/se-28529731"
The instructions for the paperless download.
Default null
Example: "any instructions"
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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.
Example: "small_flat_rate_box"
The package weight
The insured value of the package. Requires the insurance_provider field of the shipment to be set.
Default {"currency":"usd","amount":0}
The tracking number for the package. The format depends on the carrier.
Example: "1Z932R800392060079"
The form download for any customs that are needed
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.
Example: "Hand knitted wool socks"
Whether the package has label documents available for download
Example: true
Whether the package has form documents available for download
Example: true
Whether the package has QR code documents available for download
Example: true
Whether the package has paperless documents available for download
Example: true
Additional information some carriers may provide by which to identify a given label in their system.
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
The URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
Response
application/json
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "external_shipment_id": "externalId-1234556", "external_order_id": "externalOrderId-1232434", "ship_date": "2018-09-23T00:00:00Z", "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", "confirmation": "none", "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" }, "qr_code_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": [ { … } ], "rate_details": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "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": "yes", "instructions": "any instruction", "geolocation": [ … ] } }
Bodyapplication/jsonrequired
The possible validate address values
Enum"no_validation""validate_only""validate_and_clean"
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.
Default "4x6"
Enum"4x6""letter"
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 |
Default "pdf"
Enum"pdf""png""zpl"
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. |
Enum"url""inline"
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/rates/{rate_id}
- Productionhttps://api.shipstation.com/v2/labels/rates/{rate_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.shipstation.com/_mock/openapi/v2/labels/rates/se-28529731 \
-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 the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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 URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
Response
application/json
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "external_shipment_id": "externalId-1234556", "external_order_id": "externalOrderId-1232434", "ship_date": "2018-09-23T00:00:00Z", "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", "confirmation": "none", "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" }, "qr_code_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": [ { … } ], "rate_details": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "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": "yes", "instructions": "any instruction", "geolocation": [ … ] } }
Bodyapplication/jsonrequired
The possible validate address values
Enum"no_validation""validate_only""validate_and_clean"
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.
Default "4x6"
Enum"4x6""letter"
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 |
Default "pdf"
Enum"pdf""png""zpl"
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. |
Enum"url""inline"
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/shipment/{shipment_id}
- Productionhttps://api.shipstation.com/v2/labels/shipment/{shipment_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.shipstation.com/_mock/openapi/v2/labels/shipment/se-28529731 \
-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 the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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 URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
Response
application/json
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "external_shipment_id": "externalId-1234556", "external_order_id": "externalOrderId-1232434", "ship_date": "2018-09-23T00:00:00Z", "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", "confirmation": "none", "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" }, "qr_code_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": [ { … } ], "rate_details": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "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": "yes", "instructions": "any instruction", "geolocation": [ … ] } }
Request
Create a label using Rate Shopper to automatically select the best carrier and service based on the specified strategy.
For more information about Rate Shopper strategies and use cases, see Rate Shopping.
Security
api_keys
Shipment information for Rate Shopper. Must NOT include carrier_id, service_code, or shipping_rule_id as Rate Shopper selects these automatically.
The requested shipment service
Example: "usps_priority_mail"
Date to hold the shipment until
Example: "2025-01-15T00:00:00.000Z"
Date by which the shipment should be shipped
Example: "2025-01-15T00:00:00.000Z"
The store ID associated with the shipment
Example: "se-28529731"
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
Default []
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.
Example: "1234556"
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.
Example: "10001"
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 .
Example: "2018-09-23T00:00:00Z"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
The [warehouse] that the shipment is being shipped from. Either warehouse_id or ship_from must be specified.
Default null
Example: "se-28529731"
Any residential or business mailing address, anywhere in the world.
Note: Either
nameorcompany_namemust be set. Both may be specified, if relevant.
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
Default false
Example: true
The type of delivery confirmation that is required for this shipment
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
Customs information. This is usually only needed for international shipments.
Default null
Advanced shipment options. These are entirely optional.
The insurance provider to use for any insured packages in the shipment.
Default "none"
Enum"none""shipsurance""carrier""third_party"
Arbitrary tags associated with this shipment. Tags can be used to categorize shipments, and shipments can be queried by their tags. Note: Tags require object structure with name property, not simple strings.
Default []
The order sources that are supported by ShipStation
Enum"amazon_ca""amazon_us""brightpearl""channel_advisor""cratejoy""ebay""etsy""jane""groupon_goods""magento"
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.
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 |
Default "pdf"
Enum"pdf""png""zpl"
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.
Default "4x6"
Enum"4x6""letter"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/rate_shopper_id/{rate_shopper_id}
- Productionhttps://api.shipstation.com/v2/labels/rate_shopper_id/{rate_shopper_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
'https://docs.shipstation.com/_mock/openapi/v2/labels/rate_shopper_id/{rate_shopper_id}' \
-H 'Content-Type: application/json' \
-H 'api-key: YOUR_API_KEY_HERE' \
-d '{
"shipment": {
"requested_shipment_service": "usps_priority_mail",
"external_order_id": "1232434",
"hold_until_date": "2025-01-15T00:00:00.000Z",
"ship_by_date": "2025-01-15T00:00:00.000Z",
"retail_rate": {
"currency": "string",
"amount": 12
},
"store_id": "se-12345",
"items": [],
"notes_from_buyer": "Please handle with care",
"notes_for_gift": "Happy Birthday!",
"is_gift": true,
"assigned_user": "user@example.com",
"amount_paid": {
"currency": "string",
"amount": 12
},
"shipping_paid": {
"currency": "string",
"amount": 12
},
"tax_paid": {
"currency": "string",
"amount": 12
},
"zone": 1,
"display_scheme": "label",
"tax_identifiers": [
{
"taxable_entity_type": "shipper",
"identifier_type": "vat",
"issuing_authority": "US",
"value": "value"
}
],
"external_shipment_id": "1234556",
"shipment_number": "10001",
"ship_date": "2018-09-23T00:00:00Z",
"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": "yes",
"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": "yes",
"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": "yes",
"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
},
"ancillary_endorsements_option": "forward",
"return_pickup_attempts": 3,
"own_document_upload": false,
"limited_quantity": false,
"event_notification": false,
"delivery_as_addressed": false,
"return_after_first_attempt": false
},
"insurance_provider": "none",
"tags": [],
"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"
},
"label_format": "pdf",
"label_layout": "4x6",
"display_scheme": "label",
"label_download_type": "url"
}'Label created successfully using Rate Shopper
The Rate Shopper strategy used to create this label
Enum"cheapest""fastest""best_value"
Example: "cheapest"
A string that uniquely identifies the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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 URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
Response
application/json
{ "rate_shopper_id": "cheapest", "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "external_shipment_id": "externalId-1234556", "external_order_id": "externalOrderId-1232434", "ship_date": "2018-09-23T00:00:00Z", "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", "confirmation": "none", "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" }, "qr_code_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": [ { … } ], "rate_details": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "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": "yes", "instructions": "any instruction", "geolocation": [ … ] } }
Query
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. |
Enum"url""inline"
Example: label_download_type=url
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}
- Productionhttps://api.shipstation.com/v2/labels/{label_id}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://docs.shipstation.com/_mock/openapi/v2/labels/se-28529731?label_download_type=url' \
-H 'api-key: YOUR_API_KEY_HERE'The request was a success.
A string that uniquely identifies the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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 URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
Response
application/json
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "external_shipment_id": "externalId-1234556", "external_order_id": "externalOrderId-1232434", "ship_date": "2018-09-23T00:00:00Z", "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", "confirmation": "none", "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" }, "qr_code_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": [ { … } ], "rate_details": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "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": "yes", "instructions": "any instruction", "geolocation": [ … ] } }
Bodyapplication/jsonrequired
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
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.
Default "4x6"
Enum"4x6""letter"
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 |
Default "pdf"
Enum"pdf""png""zpl"
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. |
Default "url"
Enum"url""inline"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}/return
- Productionhttps://api.shipstation.com/v2/labels/{label_id}/return
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://docs.shipstation.com/_mock/openapi/v2/labels/se-28529731/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 the label. This ID is generated by ShipStation when the label is created.
Example: "se-28529731"
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] |
Enum"processing""completed""error""voided"
Example: "completed"
The shipment that this label is for. ShipStation can create a shipment for you automatically when you [create a label], or you can [create your own shipment] and then [use it to print a label]
Example: "se-28529731"
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.
Example: "externalId-1234556"
ID that the Order Source assigned
Example: "externalOrderId-1232434"
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 .
Example: "2018-09-23T00:00:00Z"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
The cost of shipping, delivery confirmation, and other carrier charges. This amount does not include insurance costs.
The insurance cost for this package. Add this to the shipment_cost field to get the total cost.
The total shipping cost for the specified comparison_rate_type.
The tracking number for the package. Tracking number formats vary across carriers.
Example: "782758401696"
Indicates whether this is a return label. You may also want to set the rma_number so you know what is being returned.
Example: true
An optional Return Merchandise Authorization number. This field is useful for return labels. You can set it to any string value.
Example: "asd12323"
Indicates whether this is an international shipment. That is, the originating country and destination country are different.
Example: true
If this label was created as part of a [batch], then this is the unique ID of that batch.
Example: "se-28529731"
The unique ID of the [carrier account] that was used to create this label
Example: "se-28529731"
The label charge event.
Enum"carrier_default""on_creation""on_carrier_acceptance"
A [carrier service], such as fedex_ground, usps_first_class_mail, flat_rate_envelope, etc.
Example: "usps_first_class_mail"
A [package type] , such as thick_envelope, small_flat_rate_box, large_package, etc. Use the code package for custom or unknown package types.
Example: "small_flat_rate_box"
voided_atstring or null(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...read-only
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
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 |
Default "pdf"
Enum"pdf""png""zpl"
The display format that the label should be shown in.
Default "label"
Enum"label""qr_code""label_and_qr_code""paperless""label_and_paperless"
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.
Default "4x6"
Enum"4x6""letter"
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.
Example: true
The label image resource that was used to create a custom label image.
Example: "img_DtBXupDBxREpHnwEXhTfgK"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The type of delivery confirmation that is required for this shipment.
Default "none"
Enum"none""delivery""signature""adult_signature""direct_signature""delivery_mailed""verbal_confirmation""delivery_code""age_verification_16_plus"
The current status of the package, such as in_transit or delivered
Enum"unknown""in_transit""error""delivered"
Reference to the various downloadable file formats for the generated label
The link to download the customs form (a.k.a. commercial invoice) for this shipment, if any. Forms are in PDF format. This field is null if the shipment does not require a customs form, or if the carrier does not support it.
The paperless details which may contain elements like href, instructions and handoff_code.
The link to submit an insurance claim for the shipment. This field is null if the shipment is not insured or if the insurance provider does not support online claim submission.
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 URL to track the package. This URL is provided by the carrier and is unique to the tracking number.
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
Response
application/json
{ "label_id": "se-123456", "status": "completed", "shipment_id": "se-1234567", "external_shipment_id": "externalId-1234556", "external_order_id": "externalOrderId-1232434", "ship_date": "2018-09-23T00:00:00Z", "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", "confirmation": "none", "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" }, "qr_code_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": [ { … } ], "rate_details": [ { … } ], "tracking_url": "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234", "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": "yes", "instructions": "any instruction", "geolocation": [ … ] } }
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}/track
- Productionhttps://api.shipstation.com/v2/labels/{label_id}/track
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
https://docs.shipstation.com/_mock/openapi/v2/labels/se-28529731/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.
Example: "1Z932R800392060079"
Carrier Tracking Url, if available
Example: "https://www.fedex.com/fedextrack/?action=track&trackingnumber=1234"
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. |
Enum"COLLECTION_FAILED""AWAITING_DESPATCH""COLLECTION_REQUESTED""DESPATCHED""ELEC_ADVICE_RECD_BY_CARRIER""NOT_YET_RECEIVED_BY_CARRIER""COLLECTION_MADE""ATTEMPTED_DELIVERY""ATTEMPTED_DELIVERY_2ND""ATTEMPTED_DELIVERY_3RD"
Example: "COLLECTION_FAILED"
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. |
Enum"COLLECTION_FAILED""AWAITING_DESPATCH""COLLECTION_REQUESTED""DESPATCHED""ELEC_ADVICE_RECD_BY_CARRIER""NOT_YET_RECEIVED_BY_CARRIER""COLLECTION_MADE""ATTEMPTED_DELIVERY""ATTEMPTED_DELIVERY_2ND""ATTEMPTED_DELIVERY_3RD"
Example: "DELIVERED"
A [shipping carrier] , such as fedex, dhl_express, stamps_com, etc.
Example: "dhl_express"
The unique ID of the [carrier account] that was used to create this label
Example: 1234567
Status detail description
Example: "Your shipment has been delivered."
carrier status description
Example: "Your item was delivered in or at the mailbox at 9:10 am on March"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
estimated_delivery_datestring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...required
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
Exception description
Example: "this is exception description"
The events that have occured during the lifetime of this tracking number.
events[].occurred_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...required
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
events[].carrier_occurred_atstring(date-time)(date_time)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(...
An ISO 8601 string that represents a date and time.
Example: "2018-09-23T15:00:00.000Z"
Event description
Example: "Delivered, In/At Mailbox"
A two-letter ISO 3166-1 country code
Example: "CA"
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. |
Enum"COLLECTION_FAILED""AWAITING_DESPATCH""COLLECTION_REQUESTED""DESPATCHED""ELEC_ADVICE_RECD_BY_CARRIER""NOT_YET_RECEIVED_BY_CARRIER""COLLECTION_MADE""ATTEMPTED_DELIVERY""ATTEMPTED_DELIVERY_2ND""ATTEMPTED_DELIVERY_3RD"
Example: "COLLECTION_FAILED"
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. |
Enum"COLLECTION_FAILED""AWAITING_DESPATCH""COLLECTION_REQUESTED""DESPATCHED""ELEC_ADVICE_RECD_BY_CARRIER""NOT_YET_RECEIVED_BY_CARRIER""COLLECTION_MADE""ATTEMPTED_DELIVERY""ATTEMPTED_DELIVERY_2ND""ATTEMPTED_DELIVERY_3RD"
Example: "IN_TRANSIT"
Event Status Description
Example: "In Transit"
Event Status Detail Description
Example: "Your shipment is on its way between depots."
carrier status description
Example: "Your item was delivered in or at the mailbox at 9:10 am on March"
A URL to an image captured at the time of delivery, serving as evidence that the shipment was successfully delivered to the recipient. It can be used to capture things like recipient's signature, location of delivery, condition of the package upon delivery, etc.
Example: "https://tracking-service-prod.s3.amazonaws.com/proof-of-delivery/dummy_module/0000000001/bc6dd17969bd97f24262ca73ac6ff36062aafecba25ef16d4178264bf7c0e72c.png"
Response
application/json
{ "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": [ { … } ] }
- Mock serverhttps://docs.shipstation.com/_mock/openapi/v2/labels/{label_id}/void
- Productionhttps://api.shipstation.com/v2/labels/{label_id}/void
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://docs.shipstation.com/_mock/openapi/v2/labels/se-28529731/void \
-H 'api-key: YOUR_API_KEY_HERE'The request was a success.
Indicates whether the attempt to void the label was successful
Example: false
Example: "Unable to delete FedEx shipment. Unable to retrieve record from database."
Indicates a normalized reason for the conditions if the void attempt was not approved. Will not populate if approved is true. “unknown” codes may be specified later.
Enum"unknown""unspecified""validation_failed""label_not_found_within_void_period""label_already_used""label_already_voided""contact_carrier"
Example: "label_not_found_within_void_period"
Response
application/json
{ "approved": false, "message": "Unable to delete FedEx shipment. Unable to retrieve record from database.", "reason_code": "label_not_found_within_void_period" }
Webhooks
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.
Operations