Patch updates

Patch updates allow for updating only certain fields within an item. Not all fields are required to be sent with the update. This is different from delta updates that require all fields to be passed for each item that will be updated.

Required fields

When sending a patch update, up to three different files may be included in the archive. The required fields for each of these files may be different:

Items (products)

May be specified as items.csv if using CSV format. Must include id and any field(s) to be updated.

Variations

May be specified as variations.csv if using CSV format. Must include variation_id and item_id and any field(s) to be updated.

Item groups (categories)

May be specified as item_groups.csv if using CSV format. Must include id and any field(s) to be updated.

CSV file naming

The filename should contain these four pieces of information separated by underscores:

  • The API key
  • The section name (usually Products)
  • The string patchdelta or forcepatchdelta
    • Use forcepatchdelta if you want to force deactivation of > 50% of products
  • Or the string patchdeltaignore or forcepatchdeltaignore
    • Use forcepatchdeltaignore if you want to force deactivation of > 50% of products
    • This ignores items and variations in the system that are not in the file or request
  • Or the string patchdeltacreate or forcepatchdeltacreate
    • Use forcepatchdeltacreate if you want to force deactivation of > 50% of products
    • This add items and variations which are in the file or request into the system

Examples

Updating with multiple files: key_7AeGOdJ9BxmKF942_Products_patchdelta_2021-07-30-16-18-00.tar.gz

Updating only the items file: key_7AeGOdJ9BxmKF942_Products_patchdelta_2021-07-30-16-18-00.csv

Force example: key_7AeGOdJ9BxmKF942_Products_forcepatchdelta_2021-07-30-16-18-00.csv