Outbound Order Query v2

3PP can get order status through this API.
After the seller placed an order on the 3PP site, if they want to monitor or view order fulfillment status, OC support 3PP querying orders information by an "order list" or by order creation time slot.
This interface is for querying order information, providing details such as order status,carrier, tracking number, and the fulfillment fees.
The fulfillment fees are estimated before outbound, and reflect the actual costs after outbound.
Return a maximum of 1000 results. Please narrow the search scope if it exceeds this limit.

此接口为订单信息查询接口，获取订单状态、尾程供应商和尾程单号，以及订单履约费用。
出库前为预估费用，出库后，为真实扣费。
返回结果最多1000条，超出请缩小查询范围。

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:

Body Params application/json

apiVersion

string

required

data

object

required

ebayOrderIdList

array [object {2}]

required

endTime

string

required

orderNumberList

array [object {1}]

required

referenceNumberList

array [object {1}]

required

startTime

string

required

messageId

string

required

timestamp

integer

required

Examples

Example 1Example 2

{
    "apiVersion": "2.0",
    "data": {
        "ebayOrderIdList": [
            {
                "ebayId": "25-11158-23993",
                "ebayOrderId": "25-11158-23993"
            }
        ],
        "endTime": "2023-04-25T20:09:57+0800",
        "orderNumberList": [
            {
                "orderNumber": "OCO2000009385032GB"
            }
        ],
        "referenceNumberList": [
            {
                "referenceNumber": "25daq"
            }
        ],
        "startTime": "2023-04-21T20:09:57+0800"
    },
    "messageId": "20200430040406976",
    "timestamp": 1588233847001
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

code

integer <int32>

optional

data

array[object (ExternalOrderResponseDTO) {19}]

optional

autoFulfillmentEF

boolean

required

Whether the order is EF auto-fulfillment order

Example:

false

ebayOrderId

string

optional

OrderArray.Order.OrderID field value of ebay GetOrders API.

>= 0 characters<= 100 characters

extendedOrderId

string | null

optional

OrderArray.Order.ExtendedOrderID field value of ebay GetOrders API.

>= 0 characters<= 100 characters

ocid

string

optional

reShipmentEbayOrder

boolean

optional

Is it allowed to use the eBay order ID again for shipping through the eBay channel, with the shipping limit being 5 times within 6 months, and the recipient's address must be the same as the first valid order?

VASCode

string

optional

List of value-added services provided by the OC system:
SG: lastmile signature service
RL: Parcel Return label service

routingCode

string

optional

Last mile routing code for Return Label, can be found on the return label

billingNumber

string

optional

Last mile billing number for Return Label, can be found on the return label

returnLabelCarrier

string

optional

Last mile delivery carrier name for Return Label

returnLabelTrackingNumber

string

optional

Last mile delivery tracking number for Return Label

orderCreationTime

string

optional

Format: date + time zone, UTC ISO8601，ex：2018-11-28T20:09:57+0800

>= 0 characters<= 24 characters

orderNumber

string

required

Unique order number generated by OCH

>= 0 characters<= 50 characters

orderStatus

string

required

Value is limited to the codes predefined on the left side of the equal sign: Draft/Submitted/Failed/Exception/Cancelled/Create picking task/Picked/Packed/Outbound/In-delivery/Delivered/Undeliverable Return/Buyer Return. It might be updated based on operation requirement.

>= 0 characters<= 50 characters

referenceNumber

string

optional

3pp outbound order number

>= 0 characters<= 100 characters

remark

string

optional

Remark of this order or order status, e.g.: "ebayItemID&eBayTransactionID is duplicated"

serviceRegion

string

required

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

>= 0 characters<= 50 characters

shippingServiceCode

string

required

By which shipping option this order is fulfilled. OCH defines these shipping option list, 3PP could get this foundational data from "getServiceList" API.

>= 0 characters<= 100 characters

orderOutboundTime

string

optional

orderOutboundTime String optional Format: date + time zone, UTC ISO8601，ex：2018-11-28T20:09:57+0800 >= 0 characters <= 24 characters

trackingNumberList

array [object {10}]

required

If one order need to be shippied by multiple separate packages, there should be one tracking number for each package.

errors

array[object (CommonVendorResponseErrorMsgDto) {3}]

optional

code

string

optional

string

optional

message

string

optional

message

string

optional

messageId

string

optional

success

boolean

optional

Examples

Success 1Success 2Exception

{
    "code": 0,
    "data": [
        {
            "orderNumber": "OCO0000011225074GB",
            "autoFulfillmentEF": false,
            "orderCreationTime": "2022-05-17T16:00:16+0800",
            "referenceNumber": "",
            "serviceRegion": "UK",
            "trackingNumberList": [
                {
                    "feeAmount": 19,
                    "orderNumber": "OCO0000011225074GB",
                    "LMCarrierCode": "XDP",
                    "chargeableWeight": "11000.0000",
                    "feeAmountCurrency": "GBP",
                    "LMCarrierName": "XDP",
                    "chargeableWeightUnit": "g",
                    "SKUList": [
                        {
                            "MFSKUID": "OC0000000675549",
                            "SKUQuantity": 2,
                            "SN": "A01,A02"
                        }
                    ],
                    "trackingNumber": "ZDBBXK035781"
                }
            ],
            "orderStatus": "Outbound",
            "OCID": "10908711",
            "extendedOrderId": "25-11158-23993",
            "shippingServiceCode": "GBDomesticFreight",
            "orderOutboundTime": "2022-05-18T18:04:38+0800",
            "eBayOrderId": "25-11158-23993"
        }
    ],
    "errors": [],
    "messageId": "20200430040406976",
    "success": true
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found