{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/reference/list-shipments","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/reference/list-shipments","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/reference/list-shipments","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"List Shipments","keywords":"shipping, labels, shipstation, documentation, api","siteUrl":"https://docs.shipstation.com","lang":"en-US","llmstxt":{"hide":false,"title":"ShipStation API LLM Docs","description":"Find links and references to all markdown documentation for use with LLMs","excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"list-shipments","__idx":0},"children":["List Shipments"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Since shipments power most of our services, we allow you to query and manage them. By querying shipments, you expose a paged service that allows you to use multiple filters."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Query Parameters"},"children":["Query Parameters"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["batch_id"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Please note when filtering by ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["batch_id"]},": If you filter by batch, the API will ignore ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_status"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modified_at_start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modified_at_end"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at_start"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at_end"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tag"]},". The API assumes you are opening a batch to view what's in the batch queue and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["batch_id"]}," is the only relevant filter since there are no other filters when executing a batch operation."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tag"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_status"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["ennumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pending"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["processing"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["label_purchased"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["cancelled"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modified_at_start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},") ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"   ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modified_at_end"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},") ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at_start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},") ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"   ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at_end"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["date string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["(",{"$$mdtype":"Tag","name":"a","attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601"},"children":["ISO 8601 Standard"]},") ",{"$$mdtype":"Tag","name":"br","attributes":{},"children":[]},"  ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["2019-07-25T15:24:46.657Z"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["integer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["defaults to 1"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page_size"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["integer"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["defaults to 25"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort_dir"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["ennumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["asc"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["desc"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sort_by"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"em","attributes":{},"children":["ennumerated string"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["modified_at"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-request--response","__idx":1},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET /v1/shipments"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In this example, we'll get a list of the last package we sent using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["east_warehouse"]}," tag."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/shipments?tag=east_warehouse&page=1&page_size=1&sort_dir=desc&sort_by=created_at HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n  \"shipments\": [\n    {\n      \"shipment_id\": \"se-2102034\",\n      \"carrier_id\": \"\",\n      \"external_shipment_id\": \"1daa0c22-0519-46d0-8653-9f3dc62e7d2c\",\n      \"ship_date\": \"2019-07-25T05:00:00.000Z\",\n      \"created_at\": \"2019-07-25T15:24:46.657Z\",\n      \"modified_at\": \"2019-07-25T15:24:46.657Z\",\n      \"shipment_status\": \"pending\",\n      \"ship_to\": {\n        \"name\": \"Amanda Miller\",\n        \"phone\": \"555-555-5555\",\n        \"email\": \"recipient@example.com\",\n        \"address_line1\": \"525 S Winchester Blvd\",\n        \"city_locality\": \"San Jose\",\n        \"state_province\": \"CA\",\n        \"postal_code\": \"95128\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"yes\"\n      },\n      \"ship_from\": {\n        \"company_name\": \"Example Corp.\",\n        \"name\": \"John Doe\",\n        \"phone\": \"111-111-1111\",\n        \"email\": \"sender@example.com\",\n        \"address_line1\": \"4009 Marathon Blvd\",\n        \"address_line2\": \"Suite 300\",\n        \"city_locality\": \"Austin\",\n        \"state_province\": \"TX\",\n        \"postal_code\": \"78756\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"no\"\n      },\n      \"return_to\": {\n        \"company_name\": \"Example Corp.\",\n        \"name\": \"John Doe\",\n        \"phone\": \"111-111-1111\",\n        \"address_line1\": \"4009 Marathon Blvd\",\n        \"address_line2\": \"Suite 300\",\n        \"city_locality\": \"Austin\",\n        \"state_province\": \"TX\",\n        \"postal_code\": \"78756\",\n        \"country_code\": \"US\",\n        \"address_residential_indicator\": \"no\"\n      },\n      \"confirmation\": \"none\",\n      \"advanced_options\": {\n        \"bill_to_account\": null,\n        \"bill_to_country_code\": null,\n        \"bill_to_party\": null,\n        \"bill_to_postal_code\": null,\n        \"contains_alcohol\": false,\n        \"custom_field1\": null,\n        \"custom_field2\": null,\n        \"custom_field3\": null,\n        \"non_machinable\": false,\n        \"saturday_delivery\": false\n      },\n      \"insurance_provider\": \"\",\n      \"tags\": [\n        {\n          \"name\": \"east_warehouse\"\n        }\n      ],\n      \"total_weight\": {\n        \"value\": 9.60,\n        \"units\": \"ounce\"\n      },\n      \"packages\": [\n        {\n          \"weight\": {\n            \"value\": 9.60,\n            \"units\": \"ounce\"\n          },\n          \"dimensions\": {\n            \"units\": \"inch\",\n            \"length\": 12.00,\n            \"width\": 7.10,\n            \"height\": 6.00\n          },\n          \"insured_value\": {\n            \"currency\": \"usd\",\n            \"amount\": 0.0\n          }\n        }\n      ]\n    }\n  ],\n  \"total\": 1,\n  \"page\": 1,\n  \"pages\": 2,\n  \"links\": {\n    \"first\": {\n      \"href\": \"https://api.shipengine.com/v1/shipments?tag=east_warehouse&shipment_status=any&sort_dir=desc&sort_by=created_at&page=1&page_size=1\"\n    },\n    \"last\": {\n      \"href\": \"https://api.shipengine.com/v1/shipments?tag=east_warehouse&shipment_status=any&sort_dir=desc&sort_by=created_at&page=2&page_size=1\"\n    },\n    \"prev\": {},\n    \"next\": {\n      \"href\": \"https://api.shipengine.com/v1/shipments?tag=east_warehouse&shipment_status=any&sort_dir=desc&sort_by=created_at&page=2&page_size=1\"\n    }\n  }\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"List Shipments","id":"list-shipments","depth":1},{"value":"Example Request & Response","id":"example-request--response","depth":2}],"frontmatter":{"seo":{"title":"List Shipments"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/reference/list-shipments","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}