DeleteProduct

DELETE /product/{store}

Remove a product from this store.

Path parameters

  • store string Required

    Store that lists products.

Query parameters

  • product_id string Required

    ID (platform) of product to cancel.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • connectorResponses array[object]

      Debugging information about API invocation

      Hide connectorResponses attributes Show connectorResponses attributes object
    • 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
      Hide data attributes Show data attributes
      • any other return value.

      • products array[object]
        Hide products attributes Show products attributes object
        • 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

          Hide skus attributes Show skus attributes object
        • 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
        • 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

          Hide images attributes Show images attributes
          • 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.

        • isCombined boolean

          if a product is combined product.

          Default value is false.

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

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

        • shippingCost number(float)

          The shipping cost of current product.

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

        • 行邮税。Chinese version of parcel tax

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

        • 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

        • The categoryId, currently required by TOF

        • components array[object]

          Components in a product

          Hide components attributes Show components attributes object
      • product object
        Hide product attributes Show product attributes
        • 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

          Hide skus attributes Show skus attributes object
        • 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
        • 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

          Hide images attributes Show images attributes
          • 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.

        • isCombined boolean

          if a product is combined product.

          Default value is false.

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

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

        • shippingCost number(float)

          The shipping cost of current product.

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

        • 行邮税。Chinese version of parcel tax

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

        • 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

        • The categoryId, currently required by TOF

        • components array[object]

          Components in a product

          Hide components attributes Show components attributes object
  • 400

    Invalid input

  • 500 application/json

    Couldn't get products.

    Hide response attributes Show response attributes object
    • code integer(int32)
    • message string
    • connectorResponses array[object]

      Debugging information about API invocation

      Hide connectorResponses attributes Show connectorResponses attributes object
    • 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
      Hide data attributes Show data attributes
      • any other return value.

      • products array[object]
        Hide products attributes Show products attributes object
        • 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

          Hide skus attributes Show skus attributes object
        • 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
        • 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

          Hide images attributes Show images attributes
          • 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.

        • isCombined boolean

          if a product is combined product.

          Default value is false.

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

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

        • shippingCost number(float)

          The shipping cost of current product.

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

        • 行邮税。Chinese version of parcel tax

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

        • 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

        • The categoryId, currently required by TOF

        • components array[object]

          Components in a product

          Hide components attributes Show components attributes object
      • product object
        Hide product attributes Show product attributes
        • 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

          Hide skus attributes Show skus attributes object
        • 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
        • 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

          Hide images attributes Show images attributes
          • 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.

        • isCombined boolean

          if a product is combined product.

          Default value is false.

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

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

        • shippingCost number(float)

          The shipping cost of current product.

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

        • 行邮税。Chinese version of parcel tax

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

        • 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

        • The categoryId, currently required by TOF

        • components array[object]

          Components in a product

          Hide components attributes Show components attributes object
DELETE /product/{store}
curl \
 -X DELETE https://nomad.samarkand-global.cn/envoy/product/{store}?product_id=string \
 -H "x-ca-key: $API_KEY"
Response examples (200)
{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "string",
      "mappingName": "GetProductMapping",
      "api": [
        "string"
      ],
      "apiDocLink": "https://open.pinduoduo.com/#/apidocument/port?portId=pdd.goods.commit.detail.get",
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "responseTime": 1000,
  "data": {
    "returnValue": "string",
    "products": [
      {
        "productId": 123456,
        "name": "COLAB Dry Shampoo",
        "nameEn": "COLAB Dry Shampoo",
        "skus": [
          {
            "skuNumber": "SMK123",
            "price": 10,
            "rrp": 8,
            "groupBuyingPrice": 6,
            "cost": 200,
            "images": {
              "ids": [
                "string"
              ],
              "urls": [
                "string"
              ],
              "uploads": [
                "string"
              ]
            },
            "barcode": 55001234567,
            "color": "green",
            "size": "small",
            "quantity": 10,
            "isOnsale": false,
            "netWeight": 30.3,
            "grossWeight": 35.3,
            "shippingCost": 4.2,
            "shippingTime": 7,
            "model": "iPhone XR",
            "spec": "25mm",
            "customsUnitCode": "142, 007, 瓶, ...",
            "customsUnitCodePackage": "142, 011, 140",
            "customsUnitCodeWeight": "035(means 千克, kilogram)",
            "availableStock": 6,
            "warehouseStock": 6,
            "warehouse": "142, 011, 140"
          }
        ],
        "currency": "RMB",
        "massUnit": "Kilogram",
        "timeUnit": "days",
        "barcode": 55001234567,
        "description": "Some nice dry shampoo for when you cant be bothered to shower",
        "price": 7,
        "rrp": 8,
        "groupBuyingPrice": 6,
        "netWeight": 30.3,
        "grossWeight": 35.3,
        "images": {
          "ids": [
            "string"
          ],
          "urls": [
            "string"
          ],
          "uploads": [
            "string"
          ]
        },
        "isOnsale": false,
        "isCombined": false,
        "status": "draft",
        "category": [
          "All",
          "Cloth",
          "Top"
        ],
        "vendor": "Apple",
        "country": "France",
        "shelfLife": 21,
        "createdAt": "2019-03-19T08:57:41.133Z",
        "updatedAt": "2019-03-19T08:57:41.133Z",
        "logisticsMode": "red_auto",
        "shippingCost": 4.2,
        "shippingTime": 7,
        "hsCode": "7606929900",
        "personalPostalArticlesTax": "01000000",
        "ingredient": "Silk",
        "model": "iPhone XR",
        "spec": "25mm",
        "warrantyPeriod": 180,
        "expressType": "string",
        "discount": 0,
        "taxRate": 0,
        "brand": "Nike",
        "storeId": "samarkand.xxx",
        "categoryId": "12345",
        "components": [
          {
            "productId": 123456,
            "skuNumber": "SMK123",
            "barcode": 55001234567,
            "quantity": 10
          }
        ]
      }
    ],
    "product": {
      "productId": 123456,
      "name": "COLAB Dry Shampoo",
      "nameEn": "COLAB Dry Shampoo",
      "skus": [
        {
          "skuNumber": "SMK123",
          "price": 10,
          "rrp": 8,
          "groupBuyingPrice": 6,
          "cost": 200,
          "images": {
            "ids": [
              "string"
            ],
            "urls": [
              "string"
            ],
            "uploads": [
              "string"
            ]
          },
          "barcode": 55001234567,
          "color": "green",
          "size": "small",
          "quantity": 10,
          "isOnsale": false,
          "netWeight": 30.3,
          "grossWeight": 35.3,
          "shippingCost": 4.2,
          "shippingTime": 7,
          "model": "iPhone XR",
          "spec": "25mm",
          "customsUnitCode": "142, 007, 瓶, ...",
          "customsUnitCodePackage": "142, 011, 140",
          "customsUnitCodeWeight": "035(means 千克, kilogram)",
          "availableStock": 6,
          "warehouseStock": 6,
          "warehouse": "142, 011, 140"
        }
      ],
      "currency": "RMB",
      "massUnit": "Kilogram",
      "timeUnit": "days",
      "barcode": 55001234567,
      "description": "Some nice dry shampoo for when you cant be bothered to shower",
      "price": 7,
      "rrp": 8,
      "groupBuyingPrice": 6,
      "netWeight": 30.3,
      "grossWeight": 35.3,
      "images": {
        "ids": [
          "string"
        ],
        "urls": [
          "string"
        ],
        "uploads": [
          "string"
        ]
      },
      "isOnsale": false,
      "isCombined": false,
      "status": "draft",
      "category": [
        "All",
        "Cloth",
        "Top"
      ],
      "vendor": "Apple",
      "country": "France",
      "shelfLife": 21,
      "createdAt": "2019-03-19T08:57:41.133Z",
      "updatedAt": "2019-03-19T08:57:41.133Z",
      "logisticsMode": "red_auto",
      "shippingCost": 4.2,
      "shippingTime": 7,
      "hsCode": "7606929900",
      "personalPostalArticlesTax": "01000000",
      "ingredient": "Silk",
      "model": "iPhone XR",
      "spec": "25mm",
      "warrantyPeriod": 180,
      "expressType": "string",
      "discount": 0,
      "taxRate": 0,
      "brand": "Nike",
      "storeId": "samarkand.xxx",
      "categoryId": "12345",
      "components": [
        {
          "productId": 123456,
          "skuNumber": "SMK123",
          "barcode": 55001234567,
          "quantity": 10
        }
      ]
    },
    "productId": "string"
  }
}
Response examples (500)
{
  "code": 42,
  "message": "string",
  "connectorResponses": [
    {
      "input": "string",
      "mappingName": "GetProductMapping",
      "api": [
        "string"
      ],
      "apiDocLink": "https://open.pinduoduo.com/#/apidocument/port?portId=pdd.goods.commit.detail.get",
      "httpRequestRawData": "-",
      "code": 42,
      "response": "string",
      "responseEn": "string",
      "platform": "youzan",
      "requestCount": 1,
      "responseTime": 1000
    }
  ],
  "responseTime": 1000,
  "data": {
    "returnValue": "string",
    "products": [
      {
        "productId": 123456,
        "name": "COLAB Dry Shampoo",
        "nameEn": "COLAB Dry Shampoo",
        "skus": [
          {
            "skuNumber": "SMK123",
            "price": 10,
            "rrp": 8,
            "groupBuyingPrice": 6,
            "cost": 200,
            "images": {
              "ids": [
                "string"
              ],
              "urls": [
                "string"
              ],
              "uploads": [
                "string"
              ]
            },
            "barcode": 55001234567,
            "color": "green",
            "size": "small",
            "quantity": 10,
            "isOnsale": false,
            "netWeight": 30.3,
            "grossWeight": 35.3,
            "shippingCost": 4.2,
            "shippingTime": 7,
            "model": "iPhone XR",
            "spec": "25mm",
            "customsUnitCode": "142, 007, 瓶, ...",
            "customsUnitCodePackage": "142, 011, 140",
            "customsUnitCodeWeight": "035(means 千克, kilogram)",
            "availableStock": 6,
            "warehouseStock": 6,
            "warehouse": "142, 011, 140"
          }
        ],
        "currency": "RMB",
        "massUnit": "Kilogram",
        "timeUnit": "days",
        "barcode": 55001234567,
        "description": "Some nice dry shampoo for when you cant be bothered to shower",
        "price": 7,
        "rrp": 8,
        "groupBuyingPrice": 6,
        "netWeight": 30.3,
        "grossWeight": 35.3,
        "images": {
          "ids": [
            "string"
          ],
          "urls": [
            "string"
          ],
          "uploads": [
            "string"
          ]
        },
        "isOnsale": false,
        "isCombined": false,
        "status": "draft",
        "category": [
          "All",
          "Cloth",
          "Top"
        ],
        "vendor": "Apple",
        "country": "France",
        "shelfLife": 21,
        "createdAt": "2019-03-19T08:57:41.133Z",
        "updatedAt": "2019-03-19T08:57:41.133Z",
        "logisticsMode": "red_auto",
        "shippingCost": 4.2,
        "shippingTime": 7,
        "hsCode": "7606929900",
        "personalPostalArticlesTax": "01000000",
        "ingredient": "Silk",
        "model": "iPhone XR",
        "spec": "25mm",
        "warrantyPeriod": 180,
        "expressType": "string",
        "discount": 0,
        "taxRate": 0,
        "brand": "Nike",
        "storeId": "samarkand.xxx",
        "categoryId": "12345",
        "components": [
          {
            "productId": 123456,
            "skuNumber": "SMK123",
            "barcode": 55001234567,
            "quantity": 10
          }
        ]
      }
    ],
    "product": {
      "productId": 123456,
      "name": "COLAB Dry Shampoo",
      "nameEn": "COLAB Dry Shampoo",
      "skus": [
        {
          "skuNumber": "SMK123",
          "price": 10,
          "rrp": 8,
          "groupBuyingPrice": 6,
          "cost": 200,
          "images": {
            "ids": [
              "string"
            ],
            "urls": [
              "string"
            ],
            "uploads": [
              "string"
            ]
          },
          "barcode": 55001234567,
          "color": "green",
          "size": "small",
          "quantity": 10,
          "isOnsale": false,
          "netWeight": 30.3,
          "grossWeight": 35.3,
          "shippingCost": 4.2,
          "shippingTime": 7,
          "model": "iPhone XR",
          "spec": "25mm",
          "customsUnitCode": "142, 007, 瓶, ...",
          "customsUnitCodePackage": "142, 011, 140",
          "customsUnitCodeWeight": "035(means 千克, kilogram)",
          "availableStock": 6,
          "warehouseStock": 6,
          "warehouse": "142, 011, 140"
        }
      ],
      "currency": "RMB",
      "massUnit": "Kilogram",
      "timeUnit": "days",
      "barcode": 55001234567,
      "description": "Some nice dry shampoo for when you cant be bothered to shower",
      "price": 7,
      "rrp": 8,
      "groupBuyingPrice": 6,
      "netWeight": 30.3,
      "grossWeight": 35.3,
      "images": {
        "ids": [
          "string"
        ],
        "urls": [
          "string"
        ],
        "uploads": [
          "string"
        ]
      },
      "isOnsale": false,
      "isCombined": false,
      "status": "draft",
      "category": [
        "All",
        "Cloth",
        "Top"
      ],
      "vendor": "Apple",
      "country": "France",
      "shelfLife": 21,
      "createdAt": "2019-03-19T08:57:41.133Z",
      "updatedAt": "2019-03-19T08:57:41.133Z",
      "logisticsMode": "red_auto",
      "shippingCost": 4.2,
      "shippingTime": 7,
      "hsCode": "7606929900",
      "personalPostalArticlesTax": "01000000",
      "ingredient": "Silk",
      "model": "iPhone XR",
      "spec": "25mm",
      "warrantyPeriod": 180,
      "expressType": "string",
      "discount": 0,
      "taxRate": 0,
      "brand": "Nike",
      "storeId": "samarkand.xxx",
      "categoryId": "12345",
      "components": [
        {
          "productId": 123456,
          "skuNumber": "SMK123",
          "barcode": 55001234567,
          "quantity": 10
        }
      ]
    },
    "productId": "string"
  }
}