10 January 2018
Enhancement
Customization

With API Extensions, you can extend the behavior of the cart API with your business logic. An API Extension gets called after the processing of a create or update request of an API call, but before the result is persisted. The API Extension can validate the object, or apply additional updates to it.
Good use cases for API Extensions are: Validating the content of a cart (for example no more than 8 crates of beverages can be ordered at once), calculating custom shipping costs, or adding mandatory items, like insurance, to a cart.

The first part of the new documentation explains how to setup an extension, while the second part describes the input and the possible responses of the extension. The third part details the limits and error cases related to extensions.

  • [API] New API Extensions endpoint with functionality to create, update, and delete extensions.
  • [API] New error codes: ExtensionBadResponse, ExtensionUpdateActionsFailed and ExtensionNoResponse.
  • [API] New Scope manage_extensions granting access to API Extensions endpoint.