Get Order Details - OPEN-API-English

Request

Header Params

x-api-key

string

required

Example:

abc123(认证信息)

Content-Type

string

required

Example:

application/json

Body Params application/json

orderNo

string

required

Order Number

Example

{
    "orderNo": "string"
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://127.0.0.1/v1/saleOrder/findOne' \
--header 'x-api-key: abc123(认证信息)' \
--header 'Content-Type: application/json' \
--data-raw '{
    "orderNo": "string"
}'

Responses

🟢200成功

application/json

Body

code

number

required

Return code 200 is successful

message

string

required

Return message

data

object

required

Order details

orderNo

string

required

Order Number

paidAt

string

required

Payment Time

shipToContact

string

required

Shipment Contact

shipToAddress1

string

required

Shipment Address 1

shipToAddress2

string

required

Shipment Address 2

shipToAddress3

string

required

Shipment Address 3

shipToCity

string

required

City

shipToState

string

required

State

shipToCountry

string

required

Country

shipToPostal

string

required

Zip Code

shipToTelephone

string

required

Shipper Phone Number

warehouseCode

string

required

Warehouse Code

carrierCode

string

required

Carrier Code

thirdPartyAccount

string

required

Third Party Account

currency

string

required

Currency

isSignature

integer

required

Sigh-off? 0 No 1 Yes

isInsure

integer

required

Insured? 0 No 1 Yes

orderStatusEnum

string

required

Order Status--- 'pending': no paid, 'unshipped': has not shipped yet 'approved':has reviewed, 'assigned': has assigned, 'picked': already allocated, 'shipped': has shipped, 'canceled': has canceled,'refunded': has refunded

errorCode

string

required

exceptional state --- 'unexception':No Exception, 'pickingException'：Order Picking Exception, 'addressException'：Shipping address exception, ;cancelException': Order cancel exception, 'trackingException': Tracking exception, 'carrierException': Carrier type exception, 'uploadException'：Attachment upload exception, 'purchaseException': Shipping label purchasing exception

estimatedShippingFee

number

required

Estimated Shipping Cost (Default Currency: USD, Actual Amount Subject to Courier Bill)

productItems

array [object {4}]

required

Items Information

enclosure

array [object {3}]

required

Attachment Information

shipmentPackages

array [object {7}]

required

Shipment information

trackingNo

string

optional

Tracking Number

carrier

string

optional

Carrier Type

erpSku

string

optional

ERPSKU

cost

number

optional

Cost

shipedQuantity

integer

optional

Shipping Quantity

shipmentDate

string

optional

Shipping time

packageFlag

integer

optional

Shipping Type: 0 Actual Package, 1 Shipping Label Information

Example

{
  "statusCode": 200,
  "status": 0,
  "code": 200,
  "message": "获取订单数据成功",
  "data": {
    "orderNo": "111-5714719-6329813",
    "paidAt": "2019-06-20 18:48:42",
    "channelAccount": "accessory2go",
    "shipToContact": "Gabriel Garner",
    "shipToAddress1": "9211 WINDWARD TRCE",
    "shipToAddress2": "",
    "shipToAddress3": "",
    "shipToCity": "SAN ANTONIO",
    "shipToState": "TX",
    "shipToCountry": "US",
    "shipToPostal": "78254-6046",
    "shipToTelephone": " 415-851-9136  28627",
    "warehouseCode": "HF_CA_US",
    "carrierCode": "FEDXG",
    "thirdPartyAccount": "",
    "shipServiceLevel": "Std US D2D Dom",
    "currency": "USD",
    "isSignature": 0,
    "isInsure": 0,
    "errorCode": "unexception",
    "orderStatusEnum": "shipped",
    "productItems": [
      {
        "sku": "P6121A51-C159",
        "quantity": 1,
        "skuAmount": 0.0000,
        "insureAmount": 0.0000
      }
    ],
    "enclosure": [],
    "shipmentPackages": [
      {
        "trackingNo": "788676678675",
        "carrier": "FEDXG",
        "erpSku": "P6121A51-C159",
        "cost": 0.0000,
        "shipedQuantity": 1,
        "shipmentDate": "2019-07-24 03:00:05"
      }
    ]
  }
}