TikTok Update Product

Update Product

Full Update (Edit Product)

In order to perform full update we will use “Edit Product“ API.

As per the requirements for the GTIN field on TikTok: When we call edit_product API to update a product which already has a GTIN assigned (The field GTIN type -identifier_code & GTIN value - code should be the same as the fields we have pushed when we create a product. They will be saved and will be pushed once we send updates) and we try to change the GTIN, error message should be returned. Once the GTIN has been assigned to an existing product, it can't be changed or deleted!

API Call: PUT /product/202309/products/{product_id}

API Docs: https://partner.tiktokshop.com/docv2/page/6509da7d0fcef602bf1caddf?external_id=6509da7d0fcef602bf1caddf#Back To Top

The {product_id} is what we have stored as Product Account > Channel Item ID

We need to pass the shop_cipher as query property which was obtained with the Get Authorised Shops call found here TikTok - Authentication & Database structure

All triggers, validations etc are as per the abstraction -

Product Listing general requirements

Example call:

{
  "brand_id": "7082427311584347905",
  "category_id": "600001",
  "certifications": [
    {
      "files": [
        {
          "format": "PDF",
          "id": "v09e40f40000cfu0ovhc77ub7fl97k4w",
          "name": "SNI Certificate"
        }
      ],
      "id": "7182427311584347905",
      "images": [
        {
          "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe"
        }
      ]
    }
  ],
  "delivery_option_ids": "1729592969712203232",
  "description": " ",
  "external_product_id": "172959296971220002",
  "is_cod_allowed": false,
  "main_images": [
    {
      "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe"
    }
  ],
  "manufacturer": {
    "address": "123W 106th St, New York, NY, USA, 10025",
    "email": "samplemanufacturer101@outlook.com",
    "name": "Sample Manufacturer Name",
    "phone_number": "4412345678"
  },
  "package_dimensions": {
    "height": "10",
    "length": "10",
    "unit": "CENTIMETER",
    "width": "10"
  },
  "package_weight": {
    "unit": "KILOGRAM",
    "value": "1.32"
  },
  "product_attributes": [
    {
      "id": "100392",
      "values": [
        {
          "id": "1001533",
          "name": "Birthday"
        }
      ]
    }
  ],
  "size_chart": {
    "image": {
      "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe"
    },
    "template": {
      "id": "7267563252536723205"
    }
  },
  "skus": [
    {
      "combined_skus": [
        {
          "product_id": "1729582718312380123",
          "sku_count": 2,
          "sku_id": "2729382476852921560"
        }
      ],
      "external_sku_id": "1729592969712207012",
      "id": "1729592969712207000",
      "identifier_code": {
        "code": "12345678901234",
        "type": "GTIN"
      },
      "inventory": [
        {
          "quantity": 999,
          "warehouse_id": "7068517275539719942"
        }
      ],
      "price": {
        "amount": "1.21",
        "currency": "USD"
      },
      "sales_attributes": [
        {
          "id": "100089",
          "name": "Specification",
          "sku_img": {
            "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe"
          },
          "value_id": "1729592969712401100",
          "value_name": "XL"
        }
      ],
      "seller_sku": "Color-Red-XM001",
      "sku_unit_count": "100.00"
    }
  ],
  "title": "Men's Fashion Sports Low Cut Cotton Breathable Ankle Short Boat Invisible Socks\n",
  "video": {
    "id": "v09e40f40000cfu0ovhc77ub7fl97k4w"
  }
}

Mapping is the same as product create, except when we update product, we need to check if we have all images uploaded and this is done via the TikTok Images table. If images are not uploaded, first we need to wait for the Images Create cron to upload them and then to update the product.

Example response:

{
  "code": 0,
  "data": {
    "product_id": "1729592969712207008",
    "skus": [
      {
        "external_sku_id": "1729592969712207234",
        "id": "1729592969712207012",
        "sales_attributes": [
          {
            "id": "100000",
            "value_id": "1729592969712207123"
          }
        ],
        "seller_sku": "Color-Red-XM001"
      }
    ],
    "warnings": [
      {
        "message": "The [brand_id]:123 field is incorrect and has been automatically cleared by the system. Reason: [Brand does not exist]. You can edit it later."
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}

*Important :** As per additional tests performed, we are able to add new variant to existing product, using Edit Product API call. In order to do this, we should simply not push the SKU IDs. SKU IDs need to be pushed only if we want to update an already existing variant! Also, we need to keep the existing SKU at the same time! If this is not done, not only the old SKU will be deleted, but also the new one will not be successfully added! I.e. all products which are published need to be pushed in Edit Product Call + all variants which are with status awaiting creation + list/update the whole item = pending. Equally, if we do not send any of the variants it will get deleted on the TikTok platform.

<v1.1> Since we can have a closed variant from a variation and if we exclude it from the payload, it will get deleted, which is not correct, we want to create an internal validation and if we have such case where we have a variation and have closed variants but we are trying to push a product for update, we want to block the update and return an internal error across all variants stating that we cannot push an update as we have a closed variant. </v1.1>

<v1.2> How we handle the other protect flags : Product Account > Protect the whole item = Yes - we skip this item and block the update for the whole variation if it is part of a variation for update. We don’t want to store any error, we just skip it. Product Account > Protect Quantity = Yes - we want to skip this item and block an update for the whole variation if it is part of a variation for update. We want to store an error stating that Full update is not possible as we have items that have protect quantity. Product Account > Protect Price = Yes - we want to skip this item and block an update for the whole variation if it is part of a variation for update. We want to store an error stating that Full update is not possible as we have items that have protect price. </v1.2>

Example:

{
    "category_id": "804360",
    "title": "Puma Kids Girls Hoodie",
    "description": "AWESOME comfort all day long",
    "main_images": [
        {
            "uri": "tos-useast2a-i-tulkllf4y5-euttp/134dfc61cc544726ac2a85675d86ecac"
        }
    ],
    "is_cod_open": false,
    "package_dimensions": {
    "height": "11",
    "length": "30",
    "unit": "CENTIMETER",
    "width": "10"
  },
    "package_weight": {
        "value": "0.91",
        "unit": "KILOGRAM"
    },
    "package_width": 185,
    "product_id": "1729401106232151499",
    "skus": [
        {
            "id": "1729401106232217035",
            "original_price": "52.00",
            "sales_attributes": [
                {
                    "id": "100000",
                    "name": "Colour",
                    "value_name": "Purple"
                },
                {
                        "id": "100007",
                        "name": "Size",
                        "value_id": "7278582591966594849",
                        "value_name": "5-6Y"
                    }
                ],
            "identifier_code": {
                        "code": "4065451689439",
                         "type": "EAN"
            },            
            "inventory": [
                {
                    "available_stock": 19,
                    "warehouse_id": "7097151957604779781"
                }
            ],
            "price": {
                "amount": "111.21",
                "currency": "USD"
            }
        },
        // Below is the new variant which is added to the product. The specific here is when we want to add new variant to product, we did not push the SKU_ID.
        {            
            "original_price": "152.00",
            "sales_attributes": [
                {
                    "id": "100000",
                    "name": "Colour",
                    "value_name": "Purple"
                },
                {
                        "id": "100007",
                        "name": "Size",
                        "value_name": "15-16Y"
                    }
                ],
            "identifier_code": {
                        "code": "4065451689441",
                         "type": "EAN"
            },            
            "inventory": [
                {
                    "available_stock": 19,
                    "warehouse_id": "7097151957604779781"
                }
            ],
            "price": {
                "amount": "121.21",
                "currency": "USD"
            }
        }
    ]
}

The successfull response will be with code : 0 and message : Success . If we receive a different code than 0, this means there was an error and we need to store the error. We want to store the error message as per the abstraction Product Listing general requirements :