QueryStoreInventory

GET /stores/{store_id}/inventory

Query store-level product inventory

Path parameters

  • store_id string Required

    The store Id in Nomad system

Query parameters

  • page_no integer(int32)

    Page number, starting with 1

    Minimum value is 1. Default value is 1.

  • page_size integer(int32)

    Page size, options: [1, 10, 50, 100, 1000]

    Values are 1, 10, 50, 100, or 1000. Default value is 10.

  • product_id string

    The product Id in the store

  • batch_id string

    The batch Id in the store

  • location_id string

    The product Id of product

  • sku_name string

    The SKU name of product

  • barcode string

    The barcode of product

Responses

  • • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • items array[object]

      Inventory object of store

      Hide items attributes Show items attributes object
      • product_id string Required

        ID of the product in the store's inventory.

      • batch_id string

        ID of the product batch in the store's inventory.

      • location_id string

        ID of the product location in the store's inventory.

      • sku_name string

        SKU name of product in the store's inventory.

      • barcode string

        Barcode of product in the store's inventory.

      • quantity integer(int32) Required

        Quantity of product in the store's inventory.
  • • 400

    Invalid input

  • • 500 application/json

    Failed

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • items array[object]

      Inventory object of store

      Hide items attributes Show items attributes object
      • product_id string Required

        ID of the product in the store's inventory.

      • batch_id string

        ID of the product batch in the store's inventory.

      • location_id string

        ID of the product location in the store's inventory.

      • sku_name string

        SKU name of product in the store's inventory.

      • barcode string

        Barcode of product in the store's inventory.

      • quantity integer(int32) Required

        Quantity of product in the store's inventory.
GET /stores/{store_id}/inventory 
curl \
 -X GET https://nomad.samarkand-global.cn/envoy/stores/{store_id}/inventory \
 -H "x-ca-key: $API_KEY"
Response examples (200) 
{
  "code": 42,
  "message": "string",
  "items": [
    {
      "product_id": "string",
      "batch_id": "string",
      "location_id": "string",
      "sku_name": "string",
      "barcode": "string",
      "quantity": 1
    }
  ]
}
Response examples (500) 
{
  "code": 42,
  "message": "string",
  "items": [
    {
      "product_id": "string",
      "batch_id": "string",
      "location_id": "string",
      "sku_name": "string",
      "barcode": "string",
      "quantity": 1
    }
  ]
}