Endpoint: Item Search V2 (Replacements)

get

https://example.com/{Your Item Search URL}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

Your Item Search URL

string

required

Query Params

store_reference

string

Store in which the picker is performing the search

job_reference

string

ID of the job to which the searched item belongs.

ean

string

EAN to search as scanned or typed by the picker. (Don't use in case of using TERM)

term

string

Term to search as typed by the picker. (Don't use in case of using EAN)

sku

string

Product unique identifier

limit

number

Limit the result set to the specified number of items. Default: 50.

currency

string

Currency code as defined in the ISO - 4217 standard. Same as the one used when requesting availability.

include_special_price

boolean

If payment_method of the job is LOYALTY_CARD, this parameter is going to be sent as true. Use it to set special prices to the items returned.

page

number

If the possibilities to match the search are bigger than the limit, allows the app to search for more results.

order

string

Allows to order the results by creation date. Possible values: PRICE_ASC, PRICE_DESC, NAME_ASC, NAME_DESC, BEST_MATCH. Default BEST_MATCH.

departments

array of strings

Departments where the item replacement will be searched (Not available to all customers)

departments

price

number

Price of the item being searched. If we don't receive the price, we send 0 instead

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Response

404Not found