Create a monthly order limit for a product

Creates a monthly order limit for the selected product.

When specifying the organisation, the limit will be applied to the organisation only. Organisation-specific limits will always be preferred over global limits.

It is possible to set max_quantity to null for organisation-specific limits, so that the selected organisation is able to order an unlimited amount regardless of the global limit configured.

Creates a monthly order limit for the selected product. When specifying the `organisation`, the limit will be applied to the organisation only. Organisation-specific limits will always be preferred over global limits. It is possible to set `max_quantity` to null for organisation-specific limits, so that the selected organisation is able to order an unlimited amount regardless of the global limit configured.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Path parameters

product_iddoubleRequired

Numerical ID of a product

Request

This endpoint expects an object.

max_quantitydoubleOptional

threshold_percentagedoubleOptional

Percentage of the monthly limit after which an event should be triggered

organisationobjectOptional

Override the global limit for a specific organisation

Response

Created

iddouble or null

max_quantitydouble or null

threshold_percentagedouble or null