Skip to main content

Update Field Mappings

PUT 
/api/tiktok-shop/integration-instances/:integration_instance_id/mappings

Replace the custom field mappings for this integration instance. The submitted set fully replaces any existing custom mappings; system defaults remain in effect for fields not included. Returns the refreshed effective mappings.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Body fields:

  • mappings (array, required): objects with listing_field (string, required), sku_field (string, required), and parsers (array, required - may be empty).
    • parsers (array, required): zero or more transformations applied in order to the incoming value before it is written to the SKU.io field. May be empty. Each entry is an object with a rule and an args object (not a string):
      • fr — find and replace. args.find (string, required) is the text to match. args.replace (string, optional) is the replacement; omit it or send an empty string to delete the matched text.
      • tl — remove characters from the start. args.count (integer, required, greater than zero). num_chars is accepted as an alias.
      • tr — remove characters from the end. args.count (integer, required, greater than zero). num_chars is accepted as an alias.
      • append — append the value of another field. args.field (string, required) is the field to append (field_name is accepted as an alias). args.separator (string, optional) is placed between the two values. Any other rule, or args missing the keys its rule requires, is rejected with a 422 keyed to mappings.{index}.parsers.{index}.args.

Request​

Responses​

OK

Response Headers
    Content-Type