Open-API

Inbound Order List Query

Sandbox

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

POST

/3pp/inbound/v1/query

Inbound

3PP could get inbound order status through this 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:

Body Params application/json

apiVersion

string

required

data

object

required

inboundNumberList

object

optional

sellerInboundNumberList

object

optional

startTime

string

required

endTime

string

required

messageId

string

required

timestamp

integer

required

Example

{
    "apiVersion": "string",
    "data": {
        "inboundNumberList": {
            "inboundNumber": "OCI4DE06746410"
        },
        "sellerInboundNumberList": {
            "sellerInboundNumber": "2203123123123030043"
        },
        "startTime": "2025-06-17T10:10:10+0800",
        "endTime": "2025-06-19T10:10:10+0800"
    },
    "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/query' \
--header 'clientKey: bd1d1971-d0db-11ea-b4a1-00505694c27b' \
--header 'Access-Token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "inboundNumberList": {
            "inboundNumber": "OCI4DE06746410"
        },
        "sellerInboundNumberList": {
            "sellerInboundNumber": "2203123123123030043"
        },
        "startTime": "2025-06-17T10:10:10+0800",
        "endTime": "2025-06-19T10:10:10+0800"
    },
    "messageId": "string",
    "timestamp": 0
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (Response of query inbound order) {10}]

optional

asnList

array[object (ExternalInboundOrderQueryAsnDto) {1}]

optional

Created ASN list

batchList

array[object (Batch number and status of inbound order batch) {2}]

optional

Batch list of this inbound order

bookingNumber

string

optional

Booking number for create ASN

inboundOrderNumber

string

required

Inbound order number

putAwayQty

integer <int32>

optional

SKU quantity that has put away

referenceNumber

string

optional

Reference number send for 3PP

shippingMethod

string

required

Shipping method:OF-Ocean Freight, AF-Air Freight, RF-Rail Freight, TK-Truck EX-Express

skuQty

integer <int32>

optional

SKU quantity in this inbound order

status

string

required

Status of this inbound order: Await Booking, Scheduled, Arrived, Partially put away, Put away, Canceled

warehouseCode

string

required

Code of the warehouse

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,
    "data": [],
    "errors": [
        {
            "code": "300003",
            "message": "startTime = yyyy-MM-dd'T'HH:mm:ssZ是非法的！"
        }
    ],
    "messageId": "string",
    "success": false
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2025-06-18 10:39:13

PlaceInboundOrder

Inbound Order Detail Query