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.
curl -i -X GET \ https://docs.shipstation.com/_mock/openapi/v2/packages \ -H 'api-key: YOUR_API_KEY_HERE'
{ "packages": [ { … } ] }
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope
, small_flat_rate_box
, large_package
, etc. Use the code package
for custom or unknown package types.
curl -i -X POST \ https://docs.shipstation.com/_mock/openapi/v2/packages \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "package_id": "se-28529731", "package_code": "small_flat_rate_box", "name": "laptop_box", "dimensions": { "unit": "inch", "length": 2, "width": 2, "height": 1 }, "description": "Packaging for laptops" }'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope
, small_flat_rate_box
, large_package
, etc. Use the code package
for custom or unknown package types.
{ "package_id": "se-28529731", "package_code": "small_flat_rate_box", "name": "laptop_box", "dimensions": { "unit": "inch", "length": 2, "width": 2, "height": 1 }, "description": "Packaging for laptops" }
curl -i -X GET \ 'https://docs.shipstation.com/_mock/openapi/v2/packages/{package_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
The request was a success.
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope
, small_flat_rate_box
, large_package
, etc. Use the code package
for custom or unknown package types.
{ "package_id": "se-28529731", "package_code": "small_flat_rate_box", "name": "laptop_box", "dimensions": { "unit": "inch", "length": 2, "width": 2, "height": 1 }, "description": "Packaging for laptops" }
A string that uniquely identifies a ShipStation resource, such as a carrier, label, shipment, etc.
A [package type] , such as thick_envelope
, small_flat_rate_box
, large_package
, etc. Use the code package
for custom or unknown package types.
curl -i -X PUT \ 'https://docs.shipstation.com/_mock/openapi/v2/packages/{package_id}' \ -H 'Content-Type: application/json' \ -H 'api-key: YOUR_API_KEY_HERE' \ -d '{ "package_id": "se-28529731", "package_code": "small_flat_rate_box", "name": "laptop_box", "dimensions": { "unit": "inch", "length": 2, "width": 2, "height": 1 }, "description": "Packaging for laptops" }'
No response example
curl -i -X DELETE \ 'https://docs.shipstation.com/_mock/openapi/v2/packages/{package_id}' \ -H 'api-key: YOUR_API_KEY_HERE'
No response example
Webhooks are a powerful feature that can save you from sending repeated polling requests to check on the state of something. With webhooks, ShipStation will automatically contact your servers when the stage changes. This can include parcel tracking events, notification when a batch operation completes, and more.