v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

catalog

List exported catalog variance batches

Returns exported Catalog Variance Manager batches for the given company. Only batches with export_status='exported' are ever returned — drafts and failed batches are excluded. The costbatch_payload in each result matches the Pyxis /costbatch format exactly.

get/catalog/variance-batches

Query parameters

ottimate_company_idinteger required

Company ID to filter by (required)

batch_numberinteger

Filter by exact batch number

exported_afterstring date-time

Return batches exported on or after this datetime (ISO 8601)

exported_after_utcstring date-time

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

exported_beforestring date-time

Return batches exported on or before this datetime (ISO 8601)

exported_before_utcstring date-time

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

pageinteger

Page number for pagination

limitinteger

Number of items per page

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 paginated exported batch list

countinteger

Total number of results

nextstring nullable

URL to next page, or null

previousstring nullable

URL to previous page, or null