Skip to main content

Search Inventory

POST 
/inventory/search

This endpoint allows searching for product inventory cumulative quantities, separated by inventory type.

Available search fields​

NameDescriptionRequired
productIds (array [integer])Array of product ids.yes
warehouseId (integer)Warehouse id.no
location (string)Location.no

Mandatory field in search payload is productIds array. If warehouseId or location are not sent in the payload, inventories will not be filtered by warehouse and/or location.

Request​

Query Parameters

    expands string

    Expands cumulative inventory data with detailed records

    offset string

    Number of records per page. Default value is 12

    page string

    Page number. Default value is 1

Body

    location string
    productIds undefined[]

Responses​

Search Inventory - 200 / Search Inventory - 200 (expands inventoryBalance)

Response Headers

  • Connection

    string

  • Content-Length

    string

  • Date

    string

  • Keep-Alive

    string

  • Return-Format

    string

Schema

    data

    object[]

  • Array [

    • localQuantity number
    localReservedQuantity number
    nextDeliveryDate string
    productId number
    supplierQuantity number
    supplierReservedQuantity number
    totalQuantity number
    totalReservedQuantity number

  • ]

    • end number
    itemsFound number
    messages string[]
    offset number
    page number
    pages number
    start number
    total number
Loading...