Body Required

• dimension object

  Dimensions of package

  Hide dimension attributes Show dimension attributes

  • weight number(float) Deprecated

    The whole package, not just the products. kilogram.

  • height number(float)

    the height of current package. centimetre.

  • length number(float)

    the length of current package. centimetre.

  • width number(float)

    the width of current package. centimetre.

• shipFrom object
  Hide shipFrom attributes Show shipFrom attributes

  • firstName string
  • lastName string
  • address1 string
  • address2 string
  • county string

    The county of current city. 县/区, e.g. 西湖区

  • city string
  • state string
  • country string
  • zip string

    Postal Code / Zip, please set to . if not known

  • tin string

    TIN; The Chinese ID number of current person.

  • phone string
  • countryCode string

    The customs code of country.

  • idCard string

    The Chinese ID number of current person (will be removed since we are using tin).

  • email string
  • company string
  • ecommerceWebsiteUserId string

    The user ID of that e-commerce website.

• shipTo object
  Hide shipTo attributes Show shipTo attributes

  • firstName string
  • lastName string
  • address1 string
  • address2 string
  • county string

    The county of current city. 县/区, e.g. 西湖区

  • city string
  • state string
  • country string
  • zip string

    Postal Code / Zip, please set to . if not known

  • tin string

    TIN; The Chinese ID number of current person.

  • phone string
  • countryCode string

    The customs code of country.

  • idCard string

    The Chinese ID number of current person (will be removed since we are using tin).

  • email string
  • company string
  • ecommerceWebsiteUserId string

    The user ID of that e-commerce website.

• bill object
  Hide bill attributes Show bill attributes

  • firstName string
  • lastName string
  • address1 string
  • address2 string
  • county string

    The county of current city. 县/区, e.g. 西湖区

  • city string
  • state string
  • country string
  • zip string

    Postal Code / Zip, please set to . if not known

  • tin string

    TIN; The Chinese ID number of current person.

  • phone string
  • countryCode string

    The customs code of country.

  • idCard string

    The Chinese ID number of current person (will be removed since we are using tin).

  • email string
  • company string
  • ecommerceWebsiteUserId string

    The user ID of that e-commerce website.

• orderRef string

  Order reference number in ERP application

• sellerOrderRef string

  Order reference number from retailers, e-commerce platform, e.g. Youzan, Little Red

• merchantOrderRef string

  Order reference number from merchant, e.g. WConceput

• trackingReference string Required

  Package tracking reference from logistics company

• orderTime string

  ISO 8601 format, '2019-01-19T18:30:52.442118+00:00' or '2019-01-19T18:30:52+00:00'

• grossWeight number

  Use Kilogram as the basic unit of mass.

• netWeight number

  Use Kilogram as the basic unit of mass.

• totalPrice number(float)

  The total price of this package, not including any discount and tax.

• currency string

  Price makes sense under an explicit currency, available options: RMB, CNY, USD, GBP

  Default value is RMB.

• massUnit string

  weight Unit of measurement

  Default value is Kilogram.

• lengthUnit string

  length Unit of measurement

  Default value is Centimetre.

• domesticDeliveryCompany string

  the domestic delivery vendor, 2 available options: [SF, YTO]

  Default value is SF.

• createdAt string

  The time when current order was created. ISO_8601 format

• updatedAt string

  The time when current order was updated. ISO_8601 format

• payMethod string
• payMerchantName string
• payAmount number(float)

  The actual amount paid for the order.

• payId string

  The payment number generated by eCommerce platform such as Youzan

• paidAt string

  The time when the pay was made. ISO_8601 format

• productsTotalTax number(float)

  The sum tax of all products in current order, including Non-cash deduction amount.

• shippingCost number(float)

  The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.

• nonCashDeductionAmount number(float)

  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.

• customerNote string

  The special note from the buyer.

• cancelReason string

  The cancel reason of current package.

• warehouseCode string

  The code of warehouse for this package

• customerIdRef string

  The ID of buyer on current third party platform.

• insuranceFee number(float)

  The insurance fee of current shipping.

• expressType string

  International logistics express type. BC for 901, 229; CC for 902

• paymentPayId string

  The payment number generated by payment tool such as WeChat Pay

• platformName string

  The e-commerce platform name, available options: youzan, pdd, nomad

  Default value is youzan.

• checkPoint string

  Express route check point, turn on it by input "enable", default is disabled

• service string

  Services provided by logistics companies, such as next_day for Next Day Delivery, sign for Signed Delivery, international for International Delivery and so on.

• expressCompany string

  Logistic companies, e.g. SF, FEDEX.

• items array[object]

  Contents of package

  Hide items attributes Show items attributes

  • name string
  • nameCn string

    The Chinese name of current product item

  • barcode string
  • skuNumber string
  • quantity integer(int32)
  • price number

    The price of this product, not including any discount and tax.

  • tax number

    The tax of this product.

  • discount number

    The discount of this product.

  • brand string
  • quantityUom string
  • hsCode string
  • countryOfOrigin string
  • goldjet object Deprecated
    Hide goldjet attribute Show goldjet attribute

    • goodsPtcode string
  • grossWeight number

    Use Kilogram as the basic unit of mass.

  • netWeight number

    Use Kilogram as the basic unit of mass.

  • customsUnitCode string

    aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.

  • customsUnitCodePackage string

    The quantity unit code customs purpose. Declaration Unit, 申报单位.

  • customsUnitCodeWeight string

    The weight unit code for customs purpose.

    Default value is 035.

  • customsFilingId string

    The returned filing id of current SKU from customs

  • spec string

    The spec of current product.

  • model string

    The model of current product.

  • ingredients string

    The ingredients of current product.

  • customsUnitCodeCn string

    Declaration Unit with Chinese format, 申报单位.

  • countryOfOriginIso string

    Two letters country code

  • declarationElements string

    Customs declaration elements, separate each item with a comma.