Open-API

Upload Clearance Doc

Sandbox

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

POST

/3pp/inbound/v1/upload/customs-clearance-file

Inbound

3PP chold 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 (Inbound order Clearance File)

optional

fileList

array[object (Clearance File) {3}]

optional

inboundNumber

string

required

The inbound number offered by OC when inbound order created.

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
    "apiVersion": "string",
    "data": {
        "fileList": [
            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "PL"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "IN"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "BL"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "MAWB"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "DP"
            }
        ],
        "inboundNumber": "OCI5GB06746394"
    },
    "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/customs-clearance-file' \
--header 'clientKey: bd1d1971-d0db-11ea-b4a1-00505694c27b' \
--header 'Access-Token: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "fileList": [
            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "PL"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "IN"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "BL"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "MAWB"
            },            {
                "file": "string",
                "fileName": "string.PDF",
                "fileType": "DP"
            }
        ],
        "inboundNumber": "OCI5GB06746394"
    },
    "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

Examples

ExceptionSuccess

{
    "code": 3,
    "errors": [
        {
            "code": "300002",
            "message": "fileType 字段长度范围1-4。"
        }
    ],
    "message": "参数错误",
    "messageId": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Modified at 2025-06-18 10:58:24

Upload TrackingNo

Place Outbound Order