Skip to main content
GET
/
v1
/
inventory
/
search
Search inventory items
curl --request GET \
  --url https://api.footwayplus.com/v1/inventory/search \
  --header 'X-API-KEY: <api-key>'
{
  "items": [
    {
      "merchantId": "<string>",
      "variantId": "<string>",
      "productName": "<string>",
      "supplierModelNumber": "<string>",
      "ean": [
        "<string>"
      ],
      "size": "<string>",
      "price": "<string>",
      "product_description": "<string>",
      "vendor": "<string>",
      "quantity": 123,
      "productType": [
        "<string>"
      ],
      "productGroup": [
        "<string>"
      ],
      "department": [
        "<string>"
      ],
      "image_url": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ],
  "totalItems": 123,
  "currentPage": 123,
  "totalPages": 123
}

Authorizations

X-API-KEY
string
header
required

Query Parameters

merchantId
any

Filter by merchant ID (can specify multiple)

productName
any

Search by product name (uses trigram similarity)

vendor
any

Filter by vendor (can specify multiple)

department
any

Filter by department (can specify multiple)

productGroup
any

Filter by product group (can specify multiple)

productType
any

Filter by product type (can specify multiple)

page
any

Page number (1-based)

pageSize
any

Number of items per page

Response

Successful response

items
object[]
totalItems
integer
currentPage
integer
totalPages
integer