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 Params
clientKey
string
required
clientKey
Example:
bd1d1971-d0db-11ea-b4a1-00505694c27b
vAuthorization
string
required
vAuthorization
Access-Token
string
required
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
Example:
{{Access-Token}}
Body Params application/json
apiVersion
string
optional
data
array[object (Outbound order list) {23}]
optional
companyName
string
optional
The company name or business name of the consignee
>= 0 characters<= 100 characters
consigneeAddress1
string
required
The consignee's address line 1
>= 0 characters<= 200 characters
consigneeAddress2
string
optional
The consignee's address line 2
>= 0 characters<= 200 characters
consigneeCity
string
optional
The consignee's city
>= 0 characters<= 100 characters
consigneeCountryCode
string
required
The consignee's country, 2-character country code(ISO-3166)
>= 0 characters<= 2 characters
consigneeEmail
string
optional
The consignee's email address
>= 0 characters<= 100 characters
consigneeName
string
required
The consignee's full name
consigneePhone
string
optional
The consignee's contact Number
>= 0 characters<= 100 characters
consigneeProvinceOrState
string
optional
The consignee's Province/state
>= 0 characters<= 100 characters
consigneeZipCode
string
optional
The consignee's zip code
>= 0 characters<= 10 characters
ebayId
string
optional
The eBay id, If orderPlatform = ”eBay“ (ignore case), this field is mandatory.
>= 0 characters<= 100 characters
ebayOrderId
string
optional
The eBay order id,the format: 02-05696-00555 If orderPlatform = ”eBay“ (ignore case), this field is mandatory.
>= 0 characters<= 100 characters
fileGroupID
string
optional
Get the value of the field when calling the uploadFile V2 API first
>= 0 characters<= 255 characters
houseNumber
string
optional
The consignee's house number
>= 0 characters<= 10 characters
orderPlatform
string
optional
Platform Name
>= 0 characters<= 50 characters
productList
array[object (SkuProductDTO) {6}]
optional
referenceNumber
string
required
3pp outbound order number
>= 0 characters<= 100 characters
remarks
string
optional
outbound order remarks
>= 0 characters<= 255 characters
serviceRegion
string
required
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 characters<= 50 characters
shippingServiceCode
string
required
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 characters<= 100 characters
vasCode
string
optional
List of value-added services provided by the OC system: SG: lastmile signature service RL: Parcel Return label service
taxId
string
optional
Required for shipments to Mexico.
reShipmentEbayOrder
boolean
optional
Is it allowed to use the eBay order ID again for shipping through the eBay channel, provided that there is no limit on the number of times within 3 months, and the recipient's address must be the same as the first valid order?