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.
npm install nomad_envoy_clipip install nomad-envoy-cli This is the documentation for version 1.45.1
of the API. Last update on Nov 18, 2021.
https://nomad.samarkand-global.cn/envoy
Send an authentication token in the
x-ca-key
header
to authenticate with the API.
Customs server calls Nomad to receive the filing result of one order
ID of the store.
Success
Invalid input
The input of a NomadMapping, usually it's JSON format.
The name of mapping class.
API path
The link of current mapping, usually a url.
Raw data of current HTTP request to the third party server, easy for debug.
The number of requests against the third party in one Nomad request.
The response time of current NomadMapping request, including sub-NomadMapping. The time unit is millisecond.
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.
any other return value.
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
Order ID ref (Odoo platform).
Client order ref (third party platform)
Client parent order ref (third party platform)
Client transaction id (third party platform), e.g. PDD for customs purpose payment
platform name, available options: pdd, youzan, littleredbook, nomad.
declare if current order is a sub order.
declare if current order is a distribution order.
Distributor Name
Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
Default value is DEFAULT.
Products in order.
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
It's unit discount of current product
The tax of current product.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
The ID of buyer on current third party platform.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
View valid status at get /order query params
package tracking reference.
Proposed by Onion, original Chinese phrase is 三段码.
Proposed by Onion, original Chinese phrase is 集包地.
Logistic companies, e.g. STO, Goldjet.
BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
The currency used in current order, it makes sense if we declare it explicitly.
Default value is RMB.
海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
Default value is SH.
The filing id that returned from Customs
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The amount of final paid.
The pay number generated by the eCommerce platform such as Youzan
the payment number generated by payment tool such as WeChat Pay
The time when the pay was made. ISO_8601 format
The payment declaration number from customs.
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
The shipping tax of current order. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The insurance fee of current shipping.
The special note from the buyer.
The URL of delivery slip.
Order ID ref (Odoo platform).
Client order ref (third party platform)
Client parent order ref (third party platform)
Client transaction id (third party platform), e.g. PDD for customs purpose payment
platform name, available options: pdd, youzan, littleredbook, nomad.
declare if current order is a sub order.
declare if current order is a distribution order.
Distributor Name
Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
Default value is DEFAULT.
Products in order.
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
It's unit discount of current product
The tax of current product.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
The ID of buyer on current third party platform.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
View valid status at get /order query params
package tracking reference.
Proposed by Onion, original Chinese phrase is 三段码.
Proposed by Onion, original Chinese phrase is 集包地.
Logistic companies, e.g. STO, Goldjet.
BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
The currency used in current order, it makes sense if we declare it explicitly.
Default value is RMB.
海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
Default value is SH.
The filing id that returned from Customs
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The amount of final paid.
The pay number generated by the eCommerce platform such as Youzan
the payment number generated by payment tool such as WeChat Pay
The time when the pay was made. ISO_8601 format
The payment declaration number from customs.
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
The shipping tax of current order. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The insurance fee of current shipping.
The special note from the buyer.
The URL of delivery slip.
Save customs information failed.
The input of a NomadMapping, usually it's JSON format.
The name of mapping class.
API path
The link of current mapping, usually a url.
Raw data of current HTTP request to the third party server, easy for debug.
The number of requests against the third party in one Nomad request.
The response time of current NomadMapping request, including sub-NomadMapping. The time unit is millisecond.
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.
any other return value.
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
Order ID ref (Odoo platform).
Client order ref (third party platform)
Client parent order ref (third party platform)
Client transaction id (third party platform), e.g. PDD for customs purpose payment
platform name, available options: pdd, youzan, littleredbook, nomad.
declare if current order is a sub order.
declare if current order is a distribution order.
Distributor Name
Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
Default value is DEFAULT.
Products in order.
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
It's unit discount of current product
The tax of current product.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
The ID of buyer on current third party platform.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
View valid status at get /order query params
package tracking reference.
Proposed by Onion, original Chinese phrase is 三段码.
Proposed by Onion, original Chinese phrase is 集包地.
Logistic companies, e.g. STO, Goldjet.
BC/BBC. BC means business-customer, BBC means business-business-customer, like distribution sell mode.
The currency used in current order, it makes sense if we declare it explicitly.
Default value is RMB.
海关编号 ZZ:郑州新郑综合保税区；GZ：广州海关；HZ：杭州海关；SH：上海海关
Default value is SH.
The filing id that returned from Customs
The time when current order was created. ISO_8601 format
The time when current order was updated. ISO_8601 format
The amount of final paid.
The pay number generated by the eCommerce platform such as Youzan
the payment number generated by payment tool such as WeChat Pay
The time when the pay was made. ISO_8601 format
The payment declaration number from customs.
The sum tax of all products in current order, including Non-cash deduction amount.
The shipping cost of current order, excluding the shipping cost on each contained products. If delivery free, just set 0.
The shipping tax of current order. If delivery free, just set 0.
Amount that deducted by non-cash, e.g. member points, virtual currency, voucher code, etc.
The insurance fee of current shipping.
The special note from the buyer.
The URL of delivery slip.
Order ID ref (Odoo platform).
Client order ref (third party platform)
Client parent order ref (third party platform)
Client transaction id (third party platform), e.g. PDD for customs purpose payment
platform name, available options: pdd, youzan, littleredbook, nomad.
declare if current order is a sub order.
declare if current order is a distribution order.
Distributor Name
Current order type, could be one of DEFAULT/DISTRIBUTOR/SUPPLIER
Default value is DEFAULT.
Products in order.
product ID of third parties.
Default name, usually it's Chinese.
English name, should be optional
all SKU in a product
The selling price of current SKU.
recommended retail price
group buying price
tax-free sale price, refer to https://www.voyageone.com/docs/api/v1/7_object_models.html#product#priceCost
Default value is 0.
Images in a product
The stock level of current SKU in current product.
The default net weight of current SKU. If not present, then switch back to the default value of product
The default gross weight of current SKU. If not present, then switch back to the default value of product
The shipping cost of current SKU. Will overwrite product's.
The days that take to ship and deliver to customer's door. Will overwrite product's.
The model of current sku.
The spec of current sku.
aka customsUnitCodeSKU. The quantity unit code of current sku for customs purpose. Both Chinese or number are ok.
The quantity unit code customs purpose. Declaration Unit, 申报单位.
The weight unit code for customs purpose.
Default value is 035.
The currency used in current product, it makes sense if we declare it explicity.
Default value is RMB.
weight unit in current product.
Default value is Kilogram.
time unit in current product.
The default selling price of current product.
recommended retail price
group buying price
The default net weight of current product.
The default gross weight of current product.
Images in a product
if a product/sku is on sale.
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.
The category of current product, and the platform may or may not require fixed categories data
The name of the product vendor
The country of origin.
How long could we keep current product on the shelf.
The time that when current product was created, and should be ISO 8601 format.
The time that when the last time current product was updated, and should be ISO 8601 format.
logistics mode of current product.
The shipping cost of current product.
The days that take to ship and deliver to customer's door
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.
行邮税。Chinese version of parcel tax
The ingredient of current product.
The model of current product.
The spec of current product.
The warranty period of current product, time unit is day
Default value is 365.
CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products
The default discount price of current product.
The default tax rate of current product.
The brand name of current product
Default value is Other.
The initial store id this product belongs to
The categoryId, currently required by TOF
It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.
It's unit discount of current product
The tax of current product.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
The ID of buyer on current third party platform.
the address that current order will be delivered.
Taxpayer identification number, including Chinese ID. https://www.gov.uk/hmrc-internal-manuals/international-exchange-of-information/ieim402040
missing
Chinese ID card. Deprecated, use 'tin' instead.
the address that current order will be delivered.