{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/reference/get-batch-by-id","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/reference/get-batch-by-id","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/reference/get-batch-by-id","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Get Batch By ID","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":"get-batch-by-id","__idx":0},"children":["Get Batch By ID"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The final task in a typical batch lifecycle is to get the batch details of the batch you just processed. The response to this GET batch call includes the batch resource links to download the batch labels and forms as well as check that batch status and the review any errors that may have occurred."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If you are new to batches in ShipStation API, be sure to read the ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/labels/bulk"},"children":["Label Batches"]}," overview first."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"requirements","__idx":1},"children":["Requirements"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["batch_id"]}," for the batch you wish to get."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-request--response","__idx":2},"children":["Example Request & Response"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["GET /v1/batches/:batch_id"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"GET /v1/batches/se-1013790 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  \"label_layout\": null,\n  \"label_format\": null,\n  \"batch_id\": \"se-1013790\",\n  \"external_batch_id\": \"1daa0c22-0519-46d0-8653-9f3dc62e7d2c\",\n  \"batch_notes\": \"2019-7-25 Morning Shipments\",\n  \"created_at\": \"2019-07-25T15:24:46.657Z\",\n  \"errors\": 0,\n  \"warnings\": 0,\n  \"completed\": 0,\n  \"forms\": 0,\n  \"count\": 1,\n  \"batch_shipments_url\": {\n    \"href\": \"https://api.shipengine.com/v1/shipments?batch_id=se-1013790\"\n  },\n  \"batch_labels_url\": {\n    \"href\": \"https://api.shipengine.com/v1/labels?batch_id=se-1013790\"\n  },\n  \"batch_errors_url\": {\n    \"href\": \"https://api.shipengine.com/v1/batches/se-1013790/errors\"\n  },\n  \"label_download\": {\n    \"href\": \"https://api.shipengine.com/v1/downloads/1/uths7PctKUqbM4OfmgzXLg/label-1013790.pdf\"\n  },\n  \"form_download\": {\n    \"href\": \"https://api.shipengine.com/v1/downloads/1/xKVZeKA650-bvQB_oriYkQ/form-1013790.pdf\"\n  },\n  \"status\": \"open\"\n}\n","lang":"json"},"children":[]}]},"headings":[{"value":"Get Batch By ID","id":"get-batch-by-id","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"Example Request & Response","id":"example-request--response","depth":2}],"frontmatter":{"seo":{"title":"Get Batch By ID"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/reference/get-batch-by-id","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}