GET Inventory Current Stock in Certain Warehouse

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

Query Parameter

Field	Data Type	Description	Mandatory Flag
page	Integer	Page Number	Optional
limit	Integer	Number of Items retrieved per Page	Optional
warehouse_code	String(45)	Warehouse Code example: WH-TGR04 (depend on merchant)	Mandatory
sku	String	SKU Code example: 11287691 (depend on merchant)	Optional
skus	String	SKU Code to support using multiple. Current request skus is limited to 20 Max SKU Per Request	Optional
stock_type	String	must one of OMS or WMS or OMSWMS Stock data source must be filled with either of these values, suggest using OMSWMS: OMS (will get stock from OMS ONLY) WMS (will get stock from WMS ONLY) OMSWMS (will get stock from either OMS or WMS depending on which one has a smaller available quantity)	Mandatory

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

Field	Data Type	Description	Note
warehouse_id	String(45)	Warehouse Code	Available
sku	String(45)	SKU Code	Available
qty	Decimal(18,8)	OMS or OMSWMS = available_qty + reserved_qty WMS = available_qty + reserved_qty + hold_qty + qty occupied by the orders created but have not been allocated in the warehouse	Available
gross_weight	Decimal(18,8)	Gross Weight	stock_type: OMS will return null stock_type: WMS return decimal
net_weight	Decimal(18, 8)	Net Weight	Return Null
cubic	Decimal(18,8)	Volume	stock_type: OMS will return null stock_type: WMS return decimal
mfg_date	yyyy-MM-dd HH:mm:ss	Manufacturing Date	Return Empty String
exp_date	yyyy-MM-dd HH:mm:ss	Expiry Date	Return Empty String
batch_no	String	Batch No	Return Empty String
serial_no	String	Serial No	Return Empty String
receipt_date	yyyy-MM-dd HH:mm:ss	Receipt Date	Return Empty String
product_condition	String	Physical Goods Condition	Not Available, Return Empty String
available_qty	Decimal(18, 8)	OMS or OMSWMS = available_qty with GOOD condition ONLY WMS = available_qty with GOOD condition + available_qty with DAMAGED condition	Available
reserved_qty	Decimal(18, 8)	OMS or OMSWMS the qty will be reserved once the order is created successfully in the Shipper system. WMS the qty will be reserved only when the qty is allocated to a specific worker.	Available
hold_qty	Decimal(18, 8)	hold_qty means the stock is already held and cannot be outbound to the buyer.	Available
notes	String	Remarks	Return Empty String

Sample Query Parameter

Header	How to Fill
x-api-key	Shipper API Key

warehouse_code="WH-BAL"
sku="SKUTEST1"
skus="SKUTEST2"
skus="SKUTEST3"
stock_type="WMS"
page=1
limit=1

Sample Body Response

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

{
    "metadata": {
        "path": "/v3/fulfillment/inventory/stock?skus=23373646&warehouse_code=WH-BAL&stock_type=WMS&page=1&limit=10",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1651030299
    },
    "data": {
        "inventories": [
            {
                "warehouse_id": "WH-BAL",
                "sku": "23373646",
                "qty": 60,
                "gross_weight": 60,
                "net_weight": null,
                "cubic": 0,
                "mfg_date": "",
                "exp_date": "",
                "batch_no": "",
                "serial_no": "",
                "receipt_date": "",
                "product_condition": "",
                "available_qty": 56,
                "reserved_qty": 4,
                "hold_qty": 0,
                "notes": null,
                "details": [
                    {
                        "condition": "GOOD",
                        "qty": 56
                    },
                    {
                        "condition": "DAMAGED",
                        "qty": 0
                    }
                ]
            }
        ]
    },
    "pagination": {
        "current_page": 1,
        "current_elements": 1,
        "total_pages": 1,
        "total_elements": 1
    }
}

{
    "metadata": {
        "path": "/v3/fulfillment/inventory/stock?page=1&limit=10&stock_type=OMS&sku=ZHANGSKU1238&warehouse_code=WH-TGR04",
        "http_status_code": 200,
        "http_status": "OK",
        "timestamp": 1697709719
    },
    "data": {
        "inventories": [
            {
                "warehouse_id": "WH-TGR04",
                "sku": "ZHANGSKU1238",
                "qty": 99998,
                "gross_weight": null,
                "net_weight": null,
                "cubic": null,
                "mfg_date": "",
                "exp_date": "",
                "batch_no": "",
                "serial_no": "",
                "receipt_date": "",
                "product_condition": "",
                "available_qty": 99500,
                "reserved_qty": 498,
                "hold_qty": 100,
                "notes": null,
                "details": null
            }
        ]
    },
    "pagination": {
        "current_page": 1,
        "current_elements": 1,
        "total_pages": 1,
        "total_elements": 1
    }
}

{
  "metadata": {
    "path": "/v1/fulfillment/inventory/stock?page=1&limit=10&warehouse_code=WH-TGR04&stock_type=AMS",
    "http_status_code": 400,
    "http_status": "Bad Request",
    "errors": [
      {
        "code": 810,
        "message": "StockType harus berupa salah satu dari [WMS OMS]"
      }
    ],
    "timestamp": 1637655198
  }
}

{
    "metadata": {
        "path": "/v3/fulfillment/inventory/stock?skus=23373646&warehouse_code=WH-BAL&page=1&limit=10&stock_type=OMS",
        "http_status_code": 401,
        "http_status": "Unauthorized",
        "errors": [
            {
                "code": 10001,
                "message": "Unauthorized Access. You are not authorized to access this resource."
            }
        ],
        "timestamp": 1651031850
    }
}

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