Sign in
catalog

Retrieve a catalog variance batch

Returns a single draft or exported Catalog Variance Manager batch by its ctb_xxx ID.

get/catalog/variance-batches/{id}

Path parameters

idstring required

The catalog variance batch ID (ctb_xxx)

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Successful response with the batch

idstring required

Unique batch identifier (prefixed with ctb_)

ottimate_company_idinteger required

Company ID this batch belongs to

batch_numberinteger required

Sequential batch number within the company

export_status'draft' | 'exported' required

'draft' when exported_at is null, 'exported' once exported_at is set

exported_atstring date-time nullable

Timestamp when the batch was exported. Null for draft batches.

exported_at_utcstring date-time nullable

UTC equivalent of exported_at. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z". Null for draft batches.

Changes