Batches and master data

Read batches, categories, brand names, and reference values used to populate filters or application menus.

Access labels such as Origin + Brand key + Customer are defined in Headers and access. Each endpoint ends in a Try it console; set the host and keys once in its Settings tab or on the overview.

Get all batches

Method	URL path	Required access
GET	/api/v1/brand/batches	Origin + Brand key

Request fields:

Field	Type	Required	Rules / meaning
query.limit	number	optional	—
query.offset	number	optional	—
query.search	string	optional	Also accepts ("")

Pagination is added only when limit and offset are both truthy.

Example:

curl -X GET "$BASE_URL/api/v1/brand/batches?limit=10&offset=0" \
  -H "Origin: $ORIGIN" \
  -H "api-key: $API_KEY"

Response: JSON with success: true and result containing the operation’s service data. Result fields/details: count, data.

Source: app/v1/controller/batch_controller.ts:8 → get_all_batches; routes: routes/v1/batch_route.ts:9; service: _get_all_batches (app/v1/service/batch_service.ts:6).

Related pages

• Batch Commerce API overview
• Product batches
• Implementation notes