Get allowed item substitutions.

Summary

This API endpoint allows the partners to search for the allowed item substitutions for a given order item.

Usage scenario

Site would like to know which items should be used for substitutions.

Business constraints

  • Order has to be in the PLACED status.
Path Params
string
required

Related order id in format {market}:{order_uuid}.

uuid
required

Related order item id in format {order_item_uuid}.

Query Params
string

Search word describing the desired item(s) to be used as a substitute. If not provided, item specific recommendations will be returned. For optimal results do not use needles longer than 10 characters. Multi-word needles must use %20 as a separator

integer
required
≥ 0

Number of substitutions to return

integer
required
≥ 0

Quantity to substitute

Responses

Language
Credentials
OAuth2
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json