v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

catalog

Create a catalog allowance

Creates a new catalog allowance for a catalog entry.

post/catalog/allowances

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 allowance belongs to

catalog_entry_idinteger required

The ID of the catalog entry this allowance applies to

allowance_type'allowance' | 'discount' | 'rebate'

Type of allowance (default: 'allowance')

amountnumber double

Allowance amount for the pack size (default: 0). Mutually exclusive with percent_allowance.

unit_allowancenumber double

Allowance amount per individual unit (default: 0)

percent_allowancenumber double

Percentage-based allowance (0-999.99). Mutually exclusive with amount and unit_allowance.

target'company' | 'location_group' | 'location'

Allowance target: company (default), location_group, or location

ottimate_location_idinteger

Location ID (required when target is location)

ottimate_group_idinteger

Location group ID (required when target is 15/location_group)

start_datestring date-time required

Allowance effective start date (ISO 8601)

end_datestring date-time

Allowance effective end date (ISO 8601, optional)

reference_idstring

Unique reference ID for upsert operations

Response

Catalog allowance created successfully

idstring required

Unique identifier

catalog_entry_idstring required

Associated catalog entry ID (prefixed with cte_)

ottimate_company_idinteger required

Company ID

ottimate_location_idinteger

Location ID

allowance_type'allowance' | 'discount' | 'rebate' required

Type of allowance

amountstring

Allowance amount (decimal string)

unit_allowancestring

Unit allowance amount (decimal string)

percent_allowancestring nullable

Percentage-based allowance (decimal string). Non-null when allowance is percent-mode.

targetinteger required

Target code (10=company, 15=location_group, 20=location)

target_type'company' | 'location_group' | 'location'

Human-readable target type

start_datestring date-time required

Start date

start_date_utcstring date-time nullable

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

end_datestring date-time

End date

end_date_utcstring date-time nullable

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

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".