Open-API

Inbound Label Query

Sandbox

POST

/3pp/inbound/v1/query/labels

Inbound

The seller has create an inbound order successful，and they can use this API to print inbound carton label

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 (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": "OCI4AU05251270"
      }
    ]
  },
  "messageId": "679350933",
  "timestamp": 1701242572
}

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/labels' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "inboundOrderList": [
            {
                "inboundOrder": "OCI4AU05251270"
            }
        ]
    },
    "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

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Example

{
  "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

Modified at 2023-11-30 06:31:27

Inbound Order Detail Query

Upload TrackingNo