Nomad Envoy
1.50.0

This is the API descriptor for the Nomad Envoy API, responsible for order operation and product lists. Developed by Samarkand Global in partnership with Youzan, LittleRED, PDD, etc. Read the documentation online at Nomad API Suite.

Install for node with npm install nomad_envoy_cli
Install for python with pip install nomad-envoy-cli

This is the documentation for version 1.50.0 of the API. Last update on Feb 23, 2023.

Base URL

https://nomad.samarkand-global.cn/envoy

Authentication

The API accepts 2 different authentication methods:

Ca key (http_api_key)
Ca stage (http_api_key)

Ca key (http_api_key)

Send an authentication token in the x-ca-key header to authenticate with the API.

Ca stage (http_api_key)

Send an authentication token in the x-ca-stage header to authenticate with the API.

order

Create, retrieve and cancel orders

Operations

GET: /order/{store}
PUT: /order/{store}
POST: /order/{store}
DELETE: /order/{store}

GetOrderByField

GET /order/{store}

Requests a list of orders based on the supplied parameters.

Path parameters

store string Required

ID of the store.

Query parameters

order_id string

Order ref of ERP system.
client_order_ref string

Client order ref of E-commerce platform.
status string

Order status, available options are: WAIT_BUYER_PAY, WAIT_SELLER_SEND_GOODS, WAIT_BUYER_CONFIRM_GOODS, TRADE_SUCCESS, TRADE_CLOSED,TRADE_REFUND, TRADE_FAILED.
type string

Order type, 2 available options: NORMAL, DISTRIBUTION
created_range string

The time range of order creation, use ISO_8601 format here.
updated_range string

The time range of order update, use ISO_8601 format here.
page_no integer(int32)

Page number, between 1 and 1000.
page_size integer(int32)

Page size, options: 1, 10, 50, 100.

Responses

• 200 object

Success
- code integer(int32)
- message string
- connectorResponses array[object]
  
  Debugging information about API invocation
  input string
  
  The input of a NomadMapping, usually it's JSON format.
  
  mappingName string
  
  The name of mapping class.
  
  api array[string]
  
  API path
  
  apiDocLink string
  
  The link of current mapping, usually a url.
  
  httpRequestRawData string
  
  Raw data of current HTTP request to the third party server, easy for debug.
  
  code integer(int32)
  
  response string
  
  responseEn string
  
  platform string
  
  requestCount integer(int32)
  
  The number of requests against the third party in one Nomad request.
  
  responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping. The time unit is millisecond.
- responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping's. The time unit is millisecond. This 'responseTime' is different from the one in ApiResponseConnectorResponse, since our NomadMapping supports spawn mode, whose output will be replaced by its children's instead of its own.
- data object
  returnValue string
  
  any other return value.
  
  orders array[object]
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  order object
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  orderId string
• 400

Invalid input
• 500 object

Couldn't get order.
- code integer(int32)
- message string
- connectorResponses array[object]
  
  Debugging information about API invocation
  input string
  
  The input of a NomadMapping, usually it's JSON format.
  
  mappingName string
  
  The name of mapping class.
  
  api array[string]
  
  API path
  
  apiDocLink string
  
  The link of current mapping, usually a url.
  
  httpRequestRawData string
  
  Raw data of current HTTP request to the third party server, easy for debug.
  
  code integer(int32)
  
  response string
  
  responseEn string
  
  platform string
  
  requestCount integer(int32)
  
  The number of requests against the third party in one Nomad request.
  
  responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping. The time unit is millisecond.
- responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping's. The time unit is millisecond. This 'responseTime' is different from the one in ApiResponseConnectorResponse, since our NomadMapping supports spawn mode, whose output will be replaced by its children's instead of its own.
- data object
  returnValue string
  
  any other return value.
  
  orders array[object]
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  order object
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  orderId string

GET /order/{store}

curl \
 -X GET https://nomad.samarkand-global.cn/envoy/order/samarkand.youzan.test \
 -H "x-ca-key: $API_KEY"

Response example (200)

{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "string",
      "mappingName": "GetProductMapping",
      "api": [
        "string"
      ],
      "apiDocLink": "https://open.pinduoduo.com/#/apidocument/port?portId=pdd.goods.commit.detail.get",
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "responseTime": 1000,
  "data": {
    "returnValue": "string",
    "orders": [
      {
        "orderId": "string",
        "clientOrderRef": "string",
        "clientParentOrderRef": "string",
        "platformTransactionId": "string",
        "platformName": "pdd",
        "isSubOrder": false,
        "isDistributionOrder": false,
        "distributorName": "string",
        "orderType": "DISTRIBUTOR",
        "items": [
          {
            "product": {
              "productId": 123456,
              "name": "COLAB Dry Shampoo",
              "nameEn": "COLAB Dry Shampoo",
              "skus": [
                {
                  "skuNumber": "SMK123",
                  "price": 10,
                  "rrp": 8,
                  "groupBuyingPrice": 6,
                  "cost": 200,
                  "images": {
                    "ids": [
                      "string"
                    ],
                    "urls": [
                      "string"
                    ],
                    "uploads": [
                      "string"
                    ]
                  },
                  "barcode": 55001234567,
                  "color": "green",
                  "size": "small",
                  "quantity": 10,
                  "isOnsale": false,
                  "netWeight": 30.3,
                  "grossWeight": 35.3,
                  "shippingCost": 4.2,
                  "shippingTime": 7,
                  "model": "iPhone XR",
                  "spec": "25mm",
                  "customsUnitCode": "142, 007, 瓶, ...",
                  "customsUnitCodePackage": "142, 011, 140",
                  "customsUnitCodeWeight": "035(means 千克, kilogram)",
                  "availableStock": 6,
                  "warehouseStock": 6,
                  "warehouse": "142, 011, 140"
                }
              ],
              "currency": "RMB",
              "massUnit": "Kilogram",
              "timeUnit": "days",
              "barcode": 55001234567,
              "description": "Some nice dry shampoo for when you cant be bothered to shower",
              "price": 7,
              "rrp": 8,
              "groupBuyingPrice": 6,
              "netWeight": 30.3,
              "grossWeight": 35.3,
              "images": {
                "ids": [
                  "string"
                ],
                "urls": [
                  "string"
                ],
                "uploads": [
                  "string"
                ]
              },
              "isOnsale": false,
              "status": "draft",
              "category": [
                "All",
                "Cloth",
                "Top"
              ],
              "vendor": "Apple",
              "country": "France",
              "shelfLife": 21,
              "createdAt": "2019-03-19T08:57:41.133Z",
              "updatedAt": "2019-03-19T08:57:41.133Z",
              "logisticsMode": "red_auto",
              "shippingCost": 4.2,
              "shippingTime": 7,
              "hsCode": "7606929900",
              "personalPostalArticlesTax": "01000000",
              "ingredient": "Silk",
              "model": "iPhone XR",
              "spec": "25mm",
              "warrantyPeriod": 180,
              "expressType": "string",
              "discount": 0,
              "taxRate": 0,
              "brand": "Nike",
              "storeId": "samarkand.xxx",
              "categoryId": "12345"
            },
            "quantity": 4,
            "price": 10.1,
            "discount": 10.1,
            "tax": 1.2
          }
        ],
        "customer": {
          "firstName": "John",
          "lastName": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zip": "string",
          "tin": "string",
          "phone": "string",
          "countryCode": "string",
          "email": "string",
          "age": 42,
          "gender": "Female",
          "chineseId": "string"
        },
        "customerIdRef": "string",
        "seller": {
          "firstName": "John",
          "lastName": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zip": "string",
          "tin": "string",
          "phone": "string",
          "countryCode": "string",
          "email": "string",
          "age": 42,
          "gender": "Female",
          "chineseId": "string"
        },
        "payer": {
          "firstName": "John",
          "lastName": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zip": "string",
          "tin": "string",
          "phone": "string",
          "countryCode": "string",
          "email": "string",
          "age": 42,
          "gender": "Female",
          "chineseId": "string"
        },
        "status": "string",
        "trackingReference": "string",
        "destinationCode": "string",
        "nodeCode": "string",
        "expressCompany": "string",
        "expressType": "string",
        "currency": "RMB",
        "customsCode": "SH",
        "customsFilingId": "ABCDE29102918171",
        "createdAt": "2019-07-12T13:13:52.004637+01:00",
        "updatedAt": "2019-07-12T13:13:52.004637+01:00",
        "payMethod": "EASIPAY",
        "payMerchantName": "Paypal",
        "payAmount": 611.08,
        "payId": "2014030120394812",
        "paymentPayId": "191028195204000214",
        "paidAt": "2019-07-12T13:13:52.004637+01:00",
        "payCustomsNo": "190401103508000055101002",
        "productsTotalTax": 53.28,
        "shippingCost": 25,
        "shippingTax": 1,
        "nonCashDeductionAmount": 0,
        "insuranceFee": 2.5,
        "customerNote": "This package is very important.",
        "deliverySlipUrl": "string",
        "campaignTrackingData": {
          "cj_event": "test",
          "utm_campaign": "my campaign"
        },
        "discountCode": "string"
      }
    ],
    "order": {
      "orderId": "string",
      "clientOrderRef": "string",
      "clientParentOrderRef": "string",
      "platformTransactionId": "string",
      "platformName": "pdd",
      "isSubOrder": false,
      "isDistributionOrder": false,
      "distributorName": "string",
      "orderType": "DISTRIBUTOR",
      "items": [
        {
          "product": {
            "productId": 123456,
            "name": "COLAB Dry Shampoo",
            "nameEn": "COLAB Dry Shampoo",
            "skus": [
              {
                "skuNumber": "SMK123",
                "price": 10,
                "rrp": 8,
                "groupBuyingPrice": 6,
                "cost": 200,
                "images": {
                  "ids": [
                    "string"
                  ],
                  "urls": [
                    "string"
                  ],
                  "uploads": [
                    "string"
                  ]
                },
                "barcode": 55001234567,
                "color": "green",
                "size": "small",
                "quantity": 10,
                "isOnsale": false,
                "netWeight": 30.3,
                "grossWeight": 35.3,
                "shippingCost": 4.2,
                "shippingTime": 7,
                "model": "iPhone XR",
                "spec": "25mm",
                "customsUnitCode": "142, 007, 瓶, ...",
                "customsUnitCodePackage": "142, 011, 140",
                "customsUnitCodeWeight": "035(means 千克, kilogram)",
                "availableStock": 6,
                "warehouseStock": 6,
                "warehouse": "142, 011, 140"
              }
            ],
            "currency": "RMB",
            "massUnit": "Kilogram",
            "timeUnit": "days",
            "barcode": 55001234567,
            "description": "Some nice dry shampoo for when you cant be bothered to shower",
            "price": 7,
            "rrp": 8,
            "groupBuyingPrice": 6,
            "netWeight": 30.3,
            "grossWeight": 35.3,
            "images": {
              "ids": [
                "string"
              ],
              "urls": [
                "string"
              ],
              "uploads": [
                "string"
              ]
            },
            "isOnsale": false,
            "status": "draft",
            "category": [
              "All",
              "Cloth",
              "Top"
            ],
            "vendor": "Apple",
            "country": "France",
            "shelfLife": 21,
            "createdAt": "2019-03-19T08:57:41.133Z",
            "updatedAt": "2019-03-19T08:57:41.133Z",
            "logisticsMode": "red_auto",
            "shippingCost": 4.2,
            "shippingTime": 7,
            "hsCode": "7606929900",
            "personalPostalArticlesTax": "01000000",
            "ingredient": "Silk",
            "model": "iPhone XR",
            "spec": "25mm",
            "warrantyPeriod": 180,
            "expressType": "string",
            "discount": 0,
            "taxRate": 0,
            "brand": "Nike",
            "storeId": "samarkand.xxx",
            "categoryId": "12345"
          },
          "quantity": 4,
          "price": 10.1,
          "discount": 10.1,
          "tax": 1.2
        }
      ],
      "customer": {
        "firstName": "John",
        "lastName": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string",
        "tin": "string",
        "phone": "string",
        "countryCode": "string",
        "email": "string",
        "age": 42,
        "gender": "Female",
        "chineseId": "string"
      },
      "customerIdRef": "string",
      "seller": {
        "firstName": "John",
        "lastName": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string",
        "tin": "string",
        "phone": "string",
        "countryCode": "string",
        "email": "string",
        "age": 42,
        "gender": "Female",
        "chineseId": "string"
      },
      "payer": {
        "firstName": "John",
        "lastName": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string",
        "tin": "string",
        "phone": "string",
        "countryCode": "string",
        "email": "string",
        "age": 42,
        "gender": "Female",
        "chineseId": "string"
      },
      "status": "string",
      "trackingReference": "string",
      "destinationCode": "string",
      "nodeCode": "string",
      "expressCompany": "string",
      "expressType": "string",
      "currency": "RMB",
      "customsCode": "SH",
      "customsFilingId": "ABCDE29102918171",
      "createdAt": "2019-07-12T13:13:52.004637+01:00",
      "updatedAt": "2019-07-12T13:13:52.004637+01:00",
      "payMethod": "EASIPAY",
      "payMerchantName": "Paypal",
      "payAmount": 611.08,
      "payId": "2014030120394812",
      "paymentPayId": "191028195204000214",
      "paidAt": "2019-07-12T13:13:52.004637+01:00",
      "payCustomsNo": "190401103508000055101002",
      "productsTotalTax": 53.28,
      "shippingCost": 25,
      "shippingTax": 1,
      "nonCashDeductionAmount": 0,
      "insuranceFee": 2.5,
      "customerNote": "This package is very important.",
      "deliverySlipUrl": "string",
      "campaignTrackingData": {
        "cj_event": "test",
        "utm_campaign": "my campaign"
      },
      "discountCode": "string"
    },
    "orderId": "string"
  }
}

Response example (500)

{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "string",
      "mappingName": "GetProductMapping",
      "api": [
        "string"
      ],
      "apiDocLink": "https://open.pinduoduo.com/#/apidocument/port?portId=pdd.goods.commit.detail.get",
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "responseTime": 1000,
  "data": {
    "returnValue": "string",
    "orders": [
      {
        "orderId": "string",
        "clientOrderRef": "string",
        "clientParentOrderRef": "string",
        "platformTransactionId": "string",
        "platformName": "pdd",
        "isSubOrder": false,
        "isDistributionOrder": false,
        "distributorName": "string",
        "orderType": "DISTRIBUTOR",
        "items": [
          {
            "product": {
              "productId": 123456,
              "name": "COLAB Dry Shampoo",
              "nameEn": "COLAB Dry Shampoo",
              "skus": [
                {
                  "skuNumber": "SMK123",
                  "price": 10,
                  "rrp": 8,
                  "groupBuyingPrice": 6,
                  "cost": 200,
                  "images": {
                    "ids": [
                      "string"
                    ],
                    "urls": [
                      "string"
                    ],
                    "uploads": [
                      "string"
                    ]
                  },
                  "barcode": 55001234567,
                  "color": "green",
                  "size": "small",
                  "quantity": 10,
                  "isOnsale": false,
                  "netWeight": 30.3,
                  "grossWeight": 35.3,
                  "shippingCost": 4.2,
                  "shippingTime": 7,
                  "model": "iPhone XR",
                  "spec": "25mm",
                  "customsUnitCode": "142, 007, 瓶, ...",
                  "customsUnitCodePackage": "142, 011, 140",
                  "customsUnitCodeWeight": "035(means 千克, kilogram)",
                  "availableStock": 6,
                  "warehouseStock": 6,
                  "warehouse": "142, 011, 140"
                }
              ],
              "currency": "RMB",
              "massUnit": "Kilogram",
              "timeUnit": "days",
              "barcode": 55001234567,
              "description": "Some nice dry shampoo for when you cant be bothered to shower",
              "price": 7,
              "rrp": 8,
              "groupBuyingPrice": 6,
              "netWeight": 30.3,
              "grossWeight": 35.3,
              "images": {
                "ids": [
                  "string"
                ],
                "urls": [
                  "string"
                ],
                "uploads": [
                  "string"
                ]
              },
              "isOnsale": false,
              "status": "draft",
              "category": [
                "All",
                "Cloth",
                "Top"
              ],
              "vendor": "Apple",
              "country": "France",
              "shelfLife": 21,
              "createdAt": "2019-03-19T08:57:41.133Z",
              "updatedAt": "2019-03-19T08:57:41.133Z",
              "logisticsMode": "red_auto",
              "shippingCost": 4.2,
              "shippingTime": 7,
              "hsCode": "7606929900",
              "personalPostalArticlesTax": "01000000",
              "ingredient": "Silk",
              "model": "iPhone XR",
              "spec": "25mm",
              "warrantyPeriod": 180,
              "expressType": "string",
              "discount": 0,
              "taxRate": 0,
              "brand": "Nike",
              "storeId": "samarkand.xxx",
              "categoryId": "12345"
            },
            "quantity": 4,
            "price": 10.1,
            "discount": 10.1,
            "tax": 1.2
          }
        ],
        "customer": {
          "firstName": "John",
          "lastName": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zip": "string",
          "tin": "string",
          "phone": "string",
          "countryCode": "string",
          "email": "string",
          "age": 42,
          "gender": "Female",
          "chineseId": "string"
        },
        "customerIdRef": "string",
        "seller": {
          "firstName": "John",
          "lastName": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zip": "string",
          "tin": "string",
          "phone": "string",
          "countryCode": "string",
          "email": "string",
          "age": 42,
          "gender": "Female",
          "chineseId": "string"
        },
        "payer": {
          "firstName": "John",
          "lastName": "string",
          "address1": "string",
          "address2": "string",
          "city": "string",
          "state": "string",
          "country": "string",
          "zip": "string",
          "tin": "string",
          "phone": "string",
          "countryCode": "string",
          "email": "string",
          "age": 42,
          "gender": "Female",
          "chineseId": "string"
        },
        "status": "string",
        "trackingReference": "string",
        "destinationCode": "string",
        "nodeCode": "string",
        "expressCompany": "string",
        "expressType": "string",
        "currency": "RMB",
        "customsCode": "SH",
        "customsFilingId": "ABCDE29102918171",
        "createdAt": "2019-07-12T13:13:52.004637+01:00",
        "updatedAt": "2019-07-12T13:13:52.004637+01:00",
        "payMethod": "EASIPAY",
        "payMerchantName": "Paypal",
        "payAmount": 611.08,
        "payId": "2014030120394812",
        "paymentPayId": "191028195204000214",
        "paidAt": "2019-07-12T13:13:52.004637+01:00",
        "payCustomsNo": "190401103508000055101002",
        "productsTotalTax": 53.28,
        "shippingCost": 25,
        "shippingTax": 1,
        "nonCashDeductionAmount": 0,
        "insuranceFee": 2.5,
        "customerNote": "This package is very important.",
        "deliverySlipUrl": "string",
        "campaignTrackingData": {
          "cj_event": "test",
          "utm_campaign": "my campaign"
        },
        "discountCode": "string"
      }
    ],
    "order": {
      "orderId": "string",
      "clientOrderRef": "string",
      "clientParentOrderRef": "string",
      "platformTransactionId": "string",
      "platformName": "pdd",
      "isSubOrder": false,
      "isDistributionOrder": false,
      "distributorName": "string",
      "orderType": "DISTRIBUTOR",
      "items": [
        {
          "product": {
            "productId": 123456,
            "name": "COLAB Dry Shampoo",
            "nameEn": "COLAB Dry Shampoo",
            "skus": [
              {
                "skuNumber": "SMK123",
                "price": 10,
                "rrp": 8,
                "groupBuyingPrice": 6,
                "cost": 200,
                "images": {
                  "ids": [
                    "string"
                  ],
                  "urls": [
                    "string"
                  ],
                  "uploads": [
                    "string"
                  ]
                },
                "barcode": 55001234567,
                "color": "green",
                "size": "small",
                "quantity": 10,
                "isOnsale": false,
                "netWeight": 30.3,
                "grossWeight": 35.3,
                "shippingCost": 4.2,
                "shippingTime": 7,
                "model": "iPhone XR",
                "spec": "25mm",
                "customsUnitCode": "142, 007, 瓶, ...",
                "customsUnitCodePackage": "142, 011, 140",
                "customsUnitCodeWeight": "035(means 千克, kilogram)",
                "availableStock": 6,
                "warehouseStock": 6,
                "warehouse": "142, 011, 140"
              }
            ],
            "currency": "RMB",
            "massUnit": "Kilogram",
            "timeUnit": "days",
            "barcode": 55001234567,
            "description": "Some nice dry shampoo for when you cant be bothered to shower",
            "price": 7,
            "rrp": 8,
            "groupBuyingPrice": 6,
            "netWeight": 30.3,
            "grossWeight": 35.3,
            "images": {
              "ids": [
                "string"
              ],
              "urls": [
                "string"
              ],
              "uploads": [
                "string"
              ]
            },
            "isOnsale": false,
            "status": "draft",
            "category": [
              "All",
              "Cloth",
              "Top"
            ],
            "vendor": "Apple",
            "country": "France",
            "shelfLife": 21,
            "createdAt": "2019-03-19T08:57:41.133Z",
            "updatedAt": "2019-03-19T08:57:41.133Z",
            "logisticsMode": "red_auto",
            "shippingCost": 4.2,
            "shippingTime": 7,
            "hsCode": "7606929900",
            "personalPostalArticlesTax": "01000000",
            "ingredient": "Silk",
            "model": "iPhone XR",
            "spec": "25mm",
            "warrantyPeriod": 180,
            "expressType": "string",
            "discount": 0,
            "taxRate": 0,
            "brand": "Nike",
            "storeId": "samarkand.xxx",
            "categoryId": "12345"
          },
          "quantity": 4,
          "price": 10.1,
          "discount": 10.1,
          "tax": 1.2
        }
      ],
      "customer": {
        "firstName": "John",
        "lastName": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string",
        "tin": "string",
        "phone": "string",
        "countryCode": "string",
        "email": "string",
        "age": 42,
        "gender": "Female",
        "chineseId": "string"
      },
      "customerIdRef": "string",
      "seller": {
        "firstName": "John",
        "lastName": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string",
        "tin": "string",
        "phone": "string",
        "countryCode": "string",
        "email": "string",
        "age": 42,
        "gender": "Female",
        "chineseId": "string"
      },
      "payer": {
        "firstName": "John",
        "lastName": "string",
        "address1": "string",
        "address2": "string",
        "city": "string",
        "state": "string",
        "country": "string",
        "zip": "string",
        "tin": "string",
        "phone": "string",
        "countryCode": "string",
        "email": "string",
        "age": 42,
        "gender": "Female",
        "chineseId": "string"
      },
      "status": "string",
      "trackingReference": "string",
      "destinationCode": "string",
      "nodeCode": "string",
      "expressCompany": "string",
      "expressType": "string",
      "currency": "RMB",
      "customsCode": "SH",
      "customsFilingId": "ABCDE29102918171",
      "createdAt": "2019-07-12T13:13:52.004637+01:00",
      "updatedAt": "2019-07-12T13:13:52.004637+01:00",
      "payMethod": "EASIPAY",
      "payMerchantName": "Paypal",
      "payAmount": 611.08,
      "payId": "2014030120394812",
      "paymentPayId": "191028195204000214",
      "paidAt": "2019-07-12T13:13:52.004637+01:00",
      "payCustomsNo": "190401103508000055101002",
      "productsTotalTax": 53.28,
      "shippingCost": 25,
      "shippingTax": 1,
      "nonCashDeductionAmount": 0,
      "insuranceFee": 2.5,
      "customerNote": "This package is very important.",
      "deliverySlipUrl": "string",
      "campaignTrackingData": {
        "cj_event": "test",
        "utm_campaign": "my campaign"
      },
      "discountCode": "string"
    },
    "orderId": "string"
  }
}

UpdateOrder

PUT /order/{store}

Update the shipping status of an order for this store.

Path parameters

store string Required

ID of the store.

Body Required

Order details

orderId string

Order ref of ERP system.
clientOrderRef string

Client order ref of E-commerce platform.
clientParentOrderRef string

Client parent order ref (E-commerce platform)
platformTransactionId string

Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
platformName string Required

Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
isSubOrder boolean

Declare if current order is a sub order.

Default value is false.
isDistributionOrder boolean

Declare if current order is a distribution order.

Default value is false.
distributorName string

Distributor Name
orderType string

Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER

Default value is DEFAULT.
items array[object]

A product in an order
- product object
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
- quantity integer(int32)
- price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
- discount number(float)
  
  It's unit discount of current product
- tax number(float)
  
  The tax of current product.
customer object

The address that current order will be delivered.
- firstName string
- lastName string
- address1 string
- address2 string
- city string
- state string
- country string
- zip string
- tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
- phone string
- countryCode string
  
  missing
- email string
- age integer(int32)
- gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
- chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
customerIdRef string

The ID of buyer on current E-commerce platform.
seller object

The address that current order will be delivered.
- firstName string
- lastName string
- address1 string
- address2 string
- city string
- state string
- country string
- zip string
- tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
- phone string
- countryCode string
  
  missing
- email string
- age integer(int32)
- gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
- chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
payer object

The address that current order will be delivered.
- firstName string
- lastName string
- address1 string
- address2 string
- city string
- state string
- country string
- zip string
- tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
- phone string
- countryCode string
  
  missing
- email string
- age integer(int32)
- gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
- chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
status string

View valid status at get /order query params
trackingReference string

package tracking reference.
destinationCode string

Proposed by Onion, original Chinese phrase is 三段码.
nodeCode string

Proposed by Onion, original Chinese phrase is 集包地.
expressCompany string

Logistic companies, e.g. STO, Goldjet.
expressType string

BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
currency string Required

The currency used in current order, it makes sense if we declare it explicitly.

Default value is RMB.
customsCode string

海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关

Default value is SH.
customsFilingId string

The filing id that returned from Customs
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 amount of final paid.
payId string

The pay number generated by the eCommerce platform such as Youzan
paymentPayId string

the payment number generated by payment tool such as WeChat Pay
paidAt string

The time when the pay was made. ISO_8601 format
payCustomsNo string

The payment declaration number from customs.
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.
shippingTax number(float)

The shipping tax of current order. If delivery free, just set 0.
nonCashDeductionAmount number(float)

Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
insuranceFee number(float)

The insurance fee of current shipping.
customerNote string

The special note from the buyer.
deliverySlipUrl string

The URL of delivery slip.
campaignTrackingData object
discountCode string

The discount code.

Responses

• 200 object

Success
- code integer(int32)
- message string
- connectorResponses array[object]
  
  Debugging information about API invocation
  input string
  
  The input of a NomadMapping, usually it's JSON format.
  
  mappingName string
  
  The name of mapping class.
  
  api array[string]
  
  API path
  
  apiDocLink string
  
  The link of current mapping, usually a url.
  
  httpRequestRawData string
  
  Raw data of current HTTP request to the third party server, easy for debug.
  
  code integer(int32)
  
  response string
  
  responseEn string
  
  platform string
  
  requestCount integer(int32)
  
  The number of requests against the third party in one Nomad request.
  
  responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping. The time unit is millisecond.
- responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping's. The time unit is millisecond. This 'responseTime' is different from the one in ApiResponseConnectorResponse, since our NomadMapping supports spawn mode, whose output will be replaced by its children's instead of its own.
- data object
  returnValue string
  
  any other return value.
  
  orders array[object]
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  order object
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  orderId string
• 400

Invalid input
• 500 object

Order creation failed.
- code integer(int32)
- message string
- connectorResponses array[object]
  
  Debugging information about API invocation
  input string
  
  The input of a NomadMapping, usually it's JSON format.
  
  mappingName string
  
  The name of mapping class.
  
  api array[string]
  
  API path
  
  apiDocLink string
  
  The link of current mapping, usually a url.
  
  httpRequestRawData string
  
  Raw data of current HTTP request to the third party server, easy for debug.
  
  code integer(int32)
  
  response string
  
  responseEn string
  
  platform string
  
  requestCount integer(int32)
  
  The number of requests against the third party in one Nomad request.
  
  responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping. The time unit is millisecond.
- responseTime integer(int32)
  
  The response time of current NomadMapping request, including sub-NomadMapping's. The time unit is millisecond. This 'responseTime' is different from the one in ApiResponseConnectorResponse, since our NomadMapping supports spawn mode, whose output will be replaced by its children's instead of its own.
- data object
  returnValue string
  
  any other return value.
  
  orders array[object]
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  netWeight number(float)
  
  The default net weight of current product.
  
  grossWeight number(float)
  
  The default gross weight of current product.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  isOnsale boolean
  
  if a product/sku is on sale.
  
  status string
  
  The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'
  
  Default value is draft.
  
  category array[string]
  
  The category of current product, and the platform may or may not require fixed categories data
  
  vendor string
  
  The name of the product vendor
  
  country string
  
  The country of origin.
  
  shelfLife number(float)
  
  How long could we keep current product on the shelf.
  
  createdAt string
  
  The time that when current product was created, and should be ISO 8601 format.
  
  updatedAt string
  
  The time that when the last time current product was updated, and should be ISO 8601 format.
  
  logisticsMode string
  
  logistics mode of current product.
  
  shippingCost number(float)
  
  The shipping cost of current product.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door
  
  hsCode string
  
  The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.
  
  personalPostalArticlesTax string
  
  行邮税。Chinese version of parcel tax
  
  ingredient string
  
  The ingredient of current product.
  
  model string
  
  The model of current product.
  
  spec string
  
  The spec of current product.
  
  warrantyPeriod integer(int32)
  
  The warranty period of current product, time unit is day
  
  Default value is 365.
  
  expressType string
  
  CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
  
  discount number(float)
  
  The default discount price of current product.
  
  taxRate number(float)
  
  The default tax rate of current product.
  
  brand string
  
  The brand name of current product
  
  Default value is Other.
  
  storeId string
  
  The initial store id this product belongs to
  
  categoryId string
  
  The categoryId, currently required by TOF
  
  quantity integer(int32)
  
  price number(float)
  
  It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
  
  discount number(float)
  
  It's unit discount of current product
  
  tax number(float)
  
  The tax of current product.
  
  customer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  customerIdRef string
  
  The ID of buyer on current E-commerce platform.
  
  seller object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  payer object
  
  The address that current order will be delivered.
  
  firstName string
  
  lastName string
  
  address1 string
  
  address2 string
  
  city string
  
  state string
  
  country string
  
  zip string
  
  tin string
  
  Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
  
  phone string
  
  countryCode string
  
  missing
  
  email string
  
  age integer(int32)
  
  gender string
  
  Gender identity.
  
  Values are Female, Male, or Custom.
  
  chineseId string
  
  Chinese ID card. Deprecated, use 'tin' instead.
  
  status string
  
  View valid status at get /order query params
  
  trackingReference string
  
  package tracking reference.
  
  destinationCode string
  
  Proposed by Onion, original Chinese phrase is 三段码.
  
  nodeCode string
  
  Proposed by Onion, original Chinese phrase is 集包地.
  
  expressCompany string
  
  Logistic companies, e.g. STO, Goldjet.
  
  expressType string
  
  BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
  
  currency string Required
  
  The currency used in current order, it makes sense if we declare it explicitly.
  
  Default value is RMB.
  
  customsCode string
  
  海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
  
  Default value is SH.
  
  customsFilingId string
  
  The filing id that returned from Customs
  
  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 amount of final paid.
  
  payId string
  
  The pay number generated by the eCommerce platform such as Youzan
  
  paymentPayId string
  
  the payment number generated by payment tool such as WeChat Pay
  
  paidAt string
  
  The time when the pay was made. ISO_8601 format
  
  payCustomsNo string
  
  The payment declaration number from customs.
  
  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.
  
  shippingTax number(float)
  
  The shipping tax of current order. If delivery free, just set 0.
  
  nonCashDeductionAmount number(float)
  
  Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
  
  insuranceFee number(float)
  
  The insurance fee of current shipping.
  
  customerNote string
  
  The special note from the buyer.
  
  deliverySlipUrl string
  
  The URL of delivery slip.
  
  campaignTrackingData object
  
  discountCode string
  
  The discount code.
  
  order object
  
  orderId string
  
  Order ref of ERP system.
  
  clientOrderRef string
  
  Client order ref of E-commerce platform.
  
  clientParentOrderRef string
  
  Client parent order ref (E-commerce platform)
  
  platformTransactionId string
  
  Client transaction id (E-commerce platform), e.g. PDD for customs purpose payment
  
  platformName string Required
  
  Platform name, available options: pdd, youzan, littleredbook, nomad, douyin, checkout.
  
  isSubOrder boolean
  
  Declare if current order is a sub order.
  
  Default value is false.
  
  isDistributionOrder boolean
  
  Declare if current order is a distribution order.
  
  Default value is false.
  
  distributorName string
  
  Distributor Name
  
  orderType string
  
  Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
  
  Default value is DEFAULT.
  
  items array[object]
  
  A product in an order
  
  product object
  
  productId string
  
  product ID of third parties.
  
  name string
  
  Default name, usually it's Chinese.
  
  nameEn string
  
  English name, should be optional
  
  skus array[object]
  
  all SKU in a product
  
  skuNumber string
  
  price number(float)
  
  The selling price of current SKU.
  
  rrp number(float)
  
  recommended retail price
  
  groupBuyingPrice number(float)
  
  group buying price
  
  cost number(float)
  
  tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
  
  Default value is 0.
  
  images object
  
  Images in a product
  
  ids array[string]
  
  [response] The image ids of that platform.
  
  urls array[string]
  
  [response] The image urls of that platform.
  
  uploads array[string]
  
  [request] Upload one or more images to a specific platform via URL
  
  barcode string
  
  color string
  
  size string
  
  quantity integer
  
  The stock level of current SKU in current product.
  
  isOnsale boolean
  
  netWeight number(float)
  
  The default net weight of current SKU. If not present, then switch back to the default value of product
  
  grossWeight number(float)
  
  The default gross weight of current SKU. If not present, then switch back to the default value of product
  
  shippingCost number(float)
  
  The shipping cost of current SKU. Will overwrite product's.
  
  shippingTime integer
  
  The days that take to ship and deliver to customer's door. Will overwrite product's.
  
  model string
  
  The model of current sku.
  
  spec string
  
  The spec of current sku.
  
  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.
  
  availableStock integer(int32)
  
  The number of available SKUs.
  
  warehouseStock integer(int32)
  
  The number of SKUs in warehouse.
  
  warehouse string
  
  The warehouse where SKUs are stocked.
  
  currency string Required
  
  The currency used in current product, it makes sense if we declare it explicity.
  
  Default value is RMB.
  
  massUnit string Required
  
  weight unit in current product.
  
  Default value is Kilogram.
  
  timeUnit string
  
  time unit in current product.
  
  barcode string
  
  description string
  
  price number(float)
  
  The default selling price of current product.

Nomad Envoy 1.50.0

Body Required

Nomad Envoy
1.50.0