Nomad Envoy

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.44.1 of the API. Last update on Oct 19, 2021.

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

Authentication

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

Customs

PostCustomsCallback

Customs server calls Nomad to receive the filing result of one order

Path parameters
  • store Required / string

    ID of the store.

Responses
  • • 200 string

    Success

  • • 400 object

    Invalid input

    • code integer(int32)
    • message string
    • connectorResponses array[object]
      • 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.

      • products array[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.

        • currency Required / string

          The currency used in current product, it makes sense if we declare it explicity.

          Default value is RMB.

        • massUnit Required / string

          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

      • 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.

        • currency Required / string

          The currency used in current product, it makes sense if we declare it explicity.

          Default value is RMB.

        • massUnit Required / string

          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

      • productId string
      • orders array[object]
        • orderId string

          Order ID ref (Odoo platform).

        • clientOrderRef string

          Client order ref (third party platform)

        • clientParentOrderRef string

          Client parent order ref (third party platform)

        • platformTransactionId string

          Client transaction id (third party platform), e.g. PDD for customs purpose payment

        • platformName Required / string

          platform name, available options: pdd, youzan, littleredbook, nomad.

        • isSubOrder boolean

          declare if current order is a sub order.

        • isDistributionOrder boolean

          declare if current order is a distribution order.

        • distributorName string

          Distributor Name

        • orderType string

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

          Default value is DEFAULT.

        • items array[object]

          Products in 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.

            • currency Required / string

              The currency used in current product, it makes sense if we declare it explicity.

              Default value is RMB.

            • massUnit Required / string

              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.

        • customerIdRef string

          The ID of buyer on current third party platform.

        • seller object

          the address that current order will be delivered.

        • payer object

          the address that current order will be delivered.

        • 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 Required / string

          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.

        • 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.

      • order object
        • orderId string

          Order ID ref (Odoo platform).

        • clientOrderRef string

          Client order ref (third party platform)

        • clientParentOrderRef string

          Client parent order ref (third party platform)

        • platformTransactionId string

          Client transaction id (third party platform), e.g. PDD for customs purpose payment

        • platformName Required / string

          platform name, available options: pdd, youzan, littleredbook, nomad.

        • isSubOrder boolean

          declare if current order is a sub order.

        • isDistributionOrder boolean

          declare if current order is a distribution order.

        • distributorName string

          Distributor Name

        • orderType string

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

          Default value is DEFAULT.

        • items array[object]

          Products in 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.

            • currency Required / string

              The currency used in current product, it makes sense if we declare it explicity.

              Default value is RMB.

            • massUnit Required / string

              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.

        • customerIdRef string

          The ID of buyer on current third party platform.

        • seller object

          the address that current order will be delivered.

        • payer object

          the address that current order will be delivered.

        • 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 Required / string

          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.

        • 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.

      • orderId string
  • • 500 object

    Save customs information failed.

    • code integer(int32)
    • message string
    • connectorResponses array[object]
      • 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.

      • products array[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.

        • currency Required / string

          The currency used in current product, it makes sense if we declare it explicity.

          Default value is RMB.

        • massUnit Required / string

          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

      • 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.

        • currency Required / string

          The currency used in current product, it makes sense if we declare it explicity.

          Default value is RMB.

        • massUnit Required / string

          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

      • productId string
      • orders array[object]
        • orderId string

          Order ID ref (Odoo platform).

        • clientOrderRef string

          Client order ref (third party platform)

        • clientParentOrderRef string

          Client parent order ref (third party platform)

        • platformTransactionId string

          Client transaction id (third party platform), e.g. PDD for customs purpose payment

        • platformName Required / string

          platform name, available options: pdd, youzan, littleredbook, nomad.

        • isSubOrder boolean

          declare if current order is a sub order.

        • isDistributionOrder boolean

          declare if current order is a distribution order.

        • distributorName string

          Distributor Name

        • orderType string

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

          Default value is DEFAULT.

        • items array[object]

          Products in 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.

            • currency Required / string

              The currency used in current product, it makes sense if we declare it explicity.

              Default value is RMB.

            • massUnit Required / string

              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.

        • customerIdRef string

          The ID of buyer on current third party platform.

        • seller object

          the address that current order will be delivered.

        • payer object

          the address that current order will be delivered.

        • 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 Required / string

          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.

        • 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.

      • order object
        • orderId string

          Order ID ref (Odoo platform).

        • clientOrderRef string

          Client order ref (third party platform)

        • clientParentOrderRef string

          Client parent order ref (third party platform)

        • platformTransactionId string

          Client transaction id (third party platform), e.g. PDD for customs purpose payment

        • platformName Required / string

          platform name, available options: pdd, youzan, littleredbook, nomad.

        • isSubOrder boolean

          declare if current order is a sub order.

        • isDistributionOrder boolean

          declare if current order is a distribution order.

        • distributorName string

          Distributor Name

        • orderType string

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

          Default value is DEFAULT.

        • items array[object]

          Products in 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.

            • currency Required / string

              The currency used in current product, it makes sense if we declare it explicity.

              Default value is RMB.

            • massUnit Required / string

              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