Open-API

PlaceInboundOrder

Sandbox

POST

/3pp/inbound/v1/creation

Inbound

When seller going to ship products into warehouse. They needs to place a inbound order from ERP first.

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 (Inbound order list)

optional

cartonList

array[object (ExternalInboundOrderCartonDto) {5}]

required

carton list

eta

string

required

Estima arrival date format: date + time zone, UTC ISO8601，ex：2018-11-28+0800

sellerInboundNumber

string

required

3PP inbound order number.

serviceRegion

string

required

Which fulfillment center you will ship to. For Germany, the serviceRegion value of the fulfillment center is DE,UK.

shippingFrom

string

required

Which country your inventory is shipped from. Please provide the 2-character country code(ISO-3166)
for example: CN,DE

shippingMethod

string

required

Shipping methods selected
TK-Truck
EX-Express

transportMethod

string

optional

Transport mode of shipping to destination fulfillment center，Transpotation Mode List
OF = Ocean Freight
AF = Air Freight
RF = Rail Freight
TK = Truck

vat

string

optional

The VAT number which seller created on OC's seller portal.

messageId

string

optional

timestamp

integer <int64>

optional

Example

{
  "apiVersion": "string",
  "data": {
    "cartonList": [
      {
        "cartonNumber": "string",
        "cartonOriginCountry": "st",
        "labelSize": "string",
        "productList": [
          {
            "mfskuid": "string",
            "quantity": 0
          }
        ],
        "sellerCartonNumber": "string"
      }
    ],
    "eta": "string",
    "sellerInboundNumber": "string",
    "serviceRegion": "string",
    "shippingFrom": "string",
    "shippingMethod": "string",
    "transportMethod": "string",
    "vat": "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/creation' \
--header 'clientKey;' \
--header 'vAuthorization;' \
--header 'Access-Token;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "apiVersion": "string",
    "data": {
        "cartonList": [
            {
                "cartonNumber": "string",
                "cartonOriginCountry": "st",
                "labelSize": "string",
                "productList": [
                    {
                        "mfskuid": "string",
                        "quantity": 0
                    }
                ],
                "sellerCartonNumber": "string"
            }
        ],
        "eta": "string",
        "sellerInboundNumber": "string",
        "serviceRegion": "string",
        "shippingFrom": "string",
        "shippingMethod": "string",
        "transportMethod": "string",
        "vat": "string"
    },
    "messageId": "string",
    "timestamp": 0
}'

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (Response of create inbound order) {12}]

optional

address

string

required

The location of the warehouse

asn

boolean

required

Whether need create ASN

Example:

false

bookingNumber

string

optional

Booking number for create ASN

cartonList

array[object (Carton number and label url of inbound order) {2}]

optional

Carton list of this inbound order

clearanceDocList

array[object (Clearance document type) {1}]

optional

Clearance document types if need

contactsMail

string

required

E-mail of the warehouse

contactsName

string

required

Contact of the warehouse

contactsPhone

string

required

Phone of the warehouse

inboundOrderNumber

string

required

Inbound order number

needClearanceDoc

boolean

required

Whether need upload clearance documents

Example:

false

packingListUrl

string

required

Url to download packing list label

warehouseArea

string

optional

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

Example

{
  "code": 0,
  "data": [
    {
      "address": "string",
      "asn": false,
      "bookingNumber": "string",
      "cartonList": [
        {
          "cartonNumber": "string",
          "labelUrl": "string"
        }
      ],
      "clearanceDocList": [
        {
          "fileType": "string"
        }
      ],
      "contactsMail": "string",
      "contactsName": "string",
      "contactsPhone": "string",
      "inboundOrderNumber": "string",
      "needClearanceDoc": false,
      "packingListUrl": "string",
      "warehouseArea": "string"
    }
  ],
  "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

StockSnapshot v2

Inbound Order List Query