List catalog variance batches
Returns Catalog Variance Manager batches for the given company. Omit export_status to return both draft and exported batches; pass export_status=draft or export_status=exported to narrow to one state. The costbatch_payload in each result matches the Pyxis /costbatch format exactly, for both draft and exported batches.
Sort order: draft batches are ordered by costbatch_payload.start_datetime (newest first) — this is the same start_date value used internally, exposed on the response only inside costbatch_payload. Exported batches are ordered by exported_at (newest first). When export_status is omitted, results are ordered by exported_at for exported batches and costbatch_payload.start_datetime for draft batches, newest first, and draft batches are always included regardless of any exported_after*/exported_before* filter — those only ever narrow exported batches. In every case, id is used as a secondary sort key, so ordering is fully deterministic — identical requests return tied batches in the same order, and paginating through a stable result set returns each batch exactly once.
Query parameters
Company ID to filter by (required)
Filter by exact batch number
Filter by batch export state. Values are case-sensitive (must be exactly 'draft' or 'exported'; e.g. 'DRAFT' is rejected with a 400). Omit to return both draft and exported batches. When 'draft', exported_after*/exported_before* are ignored. When omitted (mixed results), draft batches are always included regardless of exported_after*/exported_before* — those parameters only ever narrow exported batches, since drafts have no exported_at to filter on. Known limitation: an empty or whitespace-only value (export_status= or export_status=%20) is currently treated the same as omitting the parameter (returns both draft and exported batches) rather than being rejected. Do not rely on an empty value being rejected; send a non-empty invalid value if you need to test error handling, or omit the parameter entirely if you intend no filter.
Return batches exported on or after this datetime (ISO 8601). Has no effect when export_status=draft.
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.
Return batches exported on or before this datetime (ISO 8601). Has no effect when export_status=draft.
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.
Page number for pagination
Number of items per page
Headers
OAuth2 authentication flows. Auth server URLs will vary by environment
API key for authentication
API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.
Response
Successful response with paginated batch list