Open-API

Outbound Order Query v2

Sandbox

POST/3pp/outbound/v2/query

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.

此接口为订单信息查询接口，获取订单状态、尾程供应商和尾程单号，以及订单履约费用。
出库前为预估费用，出库后，为真实扣费。

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

object

必需

ebayOrderIdList

array [object {2}]

必需

endTime

string

必需

orderNumberList

array [object {1}]

必需

referenceNumberList

array [object {1}]

必需

startTime

string

必需

messageId

string

必需

timestamp

integer

必需

{
  "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

返回响应

OK(200)

Created(201)

Unauthorized(401)

Forbidden(403)

Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

code

integer <int32>

可选

data

array[object (ExternalOrderResponseDTO) {13}]

可选

autoFulfillmentEF

boolean

必需

Whether the order is EF auto-fulfillment order

示例值:

false

ebayOrderId

string

可选

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

>= 0 字符<= 100 字符

extendedOrderId

string

可选

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

>= 0 字符<= 100 字符

ocid

string

可选

orderCreationTime

string

可选

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

>= 0 字符<= 24 字符

orderNumber

string

必需

Unique order number generated by OCH

>= 0 字符<= 50 字符

orderStatus

string

必需

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 字符<= 50 字符

referenceNumber

string

可选

3pp outbound order number

>= 0 字符<= 100 字符

remark

string

可选

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

serviceRegion

string

必需

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

>= 0 字符<= 50 字符

shippingServiceCode

string

必需

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

>= 0 字符<= 100 字符

orderOutboundTime

string

可选

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

trackingNumberList

array [object {10}]

必需

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}]

可选

code

string

可选

string

可选

message

string

可选

message

string

可选

messageId

string

可选

success

boolean

可选

{
  "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
}

最后修改时间： 2 个月前