Commerce API (v0)

Search for availability and price for a set of bookable products based on a search specification. Consumption of bookable products will start at some time and continue for a duration. The search specification allows for specifying a time interval for when consumption can start. The duration is of consumption is always specified as a fixed value in the search specification.

Returns a quotation containing information about availability and price for products satisfying the search specification. The returned quotation is valid for a limited period if time, and the response contains the expiration time for the quotation. When the expiration time has passed the client should redo the availability search to ensure that always valid information can be presented to the user.

The response can optionally be paginated through the page and maxresults parameters. The default value for page returns the first result page. The default value for maxresults returns all results. page can be set to the value returned in the nextpage property of the response to retrieve the next page of results. There is no guarantee that maxpage results will be returned even if a sufficient number of items are remaining. The nextpage property is not present in the response for the last result page.

This method supports grouping of products. Groping is enabled by specifying at least one attribute name in the GroupProducts field. All products with identical product category and identical values for all of these attributes will be grouped together. In the response the grouped products will be represented by a single product and one availability map entry per requested price and start date for consumption. The product returned will only contain the category identifier and the values of the grouping attributes. Grouping is not supported if pagination is used.

Gets discount assignments filtered by productId and/or discountId. If no filters are provided, returns all assignments with pagination.

The shape of the response depends on which filters are supplied:

• productId and discountId both set: returns a single assignment, or 404 if no such assignment exists.
• productId only: returns an array of assignments for that product, or 404 if none exist.
• supplierId only: returns an array of assignments for that supplier, or 404 if none exist.
• discountId only: returns an array of assignments for that discount (200 with an empty array if none exist).
• No filters: returns a paged envelope (pageNumber/pageSize). Note that totalCount in this envelope reflects the number of items on the current page, not the total row count across all pages.

Authentication: No access token is required for this endpoint.

Gets all discount assignments with cursor-based pagination, ordered by updated date descending (ties broken by identifier).

page is an opaque cursor token; pass the nextPage value returned by a previous response to retrieve the next page. nextPage is only present in the response when the returned page is full (i.e. contains maxresults items), and is absent on the last page.

Authentication: No access token is required for this endpoint.

Returns a single product category related to the supplied id.

Get all products, optionally filtered by a product category.

Results can optionally be paginated by specifying the page and maxresults parameters. The default valye for page returns the first result page. The default value for maxresults returns all results. page can be set to the value of the nextpage property fro a response to return the next page of results.

There is no guarantee that maxresults results will be returned even if more results are available, but at least one result will always be returned. The nextpage property is not defined for the last result page.

Retrieve a shopping cart based on its identifier.

Remove all products in the cart but retains the empty cart.

Create a new empty shopping cart. The shopping cart has an ID that can be used in subsequent calls to the shopping cart APIs to manipulate or inspect the shopping cart. The shopping cart is valid for 6 hours after creation.

Checking out the shopping cart places orders for all products in the cart.

Cancel the shopping cart and any order that has been placed in the corresponding fulfillment system.

Register information about a payment transaction on the cart. Multiple payment transactions can be registered. A payment transaction is uniquely identified by the combination of the fields cardType and reference. The paymentStatus can be updated from Pending to Paid by calling this method again with the same cardType, reference and amount.

No information is sent to fulfillment systems for pending payments. Information about paid payments is sent to the fulfillment system to the extent this is supported by the relevant fulfillment system.

Deletes a shopping cart item in the selected cart.

Adds a product to the cart. The product is identified by an availability price map identifier obtained from a call to availability and price search. See the Availabilities API.

Checks whether a promo code can be used on the given cart (exists, active, within its validity window, redemption limits not exceeded, and applicable to at least one product in the cart) without applying it or changing any pricing.

Clears any promo code applied to the cart: restores original pre-discount pricing on affected products and cancels the associated redemption. No-op if the cart has no applied promo code.