Import modes

Every item of an import says, in its importMode field, what the WMS should do with it. The mode is required; an item without it is skipped. Reference data supports all five modes, documents all except Match only.

Create only (CREATE_ONLY)

Creates the record if the WMS does not know it yet. If it already exists, nothing changes and the item is reported as Skipped. Use it when your system must never overwrite data in the WMS.

Create or update (UPSERT)

Creates the record, or replaces it with the data you send if it already exists. This is the usual mode for keeping the WMS in step with your system. Add _updateFields to change only the listed fields of an existing record.

Match only (MATCH_ONLY)

Creates or changes nothing. It only links your identifier to a record that already exists in the WMS, found by the fields listed in _key (for example a product with the same code). Use it to connect existing WMS data to your system before the first real exchange. Reference data only; it needs no capability.

Enrich (ENRICHMENT)

Changes only the fields listed in _updateFields of a record that already exists; all other fields stay as they are. Reference data must also send _key, so that the record can be found even before your identifier is linked to it.

Delete (DELETE)

Deletes the record: reference data is marked as deleted, a document is cancelled. Only the external system that owns the record may delete it. Reference data can also be deleted or restored with deleted: true / false in a Create or update item.