PostCustomsProduct

POST /customs/{region}/product

Register products to Shanghai Customs

Path parameters

  • region string Required

    The region of the customs. e.g. shanghai

Body Required

Product detail

  • 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

  • currency string Required

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

    Default value is RMB.

  • massUnit string Required

    weight unit in current product.

    Default value is Kilogram.

  • timeUnit string

    time unit in current product.

  • barcode string
  • description string
  • price number(float)

    The default selling price of current product.

  • rrp number(float)

    recommended retail price

  • groupBuyingPrice number(float)

    group buying price

  • netWeight number(float)

    The default net weight of current product.

  • grossWeight number(float)

    The default gross weight of current product.

  • images object

    Images in a product

    • ids array[string]

      [response] The image ids of that platform.

    • urls array[string]

      [response] The image urls of that platform.

    • uploads array[string]

      [request] Upload one or more images to a specific platform via URL

  • isOnsale boolean

    if a product/sku is on sale.

  • status string

    The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'

    Default value is draft.

  • category array[string]

    The category of current product, and the platform may or may not require fixed categories data

  • vendor string

    The name of the product vendor

  • country string

    The country of origin.

  • shelfLife number(float)

    How long could we keep current product on the shelf.

  • createdAt string

    The time that when current product was created, and should be ISO 8601 format.

  • updatedAt string

    The time that when the last time current product was updated, and should be ISO 8601 format.

  • logisticsMode string

    logistics mode of current product.

  • shippingCost number(float)

    The shipping cost of current product.

  • shippingTime integer

    The days that take to ship and deliver to customer's door

  • hsCode string

    The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.

  • personalPostalArticlesTax string

    行邮税。Chinese version of parcel tax

  • ingredient string

    The ingredient of current product.

  • model string

    The model of current product.

  • spec string

    The spec of current product.

  • warrantyPeriod integer(int32)

    The warranty period of current product, time unit is day

    Default value is 365.

  • expressType string

    CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products

  • discount number(float)

    The default discount price of current product.

  • taxRate number(float)

    The default tax rate of current product.

  • brand string

    The brand name of current product

    Default value is Other.

  • storeId string

    The initial store id this product belongs to

  • categoryId string

    The categoryId, currently required by TOF

Responses

  • • 200 object

    Success

    • code integer(int32)
    • message string
    • connectorResponses array[object]

      Debugging information about API invocation

    • 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
  • • 400 object

    Invalid input

    • code integer(int32)
    • message string
    • connectorResponses array[object]

      Debugging information about API invocation

    • 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
  • • 500 object

    Save customs information failed.

    • code integer(int32)
    • message string
    • connectorResponses array[object]

      Debugging information about API invocation

    • 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

        • currency string Required

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

          Default value is RMB.

        • massUnit string Required

          weight unit in current product.

          Default value is Kilogram.

        • timeUnit string

          time unit in current product.

        • barcode string
        • description string
        • price number(float)

          The default selling price of current product.

        • rrp number(float)

          recommended retail price

        • groupBuyingPrice number(float)

          group buying price

        • netWeight number(float)

          The default net weight of current product.

        • grossWeight number(float)

          The default gross weight of current product.

        • images object

          Images in a product

          • ids array[string]

            [response] The image ids of that platform.

          • urls array[string]

            [response] The image urls of that platform.

          • uploads array[string]

            [request] Upload one or more images to a specific platform via URL

        • isOnsale boolean

          if a product/sku is on sale.

        • status string

          The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'

          Default value is draft.

        • category array[string]

          The category of current product, and the platform may or may not require fixed categories data

        • vendor string

          The name of the product vendor

        • country string

          The country of origin.

        • shelfLife number(float)

          How long could we keep current product on the shelf.

        • createdAt string

          The time that when current product was created, and should be ISO 8601 format.

        • updatedAt string

          The time that when the last time current product was updated, and should be ISO 8601 format.

        • logisticsMode string

          logistics mode of current product.

        • shippingCost number(float)

          The shipping cost of current product.

        • shippingTime integer

          The days that take to ship and deliver to customer's door

        • hsCode string

          The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.

        • personalPostalArticlesTax string

          行邮税。Chinese version of parcel tax

        • ingredient string

          The ingredient of current product.

        • model string

          The model of current product.

        • spec string

          The spec of current product.

        • warrantyPeriod integer(int32)

          The warranty period of current product, time unit is day

          Default value is 365.

        • expressType string

          CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products

        • discount number(float)

          The default discount price of current product.

        • taxRate number(float)

          The default tax rate of current product.

        • brand string

          The brand name of current product

          Default value is Other.

        • storeId string

          The initial store id this product belongs to

        • categoryId string

          The categoryId, currently required by TOF

      • 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

        • currency string Required

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

          Default value is RMB.

        • massUnit string Required

          weight unit in current product.

          Default value is Kilogram.

        • timeUnit string

          time unit in current product.

        • barcode string
        • description string
        • price number(float)

          The default selling price of current product.

        • rrp number(float)

          recommended retail price

        • groupBuyingPrice number(float)

          group buying price

        • netWeight number(float)

          The default net weight of current product.

        • grossWeight number(float)

          The default gross weight of current product.

        • images object

          Images in a product

          • ids array[string]

            [response] The image ids of that platform.

          • urls array[string]

            [response] The image urls of that platform.

          • uploads array[string]

            [request] Upload one or more images to a specific platform via URL

        • isOnsale boolean

          if a product/sku is on sale.

        • status string

          The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'

          Default value is draft.

        • category array[string]

          The category of current product, and the platform may or may not require fixed categories data

        • vendor string

          The name of the product vendor

        • country string

          The country of origin.

        • shelfLife number(float)

          How long could we keep current product on the shelf.

        • createdAt string

          The time that when current product was created, and should be ISO 8601 format.

        • updatedAt string

          The time that when the last time current product was updated, and should be ISO 8601 format.

        • logisticsMode string

          logistics mode of current product.

        • shippingCost number(float)

          The shipping cost of current product.

        • shippingTime integer

          The days that take to ship and deliver to customer's door

        • hsCode string

          The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.

        • personalPostalArticlesTax string

          行邮税。Chinese version of parcel tax

        • ingredient string

          The ingredient of current product.

        • model string

          The model of current product.

        • spec string

          The spec of current product.

        • warrantyPeriod integer(int32)

          The warranty period of current product, time unit is day

          Default value is 365.

        • expressType string

          CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products

        • discount number(float)

          The default discount price of current product.

        • taxRate number(float)

          The default tax rate of current product.

        • brand string

          The brand name of current product

          Default value is Other.

        • storeId string

          The initial store id this product belongs to

        • categoryId string

          The categoryId, currently required by TOF

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

          Order ref of ERP system.

        • clientOrderRef string

          Client order ref of E-commerce platform.

        • clientParentOrderRef string

          Client parent order ref (E-commerce platform)

        • platformTransactionId string

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

        • platformName string Required

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

        • isSubOrder boolean

          Declare if current order is a sub order.

          Default value is false.

        • isDistributionOrder boolean

          Declare if current order is a distribution order.

          Default value is false.

        • distributorName string

          Distributor Name

        • orderType string

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

          Default value is DEFAULT.

        • items array[object]

          A product in an order

          • product object
            • productId string

              product ID of third parties.

            • name string

              Default name, usually it's Chinese.

            • nameEn string

              English name, should be optional

            • skus array[object]

              all SKU in a product

            • currency string Required

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

              Default value is RMB.

            • massUnit string Required

              weight unit in current product.

              Default value is Kilogram.

            • timeUnit string

              time unit in current product.

            • barcode string
            • description string
            • price number(float)

              The default selling price of current product.

            • rrp number(float)

              recommended retail price

            • groupBuyingPrice number(float)

              group buying price

            • netWeight number(float)

              The default net weight of current product.

            • grossWeight number(float)

              The default gross weight of current product.

            • images object

              Images in a product

              • ids array[string]

                [response] The image ids of that platform.

              • urls array[string]

                [response] The image urls of that platform.

              • uploads array[string]

                [request] Upload one or more images to a specific platform via URL

            • isOnsale boolean

              if a product/sku is on sale.

            • status string

              The status of a product in a store (more like a post) , could be draft/to_check/published/deleted/revoked. This field 'status' has priority over 'is_onsale'

              Default value is draft.

            • category array[string]

              The category of current product, and the platform may or may not require fixed categories data

            • vendor string

              The name of the product vendor

            • country string

              The country of origin.

            • shelfLife number(float)

              How long could we keep current product on the shelf.

            • createdAt string

              The time that when current product was created, and should be ISO 8601 format.

            • updatedAt string

              The time that when the last time current product was updated, and should be ISO 8601 format.

            • logisticsMode string

              logistics mode of current product.

            • shippingCost number(float)

              The shipping cost of current product.

            • shippingTime integer

              The days that take to ship and deliver to customer's door

            • hsCode string

              The Harmonized Commodity Description and Coding System (HS code) of the tariff nomenclature is an international standardised system of names and numbers for the classification of commodities. The HS code system is based on a 6-digit nomenclature.

            • personalPostalArticlesTax string

              行邮税。Chinese version of parcel tax

            • ingredient string

              The ingredient of current product.

            • model string

              The model of current product.

            • spec string

              The spec of current product.

            • warrantyPeriod integer(int32)

              The warranty period of current product, time unit is day

              Default value is 365.

            • expressType string

              CC/BC/BBC. CC for free samples, like Temple Spa free samples; BBC for perfume, like Shay & Blue; BC for other products

            • discount number(float)

              The default discount price of current product.

            • taxRate number(float)

              The default tax rate of current product.

            • brand string

              The brand name of current product

              Default value is Other.

            • storeId string

              The initial store id this product belongs to

            • categoryId string

              The categoryId, currently required by TOF

          • quantity integer(int32)
          • price number(float)

            It's unit price of current product, but not the total price. And it's the sell price exactly, not original or pre-tax.

          • discount number(float)

            It's unit discount of current product

          • tax number(float)

            The tax of current product.

        • customer