ShipStation

App · 22 actions

Manage ShipStation v2 shipments, labels, carrier services, warehouses, rates and tags.

Actions

ActionWhat it does
Create labelPurchase a label for an existing shipment.
Create shipmentsCreate shipments.
Create tagCreate tag.
Create warehouseCreate warehouse.
Delete tagDelete tag.
Delete warehouseDelete warehouse.
Estimate ratesEstimate rates.
Get labelGet one shipping label by its ID: its tracking number, tracking link, whether the package was delivered (tracking_status), the carrier, and the customer's name and email (ship_to).
Get shipmentGet one shipment by its ID: the customer's name, email and address (ship_to), its order number, status, items and notes.
Get warehouseGet warehouse.
List carrier packagesList carrier packages.
List carrier servicesList carrier services.
List carriersList carriers.
List labelsList the shipping labels bought in ShipStation, newest first, 100 at a time.
List orders waiting to shipBeta.
List package typesList package types.
List shipmentsList the shipments in ShipStation, 100 at a time, each with the customer's name, email and address (ship_to), its order number and status.
List shipments not delivered yetBeta.
List tagsList tags.
List warehousesList warehouses.
Update shipmentUpdate shipment.
Void labelVoid label.

Create label

Purchase a label for an existing shipment. Select a shipment created by an earlier step; carrier charges may apply.

Inputs

Shipmentshipment_idtextRequired
An existing ShipStation shipment. Creating this label can charge your carrier account.
Validate addressvalidate_addresstext
The possible validate address valuesOne of: no_validation, validate_only, validate_and_clean.
Label layoutlabel_layouttext
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.One of: 4x6, letter.
Label formatlabel_formattext
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` <br> `stamps_com` <br> `ups` <br> `usps` |`zpl` | `access_worldwide` <br> `apc` <br> `asendia` <br> `dhl_global_mail` <br> `dhl_express` <br> `dhl_express_australia` <br> `dhl_express_canada` <br> `dhl_express_worldwide` <br> `dhl_express_uk` <br> `dpd` <br> `endicia` <br> `fedex` <br> `fedex_uk` <br> `firstmile` <br> `imex` <br> `newgistics` <br> `ontrac` <br> `stamps_com` <br> `ups` <br> `usps`One of: pdf, png, zpl.
Label download typelabel_download_typetext
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.<br><br>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.One of: url, inline.
Display schemedisplay_schemetext
The display format that the label should be shown in.One of: label, paperless, label_and_paperless.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "alternative_identifiers": [],
    "batch_id": "",
    "carrier_code": "",
    "carrier_id": "",
    "charge_event": "carrier_default",
    "confirmation": "none",
    "created_at": "",
    "delivery_prediction": {
      "confidence_level": "high",
      "delivery_date": ""
    },
    "display_scheme": "label",
    "external_order_id": "",
    "external_shipment_id": "",
    "form_download": {
      "href": "",
      "type": ""
    },
    "insurance_claim": {
      "href": "",
      "type": ""
    },
    "insurance_cost": {
      "amount": 0,
      "currency": ""
    },
    "is_international": false,
    "is_return_label": false,
    "label_download": {
      "href": "",
      "pdf": "",
      "png": "",
      "zpl": ""
    },
    "label_download_type": "url",
    "label_format": "pdf",
    "label_id": "",
    "label_image_id": "",
    "label_layout": "4x6",
    "outbound_label_id": "",
    "package_code": "",
    "packages": [],
    "paperless_download": {
      "handoff_code": "",
      "href": "",
      "instructions": ""
    },
    "qr_code_download": {
      "href": "",
      "type": ""
    },
    "rate_details": [],
    "refund_details": {
      "amount_approved": {},
      "amount_credited": {},
      "amount_paid": {},
      "amount_requested": {},
      "refund_status": "request_scheduled",
      "request_date": ""
    },
    "requested_comparison_amount": {
      "amount": 0,
      "currency": ""
    },
    "rma_number": "",
    "service_code": "",
    "ship_date": "",
    "ship_to": {
      "geolocation": [],
      "instructions": ""
    },
    "shipment": {
      "advanced_options": {},
      "amount_paid": {},
      "assigned_user": "",
      "batch_ids": [],
      "carrier_id": "",
      "comparison_rate_type": "",
      "confirmation": "none",
      "created_at": "",
      "customs": {},
      "deliver_by_date": "",
      "display_scheme": "",
      "external_order_id": "",
      "external_shipment_id": "",
      "hold_until_date": "",
      "insurance_provider": "none",
      "internal_notes": "",
      "is_gift": false,
      "is_return": false,
      "items": [],
      "modified_at": "",
      "notes_for_gift": "",
      "notes_from_buyer": "",
      "notes_to_buyer": "",
      "order_source_code": "amazon_ca",
      "packages": [],
      "requested_shipment_service": "",
      "retail_rate": {},
      "return_to": {},
      "sales_order_ids": [],
      "service_code": "",
      "ship_by_date": "",
      "ship_date": "",
      "ship_from": {},
      "ship_to": {},
      "shipment_id": "",
      "shipment_number": "",
      "shipment_status": "pending",
      "shipping_paid": {},
      "store_id": "",
      "tags": [],
      "tax_identifiers": [],
      "tax_paid": {},
      "total_weight": {},
      "warehouse_id": "",
      "zone": 0
    },
    "shipment_cost": {
      "amount": 0,
      "currency": ""
    },
    "shipment_id": "",
    "status": "processing",
    "test_label": false,
    "trackable": false,
    "tracking_number": "",
    "tracking_status": "unknown",
    "tracking_url": "",
    "validate_address": "no_validation",
    "void_type": "refund_assist",
    "voided": false,
    "voided_at": ""
  },
  "has_more": false,
  "next_cursor": null
}

Create shipments

Create shipments.

Inputs

ShipmentsshipmentslistRequired
Array of shipments to create

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "has_errors": false,
    "shipments": []
  },
  "has_more": false,
  "next_cursor": null
}

Create tag

Create tag.

Inputs

NamenametextRequired
The tag name.
Colorcolortext
A hex-coded string identifying the color of the tag.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "name": ""
  },
  "has_more": false,
  "next_cursor": null
}

Create warehouse

Create warehouse.

Inputs

Is defaultis_defaulttrue/false
Designates which single warehouse is the default on the account
NamenametextRequired
Name of the warehouse
Origin addressorigin_addressobjectRequired
A complete or partial mailing address.
Return addressreturn_addressobject
A complete or partial mailing address.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "created_at": "",
    "is_default": false,
    "name": "",
    "origin_address": {
      "address_line1": "",
      "address_line2": "",
      "address_line3": "",
      "address_residential_indicator": "unknown",
      "city_locality": "",
      "company_name": "",
      "country_code": "",
      "email": "",
      "name": "",
      "phone": "",
      "postal_code": "",
      "state_province": ""
    },
    "return_address": {
      "address_line1": "",
      "address_line2": "",
      "address_line3": "",
      "address_residential_indicator": "unknown",
      "city_locality": "",
      "company_name": "",
      "country_code": "",
      "email": "",
      "name": "",
      "phone": "",
      "postal_code": "",
      "state_province": ""
    },
    "warehouse_id": ""
  },
  "has_more": false,
  "next_cursor": null
}

Delete tag

Delete tag.

Inputs

Tag nametag_nametextRequired
tag_name.

Outputs

Result.

datatext
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": "",
  "has_more": false,
  "next_cursor": null
}

Delete warehouse

Delete warehouse.

Inputs

Warehousewarehouse_idtextRequired
Warehouse ID

Outputs

Result.

datanull
Data.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": null
}

Estimate rates

Estimate rates.

Inputs

From country codefrom_country_codetextRequired
A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
From postal codefrom_postal_codetextRequired
postal code
From city localityfrom_city_localitytextRequired
from postal code
From state provincefrom_state_provincetextRequired
From state province
To country codeto_country_codetextRequired
A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)One of: AF (Afghanistan), AX (Åland Islands), AL (Albania), DZ (Algeria), AD (Andorra), AO (Angola), AI (Anguilla), AQ (Antarctica), AG (Antigua & Barbuda), AR (Argentina), and 239 more.
To postal codeto_postal_codetextRequired
postal code
To city localityto_city_localitytextRequired
The city locality the package is being shipped to
To state provinceto_state_provincetextRequired
To state province
WeightweightobjectRequired
The weight of a package
Dimensionsdimensionsobject
The dimensions of a package
Confirmationconfirmationtext
The possible delivery confirmation valuesOne of: none, delivery, signature, adult_signature, adult_signature_restricted_delivery, direct_signature, delivery_mailed, verbal_confirmation, delivery_code, age_verification_16_plus.
Address residential indicatoraddress_residential_indicatortext
Indicates whether an address is residential.One of: unknown, yes, no.
Ship dateship_datedate and timeRequired
An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.
Carrier idscarrier_idslistRequired
Array of Carrier IDs

Outputs

Result.

datalist
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}

Get label

Get one shipping label by its ID: its tracking number, tracking link, whether the package was delivered (tracking_status), the carrier, and the customer's name and email (ship_to).

Inputs

Label idlabel_idtextRequired
The label's ID, such as se-28529731, from 'List labels'.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "alternative_identifiers": [],
    "batch_id": "",
    "carrier_code": "ups",
    "carrier_id": "se-28529731",
    "charge_event": "carrier_default",
    "confirmation": "none",
    "created_at": "2026-11-04T15:02:11.000Z",
    "delivery_prediction": {
      "confidence_level": "high",
      "delivery_date": ""
    },
    "display_scheme": "label",
    "external_order_id": "5123456789",
    "external_shipment_id": "10001",
    "form_download": {
      "href": "",
      "type": ""
    },
    "insurance_claim": {
      "href": "",
      "type": ""
    },
    "insurance_cost": {
      "amount": 0,
      "currency": ""
    },
    "is_international": false,
    "is_return_label": false,
    "label_download": {
      "href": "",
      "pdf": "",
      "png": "",
      "zpl": ""
    },
    "label_download_type": "url",
    "label_format": "pdf",
    "label_id": "se-402157839",
    "label_image_id": "",
    "label_layout": "4x6",
    "outbound_label_id": "",
    "package_code": "",
    "packages": [],
    "paperless_download": {
      "handoff_code": "",
      "href": "",
      "instructions": ""
    },
    "qr_code_download": {
      "href": "",
      "type": ""
    },
    "rate_details": [],
    "refund_details": {
      "amount_approved": {},
      "amount_credited": {},
      "amount_paid": {},
      "amount_requested": {},
      "refund_status": "request_scheduled",
      "request_date": ""
    },
    "requested_comparison_amount": {
      "amount": 0,
      "currency": ""
    },
    "rma_number": "",
    "service_code": "ups_ground",
    "ship_date": "2026-11-04T00:00:00Z",
    "ship_to": {
      "address_line1": "2408 Elm Street",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "yes",
      "city_locality": "Austin",
      "company_name": null,
      "country_code": "US",
      "email": "maria.lopez@example.com",
      "instructions": null,
      "name": "Maria Lopez",
      "phone": "+1 512-555-0142",
      "postal_code": "78703",
      "state_province": "TX"
    },
    "shipment_cost": {
      "amount": 8.45,
      "currency": "usd"
    },
    "shipment_id": "se-791204417",
    "status": "completed",
    "test_label": false,
    "trackable": true,
    "tracking_number": "1Z932R800392060079",
    "tracking_status": "in_transit",
    "tracking_url": "https://www.ups.com/track?tracknum=1Z932R800392060079",
    "validate_address": "no_validation",
    "void_type": "refund_assist",
    "voided": false,
    "voided_at": ""
  },
  "has_more": false,
  "next_cursor": null
}

Get shipment

Get one shipment by its ID: the customer's name, email and address (ship_to), its order number, status, items and notes. A shipment has no tracking number, link or delivery status: those are on its label ('List labels'), and 'List shipments not delivered yet' finds the late ones.

Inputs

Shipment idshipment_idtextRequired
The shipment's ID, such as se-28529731. A label carries it as shipment_id.

Outputs

Result.

dataobject
One order. ShipStation's API calls an order a shipment: shipment_number is the order number, ship_to.name the customer, created_at when it arrived, and shipment_status where it stands.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "advanced_options": {
      "additional_handling": false,
      "ancillary_endorsements_option": "",
      "bill_to_account": "",
      "bill_to_country_code": "",
      "bill_to_party": "recipient",
      "bill_to_postal_code": "",
      "collect_on_delivery": {},
      "contains_alcohol": false,
      "custom_field1": "",
      "custom_field2": "",
      "custom_field3": "",
      "dangerous_goods": false,
      "dangerous_goods_contact": {},
      "delivered_duty_paid": false,
      "delivery_as_addressed": false,
      "dry_ice": false,
      "dry_ice_weight": {},
      "event_notification": false,
      "fedex_freight": {},
      "fragile": false,
      "freight_class": "",
      "limited_quantity": false,
      "movement_indicator": "c2c",
      "netstamps_options": {},
      "non_machinable": false,
      "origin_type": "pickup",
      "own_document_upload": false,
      "regulated_content_type": "day_old_poultry",
      "return_after_first_attempt": false,
      "return_pickup_attempts": 0,
      "saturday_delivery": false,
      "shipper_release": false,
      "suppress_carrier_generated_documents": [],
      "third_party_consignee": false,
      "transparency_codes": [],
      "use_ups_ground_freight_pricing": false,
      "windsor_framework_details": {}
    },
    "amount_paid": {
      "amount": 48.47,
      "currency": "usd"
    },
    "assigned_user": null,
    "batch_ids": [],
    "carrier_id": null,
    "comparison_rate_type": null,
    "confirmation": "none",
    "created_at": "2026-11-07T15:04:00.000Z",
    "customs": {
      "contents": "merchandise",
      "contents_explanation": "",
      "customs_items": [],
      "declaration": "",
      "importer_of_record": {},
      "invoice_additional_details": {},
      "non_delivery": "return_to_sender",
      "pending_documents": false,
      "terms_of_trade_code": "exw"
    },
    "deliver_by_date": null,
    "display_scheme": null,
    "external_order_id": "5521048",
    "external_shipment_id": "5521048",
    "hold_until_date": null,
    "insurance_provider": "none",
    "internal_notes": null,
    "is_gift": false,
    "is_return": false,
    "items": [
      {
        "allocation_status": null,
        "asin": null,
        "bundle_sku": null,
        "external_order_id": "5521048",
        "external_order_item_id": "1",
        "fullfilment_sku": null,
        "image_url": null,
        "inventory_location": null,
        "item_id": "1402291169813",
        "name": "Ceramic mug",
        "options": [
          {
            "name": "Color",
            "value": "Blue"
          }
        ],
        "order_source_code": "shopify",
        "product_id": "10408926",
        "quantity": 2,
        "sales_order_id": null,
        "sales_order_item_id": null,
        "shipping_amount": 9.5,
        "sku": "MUG-01",
        "tax_amount": 2.97,
        "unit_price": 18.0,
        "upc": null,
        "weight": {
          "unit": "ounce",
          "value": 12
        }
      }
    ],
    "modified_at": "2026-11-07T15:04:00.000Z",
    "notes_for_gift": null,
    "notes_from_buyer": "Please leave at the side door",
    "notes_to_buyer": null,
    "order_source_code": "shopify",
    "packages": [
      {
        "content_description": null,
        "dimensions": {
          "height": 4,
          "length": 8,
          "unit": "inch",
          "width": 6
        },
        "external_package_id": null,
        "insured_value": {
          "amount": 0,
          "currency": "usd"
        },
        "label_messages": {
          "reference1": null,
          "reference2": null,
          "reference3": null
        },
        "package_code": "package",
        "package_id": null,
        "package_name": null,
        "products": [],
        "shipment_package_id": "se-123456",
        "weight": {
          "unit": "ounce",
          "value": 24
        }
      }
    ],
    "requested_shipment_service": "Expedited Shipping",
    "retail_rate": null,
    "return_to": {
      "address_line1": "4009 Marathon Blvd",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "no",
      "city_locality": "Austin",
      "company_name": "Acme Goods",
      "country_code": "US",
      "email": null,
      "geolocation": [],
      "instructions": null,
      "name": "Acme Shipping",
      "phone": "+1 512-555-0100",
      "postal_code": "78756",
      "state_province": "TX"
    },
    "sales_order_ids": [],
    "service_code": null,
    "ship_by_date": "2026-11-10T00:00:00.000Z",
    "ship_date": "2026-11-12T00:00:00Z",
    "ship_from": {
      "address_line1": "4009 Marathon Blvd",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "no",
      "city_locality": "Austin",
      "company_name": "Acme Goods",
      "country_code": "US",
      "email": null,
      "geolocation": [],
      "instructions": null,
      "name": "Acme Shipping",
      "phone": "+1 512-555-0100",
      "postal_code": "78756",
      "state_province": "TX"
    },
    "ship_to": {
      "address_line1": "525 S Winchester Blvd",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "yes",
      "city_locality": "San Jose",
      "company_name": null,
      "country_code": "US",
      "email": "jane@example.com",
      "geolocation": [],
      "instructions": null,
      "name": "Jane Doe",
      "phone": "+1 512-555-0142",
      "postal_code": "95128",
      "state_province": "CA"
    },
    "shipment_id": "se-28529731",
    "shipment_number": "10001",
    "shipment_status": "pending",
    "shipping_paid": {
      "amount": 9.5,
      "currency": "usd"
    },
    "store_id": "se-12345",
    "tags": [
      {
        "name": "Rush"
      }
    ],
    "tax_identifiers": null,
    "tax_paid": {
      "amount": 2.97,
      "currency": "usd"
    },
    "total_weight": {
      "unit": "ounce",
      "value": 24
    },
    "warehouse_id": "se-28529799",
    "zone": null
  },
  "has_more": false,
  "next_cursor": null
}

Get warehouse

Get warehouse.

Inputs

Warehousewarehouse_idtextRequired
Warehouse ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "created_at": "",
    "is_default": false,
    "name": "",
    "origin_address": {
      "address_line1": "",
      "address_line2": "",
      "address_line3": "",
      "address_residential_indicator": "unknown",
      "city_locality": "",
      "company_name": "",
      "country_code": "",
      "email": "",
      "name": "",
      "phone": "",
      "postal_code": "",
      "state_province": ""
    },
    "return_address": {
      "address_line1": "",
      "address_line2": "",
      "address_line3": "",
      "address_residential_indicator": "unknown",
      "city_locality": "",
      "company_name": "",
      "country_code": "",
      "email": "",
      "name": "",
      "phone": "",
      "postal_code": "",
      "state_province": ""
    },
    "warehouse_id": ""
  },
  "has_more": false,
  "next_cursor": null
}

List carrier packages

List carrier packages.

Inputs

Carriercarrier_idtextRequired
Carrier ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "packages": []
  },
  "has_more": false,
  "next_cursor": null
}

List carrier services

List carrier services.

Inputs

Carriercarrier_idtextRequired
Carrier ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "services": []
  },
  "has_more": false,
  "next_cursor": null
}

List carriers

List carriers.

Inputs

Pagepagenumber
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.At least 1.
Page sizepage_sizenumber
The number of results to return per response.At least 1.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "carriers": [],
    "errors": [],
    "links": {
      "first": {},
      "last": {},
      "next": {},
      "prev": {}
    },
    "page": 0,
    "pages": 0,
    "request_id": "",
    "total": 0
  },
  "has_more": false,
  "next_cursor": null
}

List labels

List the shipping labels bought in ShipStation, newest first, 100 at a time. A label is one package on its way: it holds the tracking number, the tracking link, whether it was delivered (tracking_status) and the customer's name and email (ship_to). This is one page. While has_more is true, run the step again with Page set to next_cursor (the next page's number) to read on. For packages that shipped a while ago and still are not delivered, use 'List shipments not delivered yet' instead: it reads every page and does the filtering.

Inputs

Label statuslabel_statustext
Only list labels in this state: Completed (bought and usable), Processing, Error or Voided (cancelled). This is the label's own state, not whether the package was delivered. Leave blank for all of them.One of: processing, completed, error, voided.
Created at startcreated_at_startdate and time
Only list labels bought at or after this time.
Created at endcreated_at_enddate and time
Only list labels bought at or before this time.
Pagepagenumber
Which page to read, starting at 1. Leave blank for the first page; for the next one, give the next_cursor the page before returned.At least 1.
Page sizepage_sizenumber
How many labels one page holds. 100 when left blank.At least 1.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
True when there is another page to read.
next_cursortext
The number of the next page, as text, such as 2. Put it in Page to read the next page. Blank on the last page.
Example output
{
  "data": {
    "labels": [
      {
        "carrier_code": "ups",
        "carrier_id": "se-28529731",
        "created_at": "2026-11-04T15:02:11.000Z",
        "external_order_id": "5123456789",
        "external_shipment_id": "10001",
        "is_international": false,
        "is_return_label": false,
        "label_id": "se-402157839",
        "service_code": "ups_ground",
        "ship_date": "2026-11-04T00:00:00Z",
        "ship_to": {
          "address_line1": "2408 Elm Street",
          "address_line2": null,
          "address_line3": null,
          "address_residential_indicator": "yes",
          "city_locality": "Austin",
          "company_name": null,
          "country_code": "US",
          "email": "maria.lopez@example.com",
          "instructions": null,
          "name": "Maria Lopez",
          "phone": "+1 512-555-0142",
          "postal_code": "78703",
          "state_province": "TX"
        },
        "shipment_cost": {
          "amount": 8.45,
          "currency": "usd"
        },
        "shipment_id": "se-791204417",
        "status": "completed",
        "trackable": true,
        "tracking_number": "1Z932R800392060079",
        "tracking_status": "in_transit",
        "tracking_url": "https://www.ups.com/track?tracknum=1Z932R800392060079",
        "voided": false
      }
    ],
    "links": {
      "first": {},
      "last": {},
      "next": {},
      "prev": {}
    },
    "page": 1,
    "pages": 1,
    "total": 1
  },
  "has_more": false,
  "next_cursor": null
}

List orders waiting to ship

Beta. List the orders that haven't shipped yet, expedited orders first and then the longest-waiting, optionally only those that have waited a number of days. It reads every page itself and returns one ready-to-read record per order (order number, customer, days waiting, ship-by date, requested shipping service) plus the same list as text ready to post in a message. ShipStation doesn't mark an order as expedited, so an order counts as expedited when its requested service, carrier service or a tag contains one of the Expedited words. Orders on hold are left out unless asked for. ShipStation doesn't say which unshipped orders are still waiting for payment, so those are included.

Inputs

Waiting more than (days)waiting_daysnumber
Only orders that arrived in ShipStation more than this many days ago: 2 lists every order that has waited longer than 2 full days (48 hours). Leave empty for every unshipped order.From 0 to 3650.
Expedited wordsexpedited_wordstext
The words that mark an order as expedited, separated by commas. An order is expedited when its requested shipping service, its carrier service or one of its tags contains one of them; capitals don't matter. Stores name their shipping options themselves, so change this to match yours. When left empty: expedited, express, overnight, next day, 2 day, 2day, 2nd day, second day, two day, rush.
Include orders on holdinclude_on_holdtrue/false
Turn on to also list orders that are on hold. They are left out otherwise, since they aren't meant to ship yet.

Outputs

The orders waiting to ship.

countnumber
How many orders are listed.
expedited_countnumber
How many of them are expedited.
has_moretrue/false
True only when more than 5,000 orders matched: the 5,000 longest-waiting are listed and the rest left out.
orderslist
One record per order, expedited orders first and then the longest-waiting.
texttext
The same orders as text, one line each in the same order, ready to put in a Slack message or an email. When there are none it says so in a sentence.
Example output
{
  "count": 2,
  "expedited_count": 1,
  "has_more": false,
  "orders": [
    {
      "carrier_service": "",
      "created_at": "2026-11-07T15:04:00.000Z",
      "created_at_display": "Nov 7, 2026",
      "customer_email": "jane@example.com",
      "customer_name": "Jane Doe",
      "days_waiting": 5,
      "hold_until_date": null,
      "is_expedited": true,
      "is_past_ship_by": true,
      "item_count": 2,
      "items_summary": "2 x Ceramic mug",
      "on_hold": false,
      "order_number": "10001",
      "requested_service": "Expedited Shipping",
      "ship_by_date": "2026-11-10T00:00:00.000Z",
      "ship_by_display": "Nov 10, 2026",
      "shipment_id": "se-28529731",
      "tags": [
        "Rush"
      ]
    },
    {
      "carrier_service": "usps_ground_advantage",
      "created_at": "2026-11-03T09:30:00.000Z",
      "created_at_display": "Nov 3, 2026",
      "customer_email": "",
      "customer_name": "Sam Lee",
      "days_waiting": 9,
      "hold_until_date": null,
      "is_expedited": false,
      "is_past_ship_by": false,
      "item_count": 3,
      "items_summary": "1 x Desk lamp, 2 x Bulb",
      "on_hold": false,
      "order_number": "9987",
      "requested_service": "Standard",
      "ship_by_date": null,
      "ship_by_display": "",
      "shipment_id": "se-28529604",
      "tags": []
    }
  ],
  "text": "\u2022 EXPEDITED \u00b7 Order 10001 \u00b7 Jane Doe \u00b7 waiting 5 days (since Nov 7, 2026) \u00b7 Expedited Shipping \u00b7 ship by Nov 10, 2026 (overdue) \u00b7 2 items\n\u2022 Order 9987 \u00b7 Sam Lee \u00b7 waiting 9 days (since Nov 3, 2026) \u00b7 Standard \u00b7 3 items"
}

List package types

List package types.

Inputs

None.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "packages": []
  },
  "has_more": false,
  "next_cursor": null
}

List shipments

List the shipments in ShipStation, 100 at a time, each with the customer's name, email and address (ship_to), its order number and status. Narrow it by status, tag or when it was created or changed. This is one page. While has_more is true, run the step again with Page set to next_cursor (the next page's number) to read on. A shipment has no tracking number, link or delivery status: those are on its label ('List labels'), and 'List shipments not delivered yet' finds the late ones.

Inputs

Statusshipment_statustext
Only list shipments in this state: Pending (no label yet), Processing, Label purchased (shipped or about to) or Cancelled. Leave blank for all of them. There is no 'delivered' here: see 'List shipments not delivered yet'.One of: pending, processing, label_purchased (Label purchased), cancelled.
Tagtagtext
Only list shipments that carry this tag, by the tag's name, such as Priority. One tag at a time.
Created aftercreated_at_startdate and time
Only list shipments created at or after this time.
Created beforecreated_at_enddate and time
Only list shipments created at or before this time.
Changed aftermodified_at_startdate and time
Only list shipments changed at or after this time.
Changed beforemodified_at_enddate and time
Only list shipments changed at or before this time.
Sort bysort_bytext
Beta. The date to put the orders in order by: when each arrived (created_at) or was last changed (modified_at).One of: created_at (When it arrived (created_at)), modified_at (When it last changed (modified_at)).
Ordersort_dirtext
Beta. asc puts the oldest first; desc puts the newest first, which is what ShipStation does when this is left empty.One of: asc (Oldest first (asc)), desc (Newest first (desc)).
All pagesall_pagestrue/false
Beta. Turn on to get every matching order in this one step, however many pages that takes, instead of one page. It stops after 50 pages, which is 5,000 orders unless Page size is set lower; has_more then says there are more and next_cursor is the page to carry on from.
Pagepagenumber
Which page to read, starting at 1. Leave blank for the first page; for the next one, give the next_cursor the page before returned.At least 1.
Page sizepage_sizenumber
How many shipments one page holds. 100 when left blank.At least 1.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether there are more orders after the ones returned.
next_cursortext
The number of the next page, as text. Give it to this step's Page to read on. Empty when there are no more pages.
Example output
{
  "data": {
    "links": {
      "first": {},
      "last": {},
      "next": {},
      "prev": {}
    },
    "page": 1,
    "pages": 1,
    "shipments": [
      {
        "advanced_options": {
          "additional_handling": false,
          "ancillary_endorsements_option": "",
          "bill_to_account": "",
          "bill_to_country_code": "",
          "bill_to_party": "recipient",
          "bill_to_postal_code": "",
          "collect_on_delivery": {},
          "contains_alcohol": false,
          "custom_field1": "",
          "custom_field2": "",
          "custom_field3": "",
          "dangerous_goods": false,
          "dangerous_goods_contact": {},
          "delivered_duty_paid": false,
          "delivery_as_addressed": false,
          "dry_ice": false,
          "dry_ice_weight": {},
          "event_notification": false,
          "fedex_freight": {},
          "fragile": false,
          "freight_class": "",
          "limited_quantity": false,
          "movement_indicator": "c2c",
          "netstamps_options": {},
          "non_machinable": false,
          "origin_type": "pickup",
          "own_document_upload": false,
          "regulated_content_type": "day_old_poultry",
          "return_after_first_attempt": false,
          "return_pickup_attempts": 0,
          "saturday_delivery": false,
          "shipper_release": false,
          "suppress_carrier_generated_documents": [],
          "third_party_consignee": false,
          "transparency_codes": [],
          "use_ups_ground_freight_pricing": false,
          "windsor_framework_details": {}
        },
        "amount_paid": {
          "amount": 48.47,
          "currency": "usd"
        },
        "assigned_user": null,
        "batch_ids": [],
        "carrier_id": null,
        "comparison_rate_type": null,
        "confirmation": "none",
        "created_at": "2026-11-07T15:04:00.000Z",
        "customs": {
          "contents": "merchandise",
          "contents_explanation": "",
          "customs_items": [],
          "declaration": "",
          "importer_of_record": {},
          "invoice_additional_details": {},
          "non_delivery": "return_to_sender",
          "pending_documents": false,
          "terms_of_trade_code": "exw"
        },
        "deliver_by_date": null,
        "display_scheme": null,
        "external_order_id": "5521048",
        "external_shipment_id": "5521048",
        "hold_until_date": null,
        "insurance_provider": "none",
        "internal_notes": null,
        "is_gift": false,
        "is_return": false,
        "items": [
          {
            "allocation_status": null,
            "asin": null,
            "bundle_sku": null,
            "external_order_id": "5521048",
            "external_order_item_id": "1",
            "fullfilment_sku": null,
            "image_url": null,
            "inventory_location": null,
            "item_id": "1402291169813",
            "name": "Ceramic mug",
            "options": [
              {
                "name": "Color",
                "value": "Blue"
              }
            ],
            "order_source_code": "shopify",
            "product_id": "10408926",
            "quantity": 2,
            "sales_order_id": null,
            "sales_order_item_id": null,
            "shipping_amount": 9.5,
            "sku": "MUG-01",
            "tax_amount": 2.97,
            "unit_price": 18.0,
            "upc": null,
            "weight": {
              "unit": "ounce",
              "value": 12
            }
          }
        ],
        "modified_at": "2026-11-07T15:04:00.000Z",
        "notes_for_gift": null,
        "notes_from_buyer": "Please leave at the side door",
        "notes_to_buyer": null,
        "order_source_code": "shopify",
        "packages": [
          {
            "content_description": null,
            "dimensions": {
              "height": 4,
              "length": 8,
              "unit": "inch",
              "width": 6
            },
            "external_package_id": null,
            "insured_value": {
              "amount": 0,
              "currency": "usd"
            },
            "label_messages": {
              "reference1": null,
              "reference2": null,
              "reference3": null
            },
            "package_code": "package",
            "package_id": null,
            "package_name": null,
            "products": [],
            "shipment_package_id": "se-123456",
            "weight": {
              "unit": "ounce",
              "value": 24
            }
          }
        ],
        "requested_shipment_service": "Expedited Shipping",
        "retail_rate": null,
        "return_to": {
          "address_line1": "4009 Marathon Blvd",
          "address_line2": null,
          "address_line3": null,
          "address_residential_indicator": "no",
          "city_locality": "Austin",
          "company_name": "Acme Goods",
          "country_code": "US",
          "email": null,
          "geolocation": [],
          "instructions": null,
          "name": "Acme Shipping",
          "phone": "+1 512-555-0100",
          "postal_code": "78756",
          "state_province": "TX"
        },
        "sales_order_ids": [],
        "service_code": null,
        "ship_by_date": "2026-11-10T00:00:00.000Z",
        "ship_date": "2026-11-12T00:00:00Z",
        "ship_from": {
          "address_line1": "4009 Marathon Blvd",
          "address_line2": null,
          "address_line3": null,
          "address_residential_indicator": "no",
          "city_locality": "Austin",
          "company_name": "Acme Goods",
          "country_code": "US",
          "email": null,
          "geolocation": [],
          "instructions": null,
          "name": "Acme Shipping",
          "phone": "+1 512-555-0100",
          "postal_code": "78756",
          "state_province": "TX"
        },
        "ship_to": {
          "address_line1": "525 S Winchester Blvd",
          "address_line2": null,
          "address_line3": null,
          "address_residential_indicator": "yes",
          "city_locality": "San Jose",
          "company_name": null,
          "country_code": "US",
          "email": "jane@example.com",
          "geolocation": [],
          "instructions": null,
          "name": "Jane Doe",
          "phone": "+1 512-555-0142",
          "postal_code": "95128",
          "state_province": "CA"
        },
        "shipment_id": "se-28529731",
        "shipment_number": "10001",
        "shipment_status": "pending",
        "shipping_paid": {
          "amount": 9.5,
          "currency": "usd"
        },
        "store_id": "se-12345",
        "tags": [
          {
            "name": "Rush"
          }
        ],
        "tax_identifiers": null,
        "tax_paid": {
          "amount": 2.97,
          "currency": "usd"
        },
        "total_weight": {
          "unit": "ounce",
          "value": 24
        },
        "warehouse_id": "se-28529799",
        "zone": null
      }
    ],
    "total": 1
  },
  "has_more": false,
  "next_cursor": null
}

List shipments not delivered yet

Beta. Find the packages that shipped more than a number of days ago and still are not delivered, to apologise to each customer or post the list. Each comes with the customer's name and email, the tracking number and link, the carrier, when it shipped and how many days ago, and the result has a count and the whole list as text ready to post. It reads every page of labels itself, so no paging loop, date calculation or filter step is needed. Delivered packages, cancelled labels, return labels and labels the carrier does not track are left out; packages whose tracking is unknown or failed are kept, and say so. In a daily workflow that emails customers, one step serves both jobs: post 'text' for the full list, and email only the shipments whose 'newly_late' is true, so each customer is emailed once.

Inputs

Shipped more than this many days agoshipped_more_than_daysnumber
How many days a package may be on the road before it counts as late: 5 lists packages that shipped 6 or more days ago. Days are whole calendar days (UTC). 5 when left blank.From 0 to 364. Default: 5.
Look back this many dayslook_back_daysnumber
How far back to look: labels bought longer ago than this are not checked, so a package lost for months stops being listed. It must be more than the number of days above. 30 when left blank.From 1 to 365. Default: 30.
Which shipments to returnincludetext
'All that are late now' lists every late shipment, each marked with whether it became late since yesterday (newly_late). 'Only those that became late since yesterday' lists just the shipments that crossed the number of days above in the last day, so a workflow that runs every day lists each shipment once. A day the workflow does not run is not caught up later.One of: all_late (All that are late now), newly_late (Only those that became late since yesterday). Default: all_late.

Outputs

countnumber
How many shipments are listed. 0 when there are none, so 'post nothing when the list is empty' is one check.
has_moretrue/false
True when there were more labels in the look-back period than one step reads, so older late shipments may be missing. Shorten the look-back if this is true.
newly_late_countnumber
How many of them became late since yesterday.
shipmentslist
The shipments not delivered yet, the longest on the road first. Empty when there are none.
texttext
The whole list as text, one line per shipment with the customer, order number, carrier, tracking number, status, ship date, days since and tracking link, ready to post in a message. Blank when there are none.
Example output
{
  "count": 2,
  "has_more": false,
  "newly_late_count": 1,
  "shipments": [
    {
      "carrier": "UPS",
      "customer_email": "maria.lopez@example.com",
      "customer_first_name": "Maria",
      "customer_name": "Maria Lopez",
      "days_since_shipped": 8,
      "label_id": "se-402157839",
      "newly_late": false,
      "order_number": "10001",
      "shipment_id": "se-791204417",
      "shipped_display": "November 4, 2026",
      "shipped_on": "2026-11-04",
      "tracking_number": "1Z932R800392060079",
      "tracking_status": "In transit",
      "tracking_url": "https://www.ups.com/track?tracknum=1Z932R800392060079"
    },
    {
      "carrier": "USPS",
      "customer_email": "",
      "customer_first_name": "Daniel",
      "customer_name": "Daniel Okafor",
      "days_since_shipped": 6,
      "label_id": "se-402198114",
      "newly_late": true,
      "order_number": "10014",
      "shipment_id": "se-791260932",
      "shipped_display": "November 6, 2026",
      "shipped_on": "2026-11-06",
      "tracking_number": "9400111899223344556677",
      "tracking_status": "Unknown",
      "tracking_url": ""
    }
  ],
  "text": "\u2022 Maria Lopez, order 10001: UPS 1Z932R800392060079, In transit, shipped November 4, 2026 (8 days ago) https://www.ups.com/track?tracknum=1Z932R800392060079\n\u2022 Daniel Okafor, order 10014: USPS 9400111899223344556677, Unknown, shipped November 6, 2026 (6 days ago)"
}

List tags

List tags.

Inputs

None.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "tags": []
  },
  "has_more": false,
  "next_cursor": null
}

List warehouses

List warehouses.

Inputs

None.

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "warehouses": []
  },
  "has_more": false,
  "next_cursor": null
}

Update shipment

Update shipment.

Inputs

Shipment idshipment_idtextRequired
Shipment ID
Carriercarrier_idtext
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Service codeservice_codetext
A [carrier service], such as `fedex_ground`, `usps_first_class_mail`, `flat_rate_envelope`, etc.
Requested shipment servicerequested_shipment_servicetext
The requested shipment service
External order idexternal_order_idtext
ID that the Order Source assigned
Hold until datehold_until_datedate and time
Date to hold the shipment until
Ship by dateship_by_datedate and time
Date by which the shipment should be shipped
Deliver by datedeliver_by_datedate and time
Date by which the shipment should be delivered
Retail rateretail_rateobject
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Store idstore_idtext
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Itemsitemslist
Describe the packages included in this shipment as related to potential metadata that was imported from external order sources
Notes from buyernotes_from_buyertext
Notes from the buyer
Notes to buyernotes_to_buyertext
Notes to the buyer
Notes for giftnotes_for_gifttext
Gift notes
Internal notesinternal_notestext
Internal notes from the seller
Is giftis_gifttrue/false
Indicates if the shipment is a gift
Assigned userassigned_usertext
User assigned to the shipment
Amount paidamount_paidobject
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Shipping paidshipping_paidobject
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Tax paidtax_paidobject
A monetary value, such as the price of a shipping label, the insured value of a package, or an account balance.
Zonezonenumber
Shipping zoneAt least 0.
Display schemedisplay_schemetext
Display scheme for the shipment
Tax identifierstax_identifierslist
tax_identifiers.
External shipment idexternal_shipment_idtext
A user-defined key that identifies the source order. Multiple shipments can share the same `external_shipment_id` (common in split-shipping scenarios where one order results in multiple shipments). Functionally identical to `orderKey` in V1 API. > **Warning:** The `external_shipment_id` is limited to 50 characters. Any additional characters will be truncated.
Shipment numbershipment_numbertext
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_number` is limited to 50 characters. Any additional characters will be truncated.
Ship dateship_datedate and time
An [ISO 8601](https://en.wikipedia.org/wiki/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 .
Ship toship_toobject
A complete or partial mailing address.
Ship fromship_fromobject
A complete or partial mailing address.
Warehousewarehouse_idtext
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Return toreturn_toobject
A complete or partial mailing address.
Is returnis_returntrue/false
An optional indicator if the shipment is intended to be a return. Defaults to false if not provided.
Confirmationconfirmationtext
The possible delivery confirmation valuesOne of: none, delivery, signature, adult_signature, adult_signature_restricted_delivery, direct_signature, delivery_mailed, verbal_confirmation, delivery_code, age_verification_16_plus.
Customscustomsobject
Options for international shipments, such as customs declarations.
Advanced optionsadvanced_optionsobject
Advanced shipment options
Insurance providerinsurance_providertext
The possible insurance provider values. Requests also accept `xcover` as an alias of `x_cover`.One of: none, shipsurance, parcelguard, x_cover, carrier, third_party.
Tagstagslist
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.
Order source codeorder_source_codetext
The order sources that are supported by ShipStationOne of: amazon_ca, amazon_us, brightpearl, channel_advisor, cratejoy, ebay, etsy, jane, groupon_goods, magento, and 10 more.
Packagespackageslist
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.
Comparison rate typecomparison_rate_typetext
Calculate a rate for this shipment with the requested carrier using a ratecard that differs from the default. Only supported for UPS and USPS.
Validate addressvalidate_addresstext
The possible validate address valuesOne of: no_validation, validate_only, validate_and_clean.

Outputs

Result.

dataobject
One order. ShipStation's API calls an order a shipment: shipment_number is the order number, ship_to.name the customer, created_at when it arrived, and shipment_status where it stands.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "advanced_options": {
      "additional_handling": false,
      "ancillary_endorsements_option": "",
      "bill_to_account": "",
      "bill_to_country_code": "",
      "bill_to_party": "recipient",
      "bill_to_postal_code": "",
      "collect_on_delivery": {},
      "contains_alcohol": false,
      "custom_field1": "",
      "custom_field2": "",
      "custom_field3": "",
      "dangerous_goods": false,
      "dangerous_goods_contact": {},
      "delivered_duty_paid": false,
      "delivery_as_addressed": false,
      "dry_ice": false,
      "dry_ice_weight": {},
      "event_notification": false,
      "fedex_freight": {},
      "fragile": false,
      "freight_class": "",
      "limited_quantity": false,
      "movement_indicator": "c2c",
      "netstamps_options": {},
      "non_machinable": false,
      "origin_type": "pickup",
      "own_document_upload": false,
      "regulated_content_type": "day_old_poultry",
      "return_after_first_attempt": false,
      "return_pickup_attempts": 0,
      "saturday_delivery": false,
      "shipper_release": false,
      "suppress_carrier_generated_documents": [],
      "third_party_consignee": false,
      "transparency_codes": [],
      "use_ups_ground_freight_pricing": false,
      "windsor_framework_details": {}
    },
    "amount_paid": {
      "amount": 48.47,
      "currency": "usd"
    },
    "assigned_user": null,
    "batch_ids": [],
    "carrier_id": null,
    "comparison_rate_type": null,
    "confirmation": "none",
    "created_at": "2026-11-07T15:04:00.000Z",
    "customs": {
      "contents": "merchandise",
      "contents_explanation": "",
      "customs_items": [],
      "declaration": "",
      "importer_of_record": {},
      "invoice_additional_details": {},
      "non_delivery": "return_to_sender",
      "pending_documents": false,
      "terms_of_trade_code": "exw"
    },
    "deliver_by_date": null,
    "display_scheme": null,
    "external_order_id": "5521048",
    "external_shipment_id": "5521048",
    "hold_until_date": null,
    "insurance_provider": "none",
    "internal_notes": null,
    "is_gift": false,
    "is_return": false,
    "items": [
      {
        "allocation_status": null,
        "asin": null,
        "bundle_sku": null,
        "external_order_id": "5521048",
        "external_order_item_id": "1",
        "fullfilment_sku": null,
        "image_url": null,
        "inventory_location": null,
        "item_id": "1402291169813",
        "name": "Ceramic mug",
        "options": [
          {
            "name": "Color",
            "value": "Blue"
          }
        ],
        "order_source_code": "shopify",
        "product_id": "10408926",
        "quantity": 2,
        "sales_order_id": null,
        "sales_order_item_id": null,
        "shipping_amount": 9.5,
        "sku": "MUG-01",
        "tax_amount": 2.97,
        "unit_price": 18.0,
        "upc": null,
        "weight": {
          "unit": "ounce",
          "value": 12
        }
      }
    ],
    "modified_at": "2026-11-07T15:04:00.000Z",
    "notes_for_gift": null,
    "notes_from_buyer": "Please leave at the side door",
    "notes_to_buyer": null,
    "order_source_code": "shopify",
    "packages": [
      {
        "content_description": null,
        "dimensions": {
          "height": 4,
          "length": 8,
          "unit": "inch",
          "width": 6
        },
        "external_package_id": null,
        "insured_value": {
          "amount": 0,
          "currency": "usd"
        },
        "label_messages": {
          "reference1": null,
          "reference2": null,
          "reference3": null
        },
        "package_code": "package",
        "package_id": null,
        "package_name": null,
        "products": [],
        "shipment_package_id": "se-123456",
        "weight": {
          "unit": "ounce",
          "value": 24
        }
      }
    ],
    "requested_shipment_service": "Expedited Shipping",
    "retail_rate": null,
    "return_to": {
      "address_line1": "4009 Marathon Blvd",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "no",
      "city_locality": "Austin",
      "company_name": "Acme Goods",
      "country_code": "US",
      "email": null,
      "geolocation": [],
      "instructions": null,
      "name": "Acme Shipping",
      "phone": "+1 512-555-0100",
      "postal_code": "78756",
      "state_province": "TX"
    },
    "sales_order_ids": [],
    "service_code": null,
    "ship_by_date": "2026-11-10T00:00:00.000Z",
    "ship_date": "2026-11-12T00:00:00Z",
    "ship_from": {
      "address_line1": "4009 Marathon Blvd",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "no",
      "city_locality": "Austin",
      "company_name": "Acme Goods",
      "country_code": "US",
      "email": null,
      "geolocation": [],
      "instructions": null,
      "name": "Acme Shipping",
      "phone": "+1 512-555-0100",
      "postal_code": "78756",
      "state_province": "TX"
    },
    "ship_to": {
      "address_line1": "525 S Winchester Blvd",
      "address_line2": null,
      "address_line3": null,
      "address_residential_indicator": "yes",
      "city_locality": "San Jose",
      "company_name": null,
      "country_code": "US",
      "email": "jane@example.com",
      "geolocation": [],
      "instructions": null,
      "name": "Jane Doe",
      "phone": "+1 512-555-0142",
      "postal_code": "95128",
      "state_province": "CA"
    },
    "shipment_id": "se-28529731",
    "shipment_number": "10001",
    "shipment_status": "pending",
    "shipping_paid": {
      "amount": 9.5,
      "currency": "usd"
    },
    "store_id": "se-12345",
    "tags": [
      {
        "name": "Rush"
      }
    ],
    "tax_identifiers": null,
    "tax_paid": {
      "amount": 2.97,
      "currency": "usd"
    },
    "total_weight": {
      "unit": "ounce",
      "value": 24
    },
    "warehouse_id": "se-28529799",
    "zone": null
  },
  "has_more": false,
  "next_cursor": null
}

Void label

Void label.

Inputs

Label idlabel_idtextRequired
Label ID

Outputs

Result.

dataobject
Complete service response.
has_moretrue/false
Whether another page is available.
next_cursortext
Continuation value for the next page.
Example output
{
  "data": {
    "approved": false,
    "message": "",
    "reason_code": "unknown",
    "voided_label_ids": []
  },
  "has_more": false,
  "next_cursor": null
}

On this page