Return Stock Snapshot

Sandbox

https://openapi-stage-hk.orangeconnex.com/openapi

POST

/3pp/returns/v1/query/stock

3PP can get inventory snapshot for return stock through this API.
Per return stock, OC will provide a location-specific inventory snapshot of the request time.

Request

Header Params

Body Params application/json

Examples

Example 1Example 2

{
  "messageId": "{{messageId}}",
  "data": {
    "serviceType": "SKU",
    "uniqueIdList": [
      "DE01UC",
      "DE01UC001",
      "DE01UC002",
      "DE01UC003",
      "DE01UC004",
      "asdfg12345"
    ],
    "pageNumber": 1,
    "pageSize": 20
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Example 1Example 2

curl --location 'https://openapi-stage-hk.orangeconnex.com/openapi/3pp/returns/v1/query/stock' \
--header 'Access-Token: ' \
--header 'Content-Type: application/json' \
--data '{
  "messageId": "{{messageId}}",
  "data": {
    "serviceType": "SKU",
    "uniqueIdList": [
      "DE01UC",
      "DE01UC001",
      "DE01UC002",
      "DE01UC003",
      "DE01UC004",
      "asdfg12345"
    ],
    "pageNumber": 1,
    "pageSize": 20
  }
}'

Responses

🟢200

application/json

Bodyapplication/json

Example

{
    "requestId": "string",
    "success": true,
    "hasBusinessException": true,
    "errorCode": "string",
    "errorMsg": "string",
    "message": "string",
    "result": {
        "pageNumber": 0,
        "pageSize": 0,
        "hasNextPage": true,
        "totalPage": 0,
        "serviceType": "string",
        "inventoryList": [
            {
                "uniqueId": "string",
                "mfSkuId": "string",
                "warehouseCode": "string",
                "available": 0,
                "reservedAllocated": 0,
                "reservedHold": 0,
                "reservedVAS": 0,
                "unfulfillable": 0,
                "suspend": 0,
                "length": 0,
                "width": 0,
                "height": 0,
                "lengthUnit": "string",
                "weight": 0,
                "weightUnit": "string",
                "putAwayTime": "string"
            }
        ],
        "requestCount": 0,
        "successCount": 0,
        "failedCount": 0,
        "failedList": [
            "string"
        ]
    },
    "isFallback": true
}

Modified at 2026-07-09 02:22:04

Return Order Query

Return Association