Open-API

Outbound Order Query v2

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.

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

请求参数

Header Params

clientKey

string

required

clientKey

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

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

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

示例代码

Responses

OK(200)

Created(201)

Unauthorized(401)

Forbidden(403)

Not Found(404)

HTTP 状态码: 200

内容格式: JSONapplication/json

No schema defined

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

Last modified: 2 小时前