Open-API
  1. Inbound
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. Inbound

Inbound Order Detail Query

Sandbox
https://openapi-stage-hk.orangeconnex.com/openapi
Sandbox
https://openapi-stage-hk.orangeconnex.com/openapi
POST
/3pp/inbound/v1/detail
Inbound
3PP can upload 'Customs Clearance' file if origin is not European countries

Request

Header Params
clientKey
string 
required
clientKey
vAuthorization
string 
required
vAuthorization
Access-Token
string 
required
Access-Token
Body Params application/json
apiVersion
string 
optional
data
object (ExternalInboundOrderQueryInfoRequestDto) 
optional
endTime
string <date-time>
optional
If null, OC takes the API request time as the end time.
Format: date + time zone, UTC ISO8601，ex：2018-11-28T20:09:57+0800
The duration between endTime and startTime should be less than 7days.
inboundNumberList
array[string]
optional
inbound order number in OC platform
sellerinboundNumberList
array[string]
optional
inbound order number in 3pp platform
startTime
string <date-time>
optional
OC returns all the orders created or having status changed since this start time. Start time format: date + time zone, UTC ISO8601，ex：2018-11-28T20:09:57+0800startTime can not be one year ago. The higher the sync frequency, the more up to date order status is, so daily sync is recommended.
messageId
string 
optional
timestamp
integer <int64>
optional
Example
{
    "apiVersion": "string",
    "data": {
        "endTime": "2019-08-24T14:15:22Z",
        "inboundNumberList": [
            "string"
        ],
        "sellerinboundNumberList": [
            "string"
        ],
        "startTime": "2019-08-24T14:15:22Z"
    },
    "messageId": "string",
    "timestamp": 0
}

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/inbound/v1/detail' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "endTime": "2019-08-24T14:15:22Z",
        "inboundNumberList": [
            "string"
        ],
        "sellerinboundNumberList": [
            "string"
        ],
        "startTime": "2019-08-24T14:15:22Z"
    },
    "messageId": "string",
    "timestamp": 0
}'

Responses

🟢200OK
application/json
Body
code
integer <int32>
optional
data
object (Response of query inbound order detail) 
optional
inboundOrderList
array[object (ExternalInboundOrderQueryDetailResponseDTO) {12}] 
optional
errors
array[object (CommonVendorResponseErrorMsgDto) {3}] 
optional
code
string 
optional
id
string 
optional
message
string 
optional
message
string 
optional
messageId
string 
optional
success
boolean 
optional
Example
{
    "code": 0,
    "data": {
        "inboundOrderList": [
            {
                "asnList": [
                    {
                        "asnNumber": "string"
                    }
                ],
                "batchList": [
                    {
                        "arrivalTime": 0,
                        "asnnumber": "string",
                        "inboundBatchNumber": "string"
                    }
                ],
                "bookingNumber": "string",
                "fileList": [
                    {
                        "failReason": "string",
                        "file": "string",
                        "fileName": "string",
                        "fileType": "string",
                        "verifyStatus": "string"
                    }
                ],
                "inboundNumber": "string",
                "sellerinboundNumber": "string",
                "serviceRegion": "string",
                "shippingMethod": "string",
                "skulist": [
                    {
                        "nonStandardQuantity": 0,
                        "ocskuid": "string",
                        "putawayQuantity": 0,
                        "receivedQuantity": 0,
                        "sellerSKUID": "string",
                        "skuquantity": 0
                    }
                ],
                "status": "string",
                "trackingList": [
                    {
                        "carrier": "string",
                        "cartonNumber": "string",
                        "trackingNumber": "string"
                    }
                ],
                "transportMethod": "string"
            }
        ]
    },
    "errors": [
        {
            "code": "string",
            "id": "string",
            "message": "string"
        }
    ],
    "message": "string",
    "messageId": "string",
    "success": true
}
🟢201Created
🟠401Unauthorized
🟠403Forbidden
🟠404Not Found
Previous
Inbound Order List Query
Next
Inbound Label Query
Built with