Open-API
  1. Stock
Open-API
  • eBay fulfillment openAPI
  • OAuth
    • URL(getAuthorizationCode)
      GET
    • AccessToken
      POST
    • Refresh AccessToken
      POST
  • SKU
    • SKUCreation v3
      POST
    • SKUQuery v3
      POST
    • SKU Label
      POST
    • SKUSetupEFService
      POST
    • QuerySKUEFService
      POST
  • Stock
    • GetStockMovement
      POST
    • StockSnapshot v2
      POST
  • Inbound
    • PlaceInboundOrder
      POST
    • Inbound Order List Query
      POST
    • Inbound Order Detail Query
      POST
    • Inbound Label Query
      POST
    • Upload TrackingNo
      POST
    • Upload Clearance Doc
      POST
  • Outbound
    • Place Outbound Order
      POST
    • Outbound Order Query v2
      POST
    • Outbound Order Cancellation
      POST
  • Warehouse
    • GetServiceList
      GET
  • Pricing
    • Cost Estimation Request
      POST
    • Cost Estimation Response
      POST
  1. Stock

StockSnapshot v2

Sandbox
https://openapi-stage-hk.orangeconnex.com/openapi
Sandbox
https://openapi-stage-hk.orangeconnex.com/openapi
POST
/3pp/inventory/v2/snapshot
Stock
This endpoint allows you to retrieve the inventory quantities for specified SKUs across different regional warehouses, categorized by their various statuses.
Enhancements from v1:
Supports pagination, enabling you to return the complete set of SKUs.
Parameters:
SKUList: At least one SKU must be provided in this parameter.
Response:
The response includes inventory data for the following regional warehouses:
UK
DE
AU (Sydney warehouse)
AU-MEL (Melbourne warehouse)
US-East
UE-South
US-West
For a complete list of available services, we recommend using the getServiceList API.
该 Snapshot v2接口支持获取各个SKU在各个区域仓内的、不同状态的库存数量。
接口对比 v1,支持分页查询,可以返回全量的 SKU 。
入参中, SKUList 中至少有一个入参必填。
返回的区域仓包括:UK,DE,AU(澳洲的悉尼仓),AU-MEL(澳洲的墨尔本仓),US-East,UE-South,US-West 等,建议您通过"getServiceList" API获取最新数据

Request

Header Params
clientKey
string 
required
clientKey
Example:
bd1d1971-d0db-11ea-b4a1-00505694c27b
vAuthorization
string 
required
vAuthorization
Access-Token
string 
required
Access-Token
Example:
{{Access-Token}}
Body Params application/json
apiVersion
string 
optional
data
object 
optional
pageNumber
integer <int32>
optional
The page number of request
pageSize
integer <int32>
optional
The max number of the each page can't exceed 200
serviceRegionList
array [object {1}] 
optional
skuList
array [object {1}] 
optional
messageId
string 
optional
timestamp
integer <int64>
optional
Example
{
  "data": {
    "pageNumber": 1,
    "pageSize": 200,
    "skuList": [],
    "serviceRegionList": [
      {
        "serviceRegion": "DE"
      }
    ]
  },
  "messageId": "1d217396-2565-4c87-a009-19c96dbb616f",
  "timestamp": "1701315629000"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://openapi-stage-hk.orangeconnex.com/openapi/3pp/inventory/v2/snapshot' \
--header 'clientKey: bd1d1971-d0db-11ea-b4a1-00505694c27b' \
--header 'Access-Token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "pageNumber": 1,
    "pageSize": 200,
    "skuList": [],
    "serviceRegionList": [
      {
        "serviceRegion": "DE"
      }
    ]
  },
  "messageId": "1d217396-2565-4c87-a009-19c96dbb616f",
  "timestamp": "1701315629000"
}'

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
data
object (stock v2Res) 
optional
hasNextPage
boolean 
optional
whether have the next page
Example:
false
pageNumber
integer <int32>
optional
The page number of request
pageSize
integer <int32>
optional
The amount of data on the current page
skuList
array[object (sku inventory) {10}] 
optional
If this field is null, OC returns all the SKUs' inventory snapshot of the request time.
totalPage
integer <int32>
optional
The total number of pages according to the request result
errors
array[object (CommonVendorResponseErrorMsgDto) {3}] 
optional
code
string 
optional
id
string 
optional
message
string 
optional
message
string 
optional
messageId
string 
optional
success
boolean 
optional
Examples
{
    "code": 0,
    "data": {
        "SKUList": [
            {
                "MFSKUID": "OC0000012208036",
                "available": 0,
                "inTransit": 441,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 40,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012214015",
                "available": 0,
                "inTransit": 707,
                "received": 4,
                "reservedAllocated": 0,
                "reservedHold": 0,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012214042",
                "available": 0,
                "inTransit": 0,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 0,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012214079",
                "available": 0,
                "inTransit": 0,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 0,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012220012",
                "available": 0,
                "inTransit": 681,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 20,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012220021",
                "available": 0,
                "inTransit": 771,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 15,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012220030",
                "available": 0,
                "inTransit": 0,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 6,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012222018",
                "available": 0,
                "inTransit": 0,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 5,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012230066",
                "available": 0,
                "inTransit": 624,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 0,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012230075",
                "available": 0,
                "inTransit": 0,
                "received": 28533,
                "reservedAllocated": 0,
                "reservedHold": 7100,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012252015",
                "available": 0,
                "inTransit": 793,
                "received": 0,
                "reservedAllocated": 0,
                "reservedHold": 20,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012254011",
                "available": 0,
                "inTransit": 54,
                "received": 1003,
                "reservedAllocated": 0,
                "reservedHold": 20,
                "reservedVAS": 0,
                "serviceRegion": "DE",
                "suspend": 0,
                "unfulfillable": 0
            },
            {
                "MFSKUID": "OC0000012252024",
                "available": 0,
                "inTransit": 0,
                "received": 100,
              
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Modified at 2025-06-18 10:23:00
Previous
GetStockMovement
Next
PlaceInboundOrder
Built with