Allocation Templates Admin

Create, update, delete, and list allocation templates. Templates allow you to store and automate your policy toward suppliers on the Exchange.

📄️Lists allocation templates for an account

Lists a paginated set of allocation templates for an account. The response includes each template's ID, name, and last update details. Use the `page_size` parameter to control the number of results per page, and use the `start_after` and `end_before` parameters to navigate between pages.

📄️Delete an allocation template

Delete an allocation template

📄️Retrieves the default allocation template for an account

Retrieves the default allocation template for an account

📄️Create an allocation template

Creates a new allocation template for an account. You'll need to provide a template name and the allocation specifications, which define supplier blocks, distribution groups, and their respective percentages.

📄️Update an allocation template

Updates the name and allocation specifications for a template. This endpoint uses the If-Match header for optimistic locking. To get the required ETag value, first make a GET request for this resource.

📄️Inactivate a country allocation template

Inactivates a country-level allocation template identified by account, business unit, country, and template ID.

📄️Retrieves the system allocation template

Retrieves the system's default allocation template for a specific locale. This template contains a dynamic list of all suppliers currently available in that market. You can use this data as a baseline to ensure your custom allocation templates only include suppliers that are valid for a specific country or region.

📄️Retrieve an allocation template by ID

Retrieves the details of a specific allocation template by its ID.

📄️Bulk create country allocation templates

Creates country-level allocation templates for multiple countries at once for the given account and business unit. Returns the created templates and any country codes for which creation failed. Set `is_default` to `true` to make each created template the default for its business unit and country, replacing any previous default there.

📄️Lists global allocation templates

Lists a paginated set of global allocation templates. The response includes each template's ID, name, and last update details. Use the `page_size` parameter to control the number of results per page, and use the `start_after` and `end_before` parameters to navigate between pages.

📄️Update a country allocation template

Updates a country-level allocation template identified by account, business unit, country, and template ID. Set `is_default` to `true` to make this template the default for its business unit and country, replacing any previous default. Setting it to `false` on the template that is currently the default clears the default without promoting another template, leaving the business unit and country with no default country allocation template.

📄️Retrieve a country allocation template for a locale by ID

Retrieves a country-level allocation template for the given locale, identified by account, business unit, country, template ID, and locale.

📄️Retrieve the default country allocation template for the given business unit ID and country combination, if one exists

Returns the template ID of the default country allocation template if one exists for the given account, business unit, and country combination. The value is `null` if no such association exists.

📄️Retrieve a country allocation template by ID

Retrieves a country-level allocation template identified by account, business unit, country, and template ID.

📄️Retrieve a global allocation template by ID

Retrieves the details of a specific global allocation template by its ID.

📄️Assigns a default allocation template to an account

Assigns a default allocation template to an account. This endpoint uses the If-Match header for optimistic locking. To get the required ETag value, first make a request to the [GET endpoint](./get-account-allocation-template-association) for this resource.

📄️Bulk inactivate country allocation templates

Inactivates multiple country-level allocation templates for the given account and business unit. Returns the IDs of the successfully inactivated templates and those that could not be inactivated.

📄️List country allocation templates

Returns a paginated list of country-level allocation templates for the given account. You can filter by name, business unit, country code, or default status, and control pagination using the `page_size`, `start_after`, and `end_before` parameters.

📄️Retrieve the IDs of relevant default allocation templates

A convenience endpoint that returns the applicable default allocation templates of multiple kinds for the given account.

📄️Create a country allocation template

Creates a country-level allocation template for the given account, business unit, and country.