Open-API

Place Outbound Order

Sandbox

POST/3pp/outbound/v1/creation

This API syncs seller's orders on 3PP site to OC.
When the seller place non-MF orders on the 3PP site and they want OCH fulfil the orders, the 3PP site could sync these orders to OCH through this API.
The max number of outbound orders in a single request is 50.
In one call, 3PP should create no more than 50 outbound orders.

Request

Header 参数

clientKey

string

clientKey

必需

vAuthorization

string

必需

vAuthorization

Access-Token

string

必需

First please get the access_token thru accessToken&refreshToken API and refresh accseeToken.
Then pass the value following the below format to Header.
Bearer+one space+access_token valueExample:
Thru the API get Access_token value, which is 'accesstokenvaluexxxxxxxx'.
Header Value is as below:
Bearer accesstokenvaluexxxxxxxx

apiVersion

string

可选

data

array[object (Outbound order list) {20}]

可选

companyName

string

可选

The company name or business name of the consignee

>= 0 字符<= 100 字符

consigneeAddress1

string

必需

The consignee's address line 1

>= 0 字符<= 200 字符

consigneeAddress2

string

可选

The consignee's address line 2

>= 0 字符<= 200 字符

consigneeCity

string

可选

The consignee's city

>= 0 字符<= 100 字符

consigneeCountryCode

string

必需

The consignee's country, 2-character country code(ISO-3166)

>= 0 字符<= 2 字符

consigneeEmail

string

可选

The consignee's email address

>= 0 字符<= 100 字符

consigneeName

string

必需

The consignee's full name

consigneePhone

string

可选

The consignee's contact Number

>= 0 字符<= 100 字符

consigneeProvinceOrState

string

可选

The consignee's Province/state

>= 0 字符<= 100 字符

consigneeZipCode

string

可选

The consignee's zip code

>= 0 字符<= 10 字符

ebayId

string

可选

The eBay id,
If orderPlatform = ”eBay“ (ignore case), this field is mandatory.

>= 0 字符<= 100 字符

ebayOrderId

string

可选

The eBay order id,the format:
02-05696-00555
If orderPlatform = ”eBay“ (ignore case), this field is mandatory.

>= 0 字符<= 100 字符

fileGroupID

string

可选

Get the value of the field when calling the uploadFile V2 API first

>= 0 字符<= 255 字符

houseNumber

string

可选

The consignee's house number

>= 0 字符<= 10 字符

orderPlatform

string

可选

Platform Name

>= 0 字符<= 50 字符

productList

array[object (SkuProductDTO) {6}]

可选

referenceNumber

string

必需

3pp outbound order number

>= 0 字符<= 100 字符

remarks

string

可选

outbound order remarks

>= 0 字符<= 255 字符

serviceRegion

string

必需

From which MF warehouse seller want this order to be fulfilled. OCH defines these regional warehouse list, 3PP could get this foundational data from "getServiceList" API.

>= 0 字符<= 50 字符

shippingServiceCode

string

必需

By which the shipping option seller wants this order to be fulfilled. OCH defines these shipping options list, 3PP could get this foundational data from "getServiceList" API.

>= 0 字符<= 100 字符

messageId

string

可选

timestamp

integer <int64>

可选

{
  "apiVersion": "string",
  "data": [
    {
      "companyName": "string",
      "consigneeAddress1": "string",
      "consigneeAddress2": "string",
      "consigneeCity": "string",
      "consigneeCountryCode": "st",
      "consigneeEmail": "string",
      "consigneeName": "string",
      "consigneePhone": "string",
      "consigneeProvinceOrState": "string",
      "consigneeZipCode": "string",
      "ebayId": "string",
      "ebayOrderId": "string",
      "fileGroupID": "string",
      "houseNumber": "string",
      "orderPlatform": "string",
      "productList": [
        {
          "currency": "str",
          "declaredValue": 0,
          "eBayItemId": "string",
          "eBayTransactionId": "string",
          "mfSkuId": "string",
          "skuQuantity": 0
        }
      ],
      "referenceNumber": "string",
      "remarks": "string",
      "serviceRegion": "string",
      "shippingServiceCode": "string"
    }
  ],
  "messageId": "string",
  "timestamp": 0
}

Request samples

返回响应

OK(200)

error305002(200)

error401203(200)

OK(200)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer <int32>

可选

data

array[object (OrderReferenceNumberDTO) {2}]

可选

orderNumber

string

必需

Unique order number generated by OCH

>= 0 字符<= 50 字符

referenceNumber

string

必需

3pp outbound order number

>= 0 字符<= 100 字符

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

可选

code

string

可选

string

可选

message

string

可选

message

string

可选

messageId

string

可选

success

boolean

可选

"{
    "code": 0, 
    "data": [
        {
            "orderNumber": "OCO000000000000XX", 
            "referenceNumber": "00000000000000"
        }, 
        {
            "orderNumber": "OCO000000000001XX", 
            "referenceNumber": "00000000000001"
        }
    ], 
    "message": "Interface call succeeded.", 
    "messageId": "000000000000000"
}
"

最后修改时间： 10 个月前