Skip to navigation
Items

Update item external IDs

View as Markdown

Creates or updates the external IDs attached to an item, one entry per sourceType. Use it to link a Tabs item to its counterpart in an ERP (NetSuite, QuickBooks, …) or in a tax provider (Anrok, Avalara, Sphere).

How it works

  • For each entry, if the item has no external ID for that sourceType one is created; if it already has one it is replaced.
  • Source types you leave out of the request are not touched. This endpoint never deletes an external ID.
  • All entries are applied together: if any entry is rejected, none are saved.
  • Each sourceType can appear only once per request.
  • The item must belong to your merchant, otherwise the response is 404.
  • The same externalId can be set on many items. Several items can share one tax provider product ID or ERP ID, so there is no uniqueness check.
  • Requires an API key with write access. Read-only (reporter) keys are rejected.

What externalId holds

  • ERP source types (e.g. NETSUITE, QUICKBOOKS): the item ID in the ERP.
  • Tax provider source types (e.g. ANROK, AVALARA, SPHERE): the item or product ID in the tax provider.

The response lists every external ID now on the item, including those you did not send.

Authentication

Authorizationstring
API Key authentication via header

Path parameters

idstringRequired
Item ID

Request

This endpoint expects an object.
externalIdslist of objectsRequired
External IDs to insert or replace, keyed by sourceType. Source types omitted from the list are left unchanged.

Response

Item external IDs updated. Omitted source types are unchanged.
payloadobject
Response payload, will be empty when success is false
successboolean

Boolean with true=success, false=failure

messagestring

Plain-text description of the result

errorobjectOptional
json element with any error messages or warnings

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error