Get Custom Batch

Required permission: read_custom_batches

Returns a single custom batch with its orders and the inventory picked for it.

picks is the inventory taken for the batch when its labels were generated, one entry per inventory location (product, location and lot). It is empty until labels are generated.

Custom batches belong to the organization's warehouses, so this endpoint is only available to organization API keys.

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

The ID of the custom 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