Open-API

Upload TrackingNo

Sandbox

POST

/3pp/inbound/v1/upload/shipment-file

Inbound

3PP could upload tracking number if the shipping method is express

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 (Order Shipment No File)

optional

inboundNumber

string

required

The inbound number offered by OC when inbound order created.

>= 1 characters<= 100 characters

referenceNumber

string

required

referenceNumber

>= 1 characters<= 50 characters

trackingList

array [object {3}]

required

tracking list

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
  "apiVersion": "string",
  "data": {
    "inboundNumber": "string",
    "referenceNumber": "string",
    "trackingList": [
      {
        "cartonNumber": "string",
        "carrier": "string",
        "trackingNumber": "string"
      }
    ]
  },
  "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/upload/shipment-file' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "inboundNumber": "string",
        "referenceNumber": "string",
        "trackingList": [
            {
                "cartonNumber": "string",
                "carrier": "string",
                "trackingNumber": "string"
            }
        ]
    },
    "messageId": "string",
    "timestamp": 0
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

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,
  "errors": [
    {
      "code": "string",
      "id": "string",
      "message": "string"
    }
  ],
  "message": "string",
  "messageId": "string",
  "success": true
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2023-10-19 08:25:59

Inbound Label Query

Upload Clearance Doc