v1

latestOpenAPI 3.0.02026-07-24102143224.1 KB

ERP Metadata

Delete ERP metadata

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.

delete/v3/erp-metadata

Request body

entityType'CUSTOMER' | 'INVOICE' | 'INVOICE_LINE_ITEM' required

The entity type for every item in this request. One request handles a single entity type.

Example request

{
  "items": [
    {
      "keys": [
        "department",
        "division"
      ]
    }
  ]
}

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.

successboolean required

Boolean with true=success, false=failure

messagestring required

Plain-text description of the result

Example response

{
  "payload": {
    "items": [
      {
        "removedKeys": [
          "department"
        ]
      }
    ]
  }
}