v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

catalog

Create a catalog price

Creates a new catalog price for a catalog entry.

post/catalog/prices

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.

Idempotency-Keystring

Client-generated unique key (UUID/ULID recommended). JSON requests: the first 2xx response is cached for 24h and replayed on a same-key retry with a matching body; a different body returns 422. Non-JSON requests (e.g. file uploads): the key is single-use — any same-key retry returns 422 regardless of body. See Idempotency for full details.

Request body

ottimate_company_idinteger required

The Ottimate company ID this price belongs to

catalog_entry_idstring required

The ID of the catalog entry this price applies to

pricenumber double required

Price amount for the pack size

unit_pricenumber double

Price amount per individual unit (optional)

price_type'company' | 'location_group' | 'location'

Price type: company (default), location_group, or location

ottimate_location_idinteger

Location ID (required when price_type is 'location')

ottimate_group_idinteger

Location group ID (required when price_type is 'location_group')

start_datestring date-time required

Price effective start date (ISO 8601)

end_datestring date-time

Price effective end date (ISO 8601, optional)

reference_idstring

External reference ID for the price

Response

Price created successfully

idstring required

Price ID

catalog_entry_idstring

Catalog entry ID

ottimate_company_idinteger

Company ID

pricestring required

Price amount (decimal string)

unit_pricestring

Unit price (decimal string)

price_typeinteger required

Price type

price_type_display'company' | 'location_group' | 'location'

Human-readable price type

ottimate_location_idinteger

Location ID

ottimate_group_idinteger

Location group ID

start_datestring date-time required

Price start date

end_datestring date-time

Price end date

reference_idstring

Unique key

created_datestring date-time

Record creation date

created_date_utcstring date-time nullable

UTC equivalent of created_date. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".

last_modified_datestring date-time

Record last modified date

last_modified_date_utcstring date-time nullable

UTC equivalent of last_modified_date. ISO 8601 with Z suffix, e.g. "2025-05-20T15:17:35.652584Z".