Skip to main content

Get Product Inventory

GET 
/products/:lookupkey/:key/inventory

This endpoint gives cumulative product inventory data by searching on a lookup key.

Request​

Path Parameters

    lookupkey stringrequired

    Available lookup keys: id, sourceId, sku, supplierCode

    key stringrequired

    Lookup key value

Query Parameters

    expands string

    Expands cumulative inventory data with detailed records

Responses​

Get Product Inventory by Id - 200 / Get Product Inventory by Id - expands - 200 / Get Product Inventory by Id - 200 (reserved stock) / Get Product Inventory by Id - expands - 200 (reserved stock)

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

  • ]

    • messages undefined[]
    total number
Loading...