Inbound Label Query

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 (ExternalInboundOrderQueryLabelRequestDto)

optional

inboundOrderList

array[object (ExternalInboundOrderQueryLabelInboundRequestDto) {1}]

required

The OC's inbound order number

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
    "data": {
        "inboundOrderList": [
            {
                "inboundOrder": "OCI4DE06746410"
            }
        ]
    },
    "messageId": "679350933",
    "timestamp": 1701242572
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://openapi-stage-hk.orangeconnex.com/openapi/3pp/inbound/v1/query/labels' \
--header 'clientKey: bd1d1971-d0db-11ea-b4a1-00505694c27b' \
--header 'Access-Token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "inboundOrderList": [
            {
                "inboundOrder": "OCI4DE06746410"
            }
        ]
    },
    "messageId": "679350933",
    "timestamp": 1701242572
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

object (Response of query inbound label)

optional

inboundOrderNumber

string

required

OC生成的入库单号

packingListUrl

string

required

OC生成的装箱单

cartonList

array [object {2}]

required

OC生成的箱唛号列表

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

SuccessException

{
    "code": 0,
    "data": {
        "inboundOrderList": [
            {
                "cartonList": [
                    {
                        "cartonNumber": "OCxx",
                        "labelUrl": "https://xxx/xx.pdf"
                    },
                    {
                        "cartonNumber": "OCxx",
                        "labelUrl": "https://xxx/xx.pdf"
                    },
                    {
                        "cartonNumber": "OCxx",
                        "labelUrl": "https://xxx/xx.pdf"
                    }
                ],
                "inboundOrder": "OCIxxx",
                "packingListUrl": "https://xxx/b8282c5e214f9c83faf97871cddd0fb1.pdf"
            }
        ]
    },
    "messageId": "56a42c67-7583-491d-937a-e4c79ad2f3bf",
    "success": true
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found