{"templateId":"markdown","versions":[{"version":"shipstation-v2","label":"ShipStation V2 API","link":"/apis/shipstation-v2/docs/reference/add-to-batch","default":true,"active":false,"folderId":"58c9a61d"},{"version":"shipengine","label":"ShipStation API (formerly ShipEngine)","link":"/apis/shipengine/docs/reference/add-to-batch","default":false,"active":true,"folderId":"58c9a61d"},{"version":"shipstation-v1","label":"ShipStation V1 API","link":"/apis/shipstation-v1/docs/reference/add-to-batch","default":false,"active":false,"folderId":"58c9a61d"}],"sharedDataIds":{"sidebar":"sidebar-apis/@shipengine/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Add to Batch","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":"add-to-batch","__idx":0},"children":["Add to Batch"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Once you've ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/create-batch"},"children":["created a batch"]},", you can continue to add ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_ids"]}," and/or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rate_ids"]}," to it until you are ready to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/process-batch"},"children":["process the batch"]},"."]},{"$$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":"p","attributes":{},"children":["To use batches successfully, you should also understand how to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/create-a-shipment"},"children":["create a shipment"]},", how to ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/rates/get-shipment-rates"},"children":["get shipping rates"]},", and the basics around ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/list-carriers"},"children":["carrier services"]},"."]},{"$$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"]}," you wish to add shipments to."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_ids"]}," and/or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rate_ids"]}," you wish to add to the batch."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All shipments in a batch, whether added with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shipment_id"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["rate_id"]}," must have a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["carrier_id"]}," and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["service_code"]},". If the shipments included in the batch do not explicitly specify their carrier and service, you'll recieve an error."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The shipments you add to a batch must use a ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/reference/create-warehouse"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]}]}," instead of a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ship_from"]}," address."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All shipments in a batch must be ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/apis/shipengine/docs/shipping/ship-from-a-warehouse"},"children":["shipped from the same warehouse"]},". This means all shipments in a batch ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["must"]}," be assigned the same ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["warehouse_id"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"example-request","__idx":2},"children":["Example Request"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["POST /v1/batches/:batch_id/add"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"http","header":{"controls":{"copy":{}}},"source":"POST /v1/batches/se-1010644/add HTTP/1.1\nHost: api.shipengine.com\nAPI-Key: __YOUR_API_KEY_HERE__\nContent-Type: application/json\n\n{\n  \"shipment_ids\": [\n    \"se-2102769\"\n  ],\n  \"rate_ids\": []\n}\n","lang":"http"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If successful, ShipStation API will respond with ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["HTTP Status 204, No Content"]},"."]}]},"headings":[{"value":"Add to Batch","id":"add-to-batch","depth":1},{"value":"Requirements","id":"requirements","depth":2},{"value":"Example Request","id":"example-request","depth":2}],"frontmatter":{"seo":{"title":"Add to Batch"}},"lastModified":"2026-04-08T10:47:45.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/shipengine/docs/reference/add-to-batch","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}