shipments
List shipments
Get list of Shipments
get/v2/shipments
Request
- Base URL: https://api.shipstation.com
- URL: https://api.shipstation.com/v2/shipments
- Auth: API key in header api-key
Query parameters
shipment_status'pending' | 'processing' | 'label_purchased' | 'cancelled'
The possible shipment status values
batch_idstring
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Example:se-28529731
Batch ID
pickup_idstring required
Pickup Resource ID
Example:pik_3YcKU5zdtJuCqoeNwyqqbW
created_at_startstring date-time
Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)
created_at_endstring date-time
Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)
modified_at_startstring date-time
Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)
modified_at_endstring date-time
Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)
pageinteger
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.
page_sizeinteger
The number of results to return per response.
sales_order_idstring
Sales Order ID
sort_dir'asc' | 'desc'
Controls the sort order of queries
| Value | Description |
|---|---|
| asc | Return results in ascending order |
| desc | Return results in descending order |
Controls the sort order of the query.
shipment_numberstring
The user or order source defined shipment number
ship_to_namestring
The name associated with the ship_to
item_keywordstring
Returns shipments that contain items that match the specified keyword. Fields searched are Sku, Description, and Options.
payment_date_startstring date-time
Used to create a filter for resources based on the payment_date parameter after a certain time.
payment_date_endstring date-time
Used to create a filter for resources based on the payment_date parameter before a certain time.
store_idstring
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
Example:se-28529731
Store ID
external_shipment_idstring
sort_by'modified_at' | 'created_at'
The possible shipments sort by values
Response
The request was a success.
Example response
{
"shipments": [
{
"shipment_id": "se-28529731",
"carrier_id": "se-28529731",
"service_code": "usps_first_class_mail",
"requested_shipment_service": "usps_priority_mail",
"shipping_rule_id": "se-28529731",
"external_order_id": "1232434",
"hold_until_date": "2025-01-15T00:00:00.000Z",
"ship_by_date": "2025-01-15T00:00:00.000Z",
"retail_rate": {
"amount": 12
},
"store_id": "se-28529731",
"items": [
{
"name": "box",
"sales_order_id": "12345",
"sales_order_item_id": "1234556",
"quantity": 1,
"sku": "sku-1234",
"bundle_sku": "bundle-123",
"external_order_id": "123445",
"external_order_item_id": "12",
"asin": "B00005N5PF",
"item_id": "1402291169813",
"allocation_status": "allocated",
"image_url": "https://example.com/image.jpg",
"weight": {
"value": 23
},
"unit_price": 88,
"tax_amount": 5.5,
"shipping_amount": 10,
"inventory_location": "warehouse-a",
"options": [
{
"name": "Color",
"value": "Red"
}
],
"product_id": "10408926",
"fullfilment_sku": "fulfill-123",
"upc": "123456789012"
}
],
"notes_from_buyer": "Please handle with care",
"notes_for_gift": "Happy Birthday!",
"is_gift": true,
"assigned_user": "user@example.com",
"amount_paid": {
"amount": 12
},
"shipping_paid": {
"amount": 12
},
"tax_paid": {
"amount": 12
},
"zone": 1,
"display_scheme": "label",
"tax_identifiers": [
{
"issuing_authority": "US",
"value": "value"
}
],
"external_shipment_id": "1234556",
"shipment_number": "10001",
"ship_date": "2018-09-23",
"created_at": "2018-09-23T15:00:00.000Z",
"modified_at": "2018-09-23T15:00:00.000Z",
"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",
"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",
"instructions": "any instructions"
},
"warehouse_id": "se-28529731",
"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",
"instructions": "any instructions"
},
"is_return": true,
"customs": {
"contents_explanation": "rubber duckies",
"declaration": "I hereby certify that the information on this invoice is true and correct and that the contents and value of this shipment are as stated above",
"invoice_additional_details": {
"freight_charge": {
"amount": 12
},
"insurance_charge": {
"amount": 12
},
"discount": {
"amount": 12
},
"estimated_import_charges": {
"taxes": {
"amount": 12
},
"duties": {
"amount": 12
}
},
"other_charge": {
"amount": 12
},
"other_charge_description": "Other charges description"
},
"importer_of_record": {
"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"
},
"customs_items": [
{
"customs_item_id": "se-28529731",
"description": "This is a description",
"quantity": 1,
"value": 12,
"value_currency": "USD",
"weight": {
"value": 23
},
"harmonized_tariff_code": "3926.10",
"country_of_origin": "CA",
"unit_of_measure": "pound",
"sku": "sku-1234",
"sku_description": "this is a description"
}
]
},
"advanced_options": {
"bill_to_account": "123456789",
"bill_to_country_code": "CA",
"bill_to_postal_code": "28005",
"contains_alcohol": true,
"delivered_duty_paid": true,
"dry_ice": true,
"dry_ice_weight": {
"value": 23
},
"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",
"additional_handling": true,
"shipper_release": true,
"collect_on_delivery": {
"payment_amount": {
"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
},
"tags": [
{
"name": "Fragile"
}
],
"packages": [
{
"shipment_package_id": "se-28529731",
"package_id": "se-28529731",
"package_code": "small_flat_rate_box",
"package_name": "Flat Rate Envelope",
"weight": {
"value": 23
},
"dimensions": {
"length": 2,
"width": 2,
"height": 1
},
"insured_value": {
"amount": 12
},
"label_messages": {
"reference1": "Reference",
"reference2": "Reference 2",
"reference3": "Reference 3"
},
"external_package_id": "se-1234545",
"tracking_number": "1Z932R800392060079",
"content_description": "Hand knitted wool socks",
"products": [
{
"description": "a minimum description",
"quantity": 1,
"value": {
"amount": 12
},
"weight": {
"value": 23
},
"harmonized_tariff_code": "3926.10",
"country_of_origin": "CA",
"unit_of_measure": "pound",
"sku": "sku-1223344",
"sku_description": "this is a description",
"mid_code": "GBCOM15BRI",
"product_url": "https://myproduct.com",
"vat_rate": 0.2,
"dangerous_goods": [
{
"id_number": "1234r1",
"shipping_name": "things with dangerous goods",
"technical_name": "chloric acid",
"product_class": "1987",
"product_class_subsidiary": "1987",
"packaging_group": "ii",
"dangerous_amount": {
"amount": 12,
"unit": "GBP"
},
"quantity": 1,
"packaging_instruction": "Packaging materials and containers that are in contact with food products must comply with the provisions established by Regulation ",
"packaging_instruction_section": "section_1",
"packaging_type": "X",
"transport_mean": "ground",
"transport_category": "6.1",
"regulation_authority": "AEAT",
"regulation_level": "excepted_quantity",
"tunnel_code": "all",
"additional_description": "any description"
}
]
}
]
}
],
"total_weight": {
"value": 3
},
"comparison_rate_type": "retail"
}
],
"total": 1990,
"page": 12,
"pages": 4,
"links": {
"first": {
"href": "http://api.shipstation.com/v2/labels/se-28529731",
"type": "child"
},
"last": {
"href": "http://api.shipstation.com/v2/labels/se-28529731",
"type": "child"
},
"prev": {
"href": "http://api.shipstation.com/v2/labels/se-28529731",
"type": "child"
},
"next": {
"href": "http://api.shipstation.com/v2/labels/se-28529731",
"type": "child"
}
}
}Changes
No recorded changes to this operation across all 1 revision of this API.