Skip to navigation
Erp Metadata

Delete ERP metadata

View as Markdown

Removes specific metadata keys from the stored ERP metadata for a batch of entities of one type — customers (CUSTOMER), invoices (INVOICE), or invoice line items (INVOICE_LINE_ITEM). Only the keys you list are removed; other keys for the same entity and erpSource are left as-is, and the external id record itself is preserved. Scoped to the authenticated merchant. This clears only the value stored in Tabs — it does NOT blank the field in the ERP, because the sync skips empty/missing values, so a value already synced to the ERP stays put. Idempotent: removing a key that is already absent succeeds. One entityType per request.

Authentication

Authorizationstring
API Key authentication via header

Request

This endpoint expects an object.
entityTypeenumRequired
The entity type for every item in this request. One request handles a single entity type.
Allowed values:
itemslist of objectsRequired
The entities to remove metadata keys from, all of entityType.

Response

Per-item result: removedKeys lists the requested keys that were present and removed, and found indicates whether a stored metadata record existed for that entity and ERP source.

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