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 all account allocation templates.
This endpoint will return a paginated list of the allocation templates linked to an account. This list contains the id and name of the template as well as the information of when and by whom it was last updated. You can define the page size of this paginated list. If the list result returned are greater than the `page_size`, the `start_after` and `end_before` can be used to fetch the remaining templates.
Deletes an individual account template for an account
Deletes an individual account template for an account
Get the account's default allocation template if there is one.
Get the account's default allocation template if there is one.
Creates an account template.
This endpoint will create an account template by providing the template name, the account for which it will be created for and the allocation specification - which suppliers are blocked, how the allocated suppliers are distributed into groups, and what their minimum and maximum percentages are.
Updates an allocation account template.
This endpoint will update an allocations account template identified by an account id and a template id. This update will use the provided allocation specification which contains blocked suppliers, how the allocated suppliers are distributed into groups, and what their minimum and maximum percentages are.
Gets the system allocation template
This endpoint will return the system allocation default template based on the locale. The system default template has all of the available suppliers who are available in the locale. This data is dynamic as suppliers enter or exit particular markets. You can use this to ensure that your other allocations calls always use suppliers who are valid for the locale where you are creating a Target Group.
Fetch an allocation account template
This endpoint will return an account allocation specification template based on a template id. The response will only include the open exchange suppliers. Support for private exchange suppliers in template administration is not supported yet.
Lists all global allocation templates.
This endpoint will return a paginated list of the global allocation templates. This list contains the id and name of the template as well as the information of when and by whom it was last updated. You can define the page size of this paginated list. If the list result returned are greater than the `page_size`, the `start_after` and `end_before` can be used to fetch the remaining templates.
Fetch a global allocation template.
This endpoint will return a global allocation specification template based on a template id. The response will only include the open exchange suppliers. Support for private exchange suppliers in template administration is not supported yet.
Sets the account's default allocation template.
This endpoint will set the default template used for an account. It uses the `If-Match` header for optimistic locking, which can be fetched from the [account's default allocation template endpoint](./get-account-allocation-template-association)