Open-API

Inbound Order Detail Query

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

Example:

bd1d1971-d0db-11ea-b4a1-00505694c27b

vAuthorization

string

required

vAuthorization

Access-Token

string

required

Access-Token

Example:

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

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://openapi-stage-hk.orangeconnex.com/openapi/3pp/inbound/v1/detail' \
--header 'clientKey: bd1d1971-d0db-11ea-b4a1-00505694c27b' \
--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

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Examples

ExceptionSuccess

{
    "code": 3,
    "errors": [
        {
            "code": "3A0529",
            "message": "Query fail. Because inboundNumber [string] doesnt exists. Please check your inboundNumber and try again."
        }
    ],
    "messageId": "string",
    "success": false
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2025-06-18 11:57:12

Inbound Order List Query

Inbound Label Query