1. Introduction

2. Inventory Module API

2.1. Inventory Query API

Query aggregated inventory by SKU list.

2.1.1. SERVICE_TYPE

GLINK_QUERY_INVENTORY_NOTIFY

2.1.2. Request Parameters

Inventory query request

Parameter Type List Required Description
partnerId string N N Partner ID
customerCode string N Y Owner code
warehouseCode string N N Warehouse code
skus string Y Y SKU code list, maximum 200
allStockStatus boolean N N Whether to query all stock statuses; true: query all stock statuses, false or not provided: query using the default stock status scope

2.1.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "skus": [
    "sku_2d8952660609"
  ],
  "allStockStatus": false
}

2.1.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code, is SUCCESS, see error codes on failure (for example INTERNAL_ERROR)
message string N N Message
inventoryVOList object Y N Inventory detail list
└ customerCode string N N Owner code
└ warehouseCode string N N Warehouse code
└ sku string N N SKU code
└ name string N N Item name
└ barcode string N N Barcode
└ total int N N Total inventory
└ available int N N Available quantity
└ allocated int N N Allocated quantity
└ duePutawayQty int N N Pending putaway quantity (received but not put away)
└ quarantined int N N Quarantined quantity
└ holdQty int N N Hold quantity
└ missingQty int N N Missing/difference quantity (mapped from inventory difference qty)
└ stockStatus string N N Stock status; common values GOOD (good), DAMAGE (damaged)

2.1.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "inventoryVOList": [
    {
      "customerCode": "customerCode_dc6c0ddeec80",
      "warehouseCode": "warehouseCode_2f851a4e9e82",
      "sku": "sku_2d8952660609",
      "name": null,
      "barcode": null,
      "total": 100,
      "available": 80,
      "allocated": null,
      "duePutawayQty": 5,
      "quarantined": 0,
      "holdQty": null,
      "missingQty": 0,
      "stockStatus": "GOOD"
    }
  ]
}

2.2. SKU Status Inventory Query API

Query SKU-status-level inventory by owner and warehouse.

2.2.1. SERVICE_TYPE

GLINK_QUERY_INVENTORY_NEW_NOTIFY

2.2.2. Request Parameters

SKU status inventory query request

Parameter Type List Required Description
partnerId string N N Partner ID
customerCode string N Y Owner code
warehouseCode string N Y Warehouse code
stockStatus string N N Item/goods status filter; common values GOOD (good), DAMAGE (damaged)
skus string Y N SKU code list; mutually exclusive with pagination: when a list is provided, maximum 200
page int N N When skus is empty, pageSize must also be provided and both must be non-zero, for paginated query
pageSize int N N Same as above
ignoreZero boolean N N Whether to ignore zero inventory, defaults to false

Validation notes: When skus is not empty, the query uses the SKU list (<=200). If skus is empty, provide both page and pageSize, and both must be non-zero.

2.2.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "stockStatus": "GOOD",
  "skus": [
    "sku_2d8952660609"
  ],
  "page": 1,
  "pageSize": 50,
  "ignoreZero": false
}

2.2.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code
message string N N Message, may contain concatenated errors on failure
inventoryVOList object Y N Detail list
└ customerCode string N N Owner code
└ warehouseCode string N N Warehouse code
└ sku string N N SKU code
└ skuDescription string N N Item name/description
└ barcode string N N Barcode (concatenated when there are multiple values)
└ skuStatus string N N Stock status; common values GOOD (good), DAMAGE (damaged)
└ totalQty double N N Total inventory
└ occupiedQty double N N Allocated quantity (including unallocated orders, etc.)
└ salableQty double N N Salable quantity
└ duePutawayQty double N N Pending putaway quantity
└ unavailableQty double N N Unavailable quantity (including freezes at specific locations, etc.; see the business scope)

2.2.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "inventoryVOList": [
    {
      "customerCode": "customerCode_dc6c0ddeec80",
      "warehouseCode": "warehouseCode_2f851a4e9e82",
      "sku": "sku_2d8952660609",
      "skuDescription": "示例商品",
      "barcode": "6900000000000",
      "skuStatus": "GOOD",
      "totalQty": 100.0,
      "occupiedQty": 20.0,
      "salableQty": 80.0,
      "duePutawayQty": 5.0,
      "unavailableQty": 0.0
    }
  ]
}

2.3. Location Inventory Query API

Query location-level inventory by owner, warehouse, location/SKU, and other conditions with pagination (corresponds to OMS queryLocationStockRemote).

2.3.1. SERVICE_TYPE

GLINK_QUERY_LOCATION_STOCK_NOTIFY

2.3.2. Request Parameters

Location inventory query request

Parameter Type List Required Description
partnerId string N N Partner ID
page int N N Page number, default 1
pageSize int N N Page size, default 100, maximum 200
customerCode string N Y Owner code
warehouseCode string N Y Warehouse code
allStockStatus boolean N N Whether to query inventory across all stock statuses; true: query all stock statuses, false or not provided: query using the default stock status scope
locations string Y N Location code list
locationTypes string Y N Location type list; common values: STORAGE (storage location), PICKING (picking location), RECEIPT (receiving location), STAGING (staging location), PACK (packing location), etc.
zones string Y N Zone list
skus string Y N SKU list
skuCategories string Y N SKU category list
barCodes string Y N Barcode list

2.3.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "allStockStatus": false,
  "locations": ["A010101"],
  "locationTypes": [],
  "zones": [],
  "skus": ["sku_2d8952660609"],
  "skuCategories": [],
  "barCodes": [],
  "page": 1,
  "pageSize": 100
}

2.3.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code
message string N N Message
total long N N Total record count
resultList object Y N Details on the current page
└ warehouseCode string N N Warehouse code
└ customerCode string N N Owner code
└ location string N N Location code
└ zone string N N Zone
└ locationType string N N Location type; common values: STORAGE (storage location), PICKING (picking location), RECEIPT (receiving location), STAGING (staging location), PACK (packing location), etc.
└ sku string N N SKU code
└ skuCategory string N N SKU category
└ description string N N Item description
└ barCode string N N Barcode
└ udf1 string N N User-defined field 1
└ udf2 string N N User-defined field 2
└ udf3 string N N User-defined field 3
└ udf4 string N N User-defined field 4
└ ownerCode string N N WMS Owner code
└ ownerDescription string N N Owner description
└ stockStatus string N N Stock status; common values GOOD (good), DAMAGE (damaged)
└ qty double N N Inventory quantity
└ unit string N N Unit of measure; common values EA (piece), specific values depend on warehouse configuration
└ altQty string N N Converted quantity
└ altUnit string N N Converted unit; specific values depend on warehouse configuration
└ availableQty double N N Available quantity
└ partnerId string N N Partner ID

2.3.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "total": 1,
  "resultList": [
    {
      "warehouseCode": "warehouseCode_2f851a4e9e82",
      "customerCode": "customerCode_dc6c0ddeec80",
      "location": "A010101",
      "zone": "ZONE01",
      "locationType": "PICKING",
      "sku": "sku_2d8952660609",
      "skuCategory": "CAT01",
      "description": "示例商品",
      "barCode": "6900000000000",
      "udf1": null,
      "udf2": null,
      "udf3": null,
      "udf4": null,
      "ownerCode": "OWNER01",
      "ownerDescription": "示例货主",
      "stockStatus": "GOOD",
      "qty": 50.0,
      "unit": "EA",
      "altQty": null,
      "altUnit": null,
      "availableQty": 45.0,
      "partnerId": "partnerId_example"
    }
  ]
}

2.4. Inventory Snapshot Query API

Query warehouse inventory snapshots by business date (corresponds to OMS queryStockSnapRemote, response contains total + resultList).

2.4.1. SERVICE_TYPE

GLINK_QUERY_STOCK_SNAP_NOTIFY

2.4.2. Request Parameters

Inventory snapshot query request

page default 1, pageSize default 100, maximum 200.

Parameter Type List Required Description
partnerId string N N Partner ID
page int N N Page number, default 1
pageSize int N N Page size, default 100, maximum 200
domainCode string N N Domain code; uses the owner-associated domain when not provided
customerCode string N Y Owner code (template owner)
whCode string N Y Warehouse code (matches the OMS field name)
eventDate string N Y Business date, format yyyy-MM-dd
ifPutawayDate boolean N N Whether to include the putaway-date dimension

2.4.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "domainCode": "",
  "whCode": "warehouseCode_2f851a4e9e82",
  "eventDate": "2025-08-21",
  "ifPutawayDate": false,
  "page": 1,
  "pageSize": 100
}

2.4.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code
message string N N Message
total int N N Total record count
resultList object Y N Details on the current page
└ warehouseCode string N N Warehouse code
└ ownerCode string N N Owner code
└ eventDate string N N Business/event date
└ modifyDate string N N Modified time
└ skuList object Y N SKU-level details
  └ skuCode string N N SKU code
  └ skuStatus string N N Stock status; common values GOOD (good), DAMAGE (damaged)
  └ totalQty double N N Total quantity
  └ allocatedQty double N N Allocated quantity
  └ pickedQty double N N Picked quantity
  └ availableQty double N N Available quantity
  └ onholdQty double N N Hold quantity
  └ sourceDoc string N N Source document
  └ arrivalDate string N N Arrival date
  └ snapDate string N N Snapshot date
  └ locationCode string N N Location code
  └ mfgDate string N N Manufacturing date
  └ expDate string N N Expiration date
  └ batchNo string N N Batch number
  └ originCountry string N N Country of origin
  └ deltaQty double N N Quantity delta
  └ deltaOnholdQty double N N Hold quantity delta
  └ putawayDateList object Y N Putaway date list
    └ putawayDate string N N Putaway date
    └ putawayQty double N N Putaway quantity

2.4.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "total": 1,
  "resultList": [
    {
      "warehouseCode": "warehouseCode_2f851a4e9e82",
      "ownerCode": "OWNER01",
      "eventDate": "2025-08-21",
      "modifyDate": "2025-08-21 10:00:00",
      "skuList": [
        {
          "skuCode": "sku_001",
          "skuStatus": "GOOD",
          "totalQty": 10.0,
          "allocatedQty": 2.0,
          "pickedQty": 0.0,
          "availableQty": 8.0,
          "onholdQty": 0.0,
          "sourceDoc": null,
          "arrivalDate": null,
          "snapDate": "2025-08-21",
          "locationCode": "A010101",
          "mfgDate": null,
          "expDate": null,
          "batchNo": null,
          "originCountry": null,
          "deltaQty": null,
          "deltaOnholdQty": null,
          "putawayDateList": []
        }
      ]
    }
  ]
}

2.5. Inventory Log Query API

Query inventory transaction logs with pagination (corresponds to OMS queryStockLogRemote).

2.5.1. SERVICE_TYPE

GLINK_QUERY_STOCK_LOG_NOTIFY

2.5.2. Request Parameters

Inventory log query request

Parameter Type List Required Description
partnerId string N N Partner ID
page int N N Page number, default 1
pageSize int N N Page size, default 100, maximum 200
customerCode string N Y Owner code
warehouseCode string N Y Warehouse code
location string N N Location
lpn string N N LPN
skus string Y N SKU list
documentNumbers string Y N Document number list, when not empty, maximum 200
documentType string N N Document type; common values: RECEIPT (receipt order), ORDER (outbound order), ADJUSTMENT (adjustment order), MOV (movement order), etc.
createdTimeFrom string N Conditional Creation time from; must be provided together with createdTimeTo
createdTimeTo string N Conditional Creation time to; must be provided together with createdTimeFrom
operateType string N N Operation type; common values: RECEIVE (receive), PUT_AWAY (put away), MOVEMENT (move), ADJUSTMENT (adjustment), etc.
operator string N N Operator

Validation notes: documentNumbers when empty, createdTimeFrom and createdTimeTo are required; otherwise an error is returned (documentNumbers or createdTimeFrom and createdTimeTo are required).

2.5.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "location": null,
  "lpn": null,
  "skus": ["sku_001"],
  "documentNumbers": [],
  "documentType": null,
  "createdTimeFrom": "2025-08-01 00:00:00",
  "createdTimeTo": "2025-08-21 23:59:59",
  "operateType": null,
  "operator": null,
  "page": 1,
  "pageSize": 50
}

2.5.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code
message string N N Message
total int N N Total record count
resultList object Y N Details on the current page
└ customerCode string N N Owner code
└ warehouseCode string N N Warehouse code
└ documentNumber string N N Document number
└ sku string N N SKU
└ udf1 string N N User-defined field 1
└ udf2 string N N User-defined field 2
└ udf3 string N N User-defined field 3
└ udf4 string N N User-defined field 4
└ customer string N N Customer/owner display value
└ location string N N Location
└ lpn string N N LPN
└ documentType string N N Document type; RECEIPT (receipt order), ORDER (outbound order), ADJUSTMENT (adjustment order), MOV (movement order), etc.
└ operateType string N N Operation type; common values RECEIVE (receive), PUT_AWAY (put away), MOVEMENT (move), ADJUSTMENT (adjustment), etc.
└ operator string N N Operator
└ qty double N N Quantity
└ toQty double N N Quantity after change
└ netAdjustment double N N Net adjustment
└ availableQty double N N Available quantity
└ toAvailableQty double N N Available quantity after change
└ allocatedQty double N N Allocated quantity
└ toAllocatedQty double N N Allocated quantity after change
└ onHoldQty double N N Hold quantity
└ toOnHoldQty double N N Hold quantity after change
└ pickedQty double N N Picked quantity
└ toPickedQty double N N Picked quantity after change
└ moveoutQty double N N Move-out quantity
└ createdDate string N N creation time
└ taskNumber string N N Task number
└ stockStatus string N N Stock status; common values GOOD (good), DAMAGE (damaged)
└ batchNumber string N N Batch number
└ mfgDate string N N Manufacturing date
└ expDate string N N Expiration date
└ originCountry string N N Country of origin
└ note string N N Description
└ partnerId string N N Partner ID

2.5.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "total": 1,
  "resultList": [
    {
      "customerCode": "customerCode_dc6c0ddeec80",
      "warehouseCode": "warehouseCode_2f851a4e9e82",
      "documentNumber": "DOC001",
      "sku": "sku_001",
      "udf1": null,
      "udf2": null,
      "udf3": null,
      "udf4": null,
      "customer": null,
      "location": "A010101",
      "lpn": null,
      "documentType": "ADJUSTMENT",
      "operateType": "ADJUSTMENT",
      "operator": "user01",
      "qty": 10.0,
      "toQty": 12.0,
      "netAdjustment": 2.0,
      "availableQty": 8.0,
      "toAvailableQty": 10.0,
      "allocatedQty": 0.0,
      "toAllocatedQty": 0.0,
      "onHoldQty": 0.0,
      "toOnHoldQty": 0.0,
      "pickedQty": 0.0,
      "toPickedQty": 0.0,
      "moveoutQty": 0.0,
      "createdDate": "2025-08-21 10:00:00",
      "taskNumber": null,
      "stockStatus": "GOOD",
      "batchNumber": null,
      "mfgDate": null,
      "expDate": null,
      "originCountry": null,
      "note": null,
      "partnerId": "partnerId_example"
    }
  ]
}

2.6. Inventory Movement Record Query API

Query inventory movement/transfer records by confirmation time range and other criteria (corresponds to OMS queryStockMovementRemote). The request field name confirmTimeForm matches the code (historical spelling, not From).

2.6.1. SERVICE_TYPE

GLINK_QUERY_STOCK_MOVEMENT_NOTIFY

2.6.2. Request Parameters

Inventory movement query request

Parameter Type List Required Description
partnerId string N N Partner ID
page int N N Page number, default 1
pageSize int N N Page size, default 100, maximum 200
customerCode string N Y Owner code
warehouseCode string N Y Warehouse code
sku string N N SKU
type string N N Movement type; common values: MOVELPN (move by pallet), MOVESKU (move by SKU), MOVELOC (move by location)
stockLocationFrom string N N Source location
stockLocationTo string N N Destination location
confirmTimeForm string N Y Confirmation time from
confirmTimeTo string N Y Confirmation time to

2.6.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "sku": null,
  "type": null,
  "stockLocationFrom": null,
  "stockLocationTo": null,
  "confirmTimeForm": "2025-08-01 00:00:00",
  "confirmTimeTo": "2025-08-21 23:59:59",
  "page": 1,
  "pageSize": 50
}

2.6.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code
message string N N Message
total long N N Total record count
transferInfoList object Y N Transfer detail list
└ sku string N N SKU
└ customerCode string N N Owner code
└ quantity double N N Quantity
└ type string N N Movement type; common values: MOVELPN (move by pallet), MOVESKU (move by SKU), MOVELOC (move by location)
└ stockLocationFrom string N N Source location
└ stockAreaFrom string N N Source zone
└ stockLpnFrom string N N Source LPN
└ stockLocationTo string N N Destination location
└ stockAreaTo string N N Destination zone
└ stockLpnTo string N N Destination LPN
└ status string N N Stock status; common values: GOOD (good), DAMAGE (damaged)
└ confirmTime string N N Confirmation time

2.6.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "total": 1,
  "transferInfoList": [
    {
      "sku": "sku_001",
      "customerCode": "customerCode_dc6c0ddeec80",
      "quantity": 5.0,
      "type": "MOVE",
      "stockLocationFrom": "A010101",
      "stockAreaFrom": null,
      "stockLpnFrom": null,
      "stockLocationTo": "A020202",
      "stockAreaTo": null,
      "stockLpnTo": null,
      "status": "CLOSED",
      "confirmTime": "2025-08-21 10:00:00"
    }
  ]
}

2.7. Inventory Adjustment Query API

Query inventory adjustments by adjustment time, status, and other criteria (corresponds to OMS queryStockAdjustmentRemote). The exposed Xing service method name is searchStockAdjuestment (matches the code spelling).

2.7.1. SERVICE_TYPE

GLINK_QUERY_STOCK_ADJUSTMENT_NOTIFY

2.7.2. Request Parameters

Inventory adjustment query request

Required time fields: adjustTimeForm, adjustTimeTo, format yyyy-MM-dd HH:mm:ss. If provided confirmTimeForm, confirmTimeTo (non-empty strings), the format must be the same as above.

Parameter Type List Required Description
partnerId string N N Partner ID
page int N N Page number, default 1
pageSize int N N Page size, default 100, maximum 200
customerCode string N Y Owner code
warehouseCode string N Y Warehouse code
adjustNumbers string N N Adjustment number/condition
sku string N N SKU
type string N N Adjustment type; common values: CYCLE_COUNT (cycle count), VARIANCE_ADJUSTMENT (variance adjustment), RECEIPT_ADJUSTMENT (receipt adjustment), etc.
status string N N Adjustment status; common values: NEW (new), CONFIRM (confirmed)
adjustTimeForm string N Y Adjustment time from
adjustTimeTo string N Y Adjustment time to
confirmTimeForm string N N Confirmation time from
confirmTimeTo string N N Confirmation time to

2.7.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "customerCode_dc6c0ddeec80",
  "warehouseCode": "warehouseCode_2f851a4e9e82",
  "adjustNumbers": null,
  "sku": null,
  "type": null,
  "status": null,
  "adjustTimeForm": "2025-08-01 00:00:00",
  "adjustTimeTo": "2025-08-21 23:59:59",
  "confirmTimeForm": null,
  "confirmTimeTo": null,
  "page": 1,
  "pageSize": 50
}

2.7.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Whether successful
code string N N Status code
message string N N Message
total long N N Total record count
adjustInfoList object Y N Adjustment list
└ adjustNumbers string N N Adjustment number
└ customerCode string N N Owner code
└ type string N N Adjustment type; common values: CYCLE_COUNT (cycle count), VARIANCE_ADJUSTMENT (variance adjustment), RECEIPT_ADJUSTMENT (receipt adjustment), etc.
└ status string N N Adjustment status; common values: NEW (new), CONFIRM (confirmed)
└ adjustReason string N N Adjustment reason
└ adjustTime string N N adjustment time
└ confirmTime string N N Confirmation time
└ remark string N N Description
└ adjustLineItems object Y N Detail lines
  └ sku string N N SKU
  └ quantity double N N Quantity
  └ freezeQuantity double N N Hold quantity
  └ adjustQuantityType string N N Adjustment quantitytype; common values: ADJUST_AVAILABLE_QTY (adjust available inventory), ADJUST_HOLD_QTY (adjust held inventory), ADJUST_QUARANTINE_QTY (adjust quarantined inventory)
  └ adjustType string N N Detail adjustment operation type; common values: ADD (add), REDUCE (reduce), TOTAL (total quantity adjustment)
  └ adjustQuantity double N N Adjustment quantity
  └ status string N N Detail stock status; GOOD (good), DAMAGE (damaged)
  └ stockLocation string N N Location
  └ stockArea string N N Zone
  └ stockLpn string N N LPN
└ refNumber string N N Reference number
└ partnerId string N N Partner ID

2.7.5. Response Example

JSON

{
  "success": true,
  "code": "SUCCESS",
  "message": null,
  "total": 1,
  "adjustInfoList": [
    {
      "adjustNumbers": "ADJ001",
      "customerCode": "customerCode_dc6c0ddeec80",
      "type": "COUNT",
      "status": "CLOSED",
      "adjustReason": "盘点",
      "adjustTime": "2025-08-21 09:00:00",
      "confirmTime": "2025-08-21 10:00:00",
      "remark": null,
      "refNumber": null,
      "partnerId": "partnerId_example",
      "adjustLineItems": [
        {
          "sku": "sku_001",
          "quantity": 10.0,
          "freezeQuantity": 0.0,
          "adjustQuantityType": null,
          "adjustType": null,
          "adjustQuantity": 2.0,
          "status": null,
          "stockLocation": "A010101",
          "stockArea": null,
          "stockLpn": null
        }
      ]
    }
  ]
}

2.8. Detailed Inventory Query API (WMS Detailed Inventory)

2.8.1. SERVICE_TYPE

GLINK_QUERY_STOCK_DETAIL_NOTIFY

2.8.2. Request Parameters

Detailed inventory query request

Parameter Type List Required Description
partnerId string N N Partner ID (not used as a query condition in the current local implementation)
customerCode string N Y Owner code; must not be empty, the service uses it to query the domain code and obtain the WMS owner code
warehouseCode string N Y Warehouse code; must not be empty
sku string Y N SKU code list; maximum 100; when empty, queries by pagination conditions
page int N N Page number; defaults to 1
pageSize int N N Records per page; defaults to 100; maximum 200

2.8.3. Request Example

JSON

{
  "partnerId": "partnerId_example",
  "customerCode": "CUSTOMER001",
  "warehouseCode": "WH001",
  "sku": [
    "SKU001"
  ],
  "page": 1,
  "pageSize": 100
}

2.8.4. Response Parameters

Parameter Type List Required Description
success boolean N Y Operation result; true when the query succeeds
code string N N Operation status code; on the success path, only success and data fields are set, on failure, returns the error code or error message set by the code
message string N N Message
total int N N Total record count; taken from the WMS detailed inventory query result
resultList object Y N Detailed inventory list on the current page; when there is no data, current code does not assign this field and it may be omitted
└ sku string N N SKU code
└ skuDescription string N N SKU name
└ location string N N Location
└ locationType string N N Location type; common values: STORAGE (storage location), PICKING (picking location), RECEIPT (receiving location), STAGING (staging location), PACK (packing location), etc.
└ zone string N N Zone
└ lpn string N N LPN
└ owner string N N Owner
└ status string N N Stock status; common values GOOD (good), DAMAGE (damaged)
└ qty int N N Quantity
└ unit string N N Unit; common values EA (piece), specific values depend on warehouse configuration
└ altQty double N N Converted quantity
└ altUnit string N N Converted unit; specific values depend on warehouse configuration
└ allocatedQty int N N Allocated quantity; older documentation states pending outbound orders in the warehouse do not increase allocated quantity
└ pickedQty int N N Picked quantity
└ availableQty int N N Available quantity; older documentation states pending outbound orders in the warehouse do not deduct available quantity
└ onholdQty int N N Hold quantity
└ moveoutQty int N N Move-out quantity
└ arrivalDate string N N Arrival date (detail receipt time)
└ warehouseArrivalDate string N N Warehouse arrival date
└ receiptDate string N N Last receipt date of the inbound order
└ putawayCompletedDate string N N Putaway completion date
└ asnNo string N N Receipt order number
└ orderNo string N N Order number
└ batchNo string N N Batch number
└ mfgDate string N N Manufacturing date
└ expDate string N N Expiration date
└ coo string N N Country of manufacture
└ category string N N Item category
└ brand string N N Brand

2.8.5. Response Example

JSON

{
  "success": true,
  "total": 1,
  "resultList": [
    {
      "sku": "SKU001",
      "skuDescription": "示例商品",
      "location": "A010101",
      "locationType": "PICKING",
      "zone": "ZONE01",
      "lpn": "LPN001",
      "owner": "OWNER001",
      "status": "GOOD",
      "qty": 100,
      "unit": "EA",
      "altQty": 100.0,
      "altUnit": "EA",
      "allocatedQty": 10,
      "pickedQty": 5,
      "availableQty": 85,
      "onholdQty": 0,
      "moveoutQty": 0,
      "arrivalDate": "2026-06-01 10:00:00",
      "warehouseArrivalDate": "2026-06-01 12:00:00",
      "receiptDate": "2026-06-02 09:00:00",
      "putawayCompletedDate": "2026-06-02 15:00:00",
      "asnNo": "ASN001",
      "orderNo": "ORDER001",
      "batchNo": "BATCH001",
      "mfgDate": "2026-01-01",
      "expDate": "2027-01-01",
      "coo": "CN",
      "category": "GENERAL",
      "brand": "BEST"
    }
  ]
}
© Copyright QianYi Team 2025 All Rights Reserved            Updated 2026-06-23 11:32:33

results matching ""

    No results matching ""