GET Available Inventory from All Warehouse in OMS

Shipper API gives interface access to our clients for retrieving the latest Stock Information from Shipper Warehouse Management System

Specification

Method	Endpoint
GET	/v3/fulfillment/inventory/stock/warehouse

Query Parameter

Field	Data Type	Description	Mandatory Flag
page	Integer	Page Number	Optional
limit	Integer	Number of Items retrieved per Page	Optional
sku	String	support only single SKU Code example: 11287691 (depend on merchant)	Optional
skus	String	support multiple SKU Code example: 11287691 (depend on merchant)	Optional

Body Response
Notes: "Not Available" note means shipper will return a null value for each unavailable field

Field	Data Type	Description	Note
sku	String(45)	SKU Code	Available
stock	Integer	Total stock from all warehouse	Available
warehouse_id	String(45)	Warehouse Code example: WH-TGR04 (depend on merchant)	Available
stock	Integer	stock in warehouse	Available

Sample Query Parameter

Header	How to Fill
X-Api-Key	Shipper Api Key

page=1
limit=10
sku="11287691"
skus="17168504"
skus="11287708"

Sample Body Response

Header	How to fill
x-request-id	Request ID generated from Shipper for tracking purposes

{
    "metadata": {
        "path": "/v3/fulfillment/inventory/stock/warehouse?skus=0309202101&skus=03092021102&page=1&limit=2",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1651034507
    },
    "data": [
        {
            "sku": "0309202101",
            "stock": 99,
            "details": [
                {
                    "warehouse_id": "WH-BAL",
                    "stock": 94
                },
                {
                    "warehouse_id": "WH-TGR04",
                    "stock": 5
                }
            ]
        },
        {
            "sku": "03092021102",
            "stock": 10,
            "details": [
                {
                    "warehouse_id": "WH-BAL",
                    "stock": 0
                },
                {
                    "warehouse_id": "WH-TGR04",
                    "stock": 10
                }
            ]
        }
    ],
    "pagination": {
        "current_page": 1,
        "current_elements": 2,
        "total_pages": 1,
        "total_elements": 2
    }
}

{
  "metadata": {
    "path": "/v3/fulfillment/inventory/stock/warehouse?limit=10&page=123abc&sku=11287691&skus=17168504&skus=11287708",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 10005,
        "message": "Invalid Input. Please Validate Your Input."
      }
    ],
    "timestamp": 1647578325
  }
}

{
    "metadata": {
        "path": "/v3/fulfillment/inventory/stock/warehouse?skus=0309202101&skus=03092021102&page=1&limit=2",
        "http_status_code": 401,
        "http_status": "Unauthorized",
        "errors": [
            {
                "code": 10001,
                "message": "Unauthorized Access. You are not authorized to access this resource."
            }
        ],
        "timestamp": 1651034618
    }
}

{
  "metadata": {
    "path": "/v1/fulfillment/inventory/stock/warehouse?page=1&limit=10&sku=123",
    "http_status_code": 404,
    "http_status": "Not Found",
    "errors": [
      {
        "code": 801,
        "message": "Record Does Not Exist. Please Validate Your Input Or Contact Administrator."
      }
    ],
    "timestamp": 1637655298
  }
}

{
  "metadata": {
    "path": "/v1/fulfillment/inventory/stock/warehouse?page=1&limit=10&sku=123",
    "http_status_code": 500,
    "http_status": "Internal Server Error",
    "errors": [
      {
        "code": 803,
        "message": "Internal Server Error. Please Call Administrator."
      }
    ],
    "timestamp": 1637213866
  }
}