Get Batch

Required permission: read_batches

Returns a single batch with its label documents, the items in each order, and every order in the batch with the shipments bought for it through the batch. Only organization API keys can get batches.

Every order in a batch has the same items, so items_per_order lists them once with the quantity each order ships.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
≥ 1

The ID of the batch to retrieve.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json