Endpoint: Item Search V2 (Replacements)

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Page number

The replacements page could be starting in number 1.
"page" : 1

InstaLeap Picker App requires a way to query products on your catalog/inventory in order to provide substitutions when an item can't be found in the picking center. There are two cases that should be covered by this endpoint:

  1. A picker found a similar item to the original, and they scan the barcode (or manually enter the number) to add it to the item list. In this case, the endpoint should be capable of performing a search with that SKU.
  2. A picker wants to search for alternatives to the current product. In this case, the endpoint should have the ability to show similar items to the term searched.

Example payload that the client needs to respond

{
  "search_results": [
    {
      "id": "string",
      "name": "string",
      "photo_url": "string",
      "unit": "string",
      "sub_unit": "string",
      "quantity": 1,
      "sub_quantity": 1,
      "price": 1.5,
      "weight": 1.0,
      "volume": 1.0,
      "available_lots": [
        "string"
      ],
      "comment": "string",
      "attributes": {
        "category": "value",
        "location": "string"
      },
      "barcodes": [
        "000000000000",
        "000000000000"
      ],
      "quantity_found_limits": {
        "max": 1,
        "min": 0
      },
      "price_details": {},
      "claim_information": {
        "max_time_to_claim_in_hours": 1,
        "available_claim_actions": [
          "REFUND",
          "SUBSTITUTE",
          "COLLECT_AND_REFUND",
          "COLLECT_AND_SUBSTITUTE",
          "REJECT",
          "REJECTION_NOT_ALLOWED"
        ]
      }
    }
  ],
  "page": 1,
  "next": 1
}

Authentication:

For integration simplicity, we suggest using a bearer token to authenticate InstaLeap in your systems.

Path Params
string
required
Query Params
string

Store in which the picker is performing the search

string

ID of the job to which the searched item belongs.

string

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

string

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

string

Product unique identifier

number

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

string

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

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.

number

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

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
number

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

Responses

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