Integration data types

Every item an external system sends or reads has a data type. The code of the type (for example PRODUCT) goes into the entityType field of an import item and comes back in every change feed event. This page lists all the types and what can be done with each of them.

• Reference data — lists such as products or counterparties. Matched by your own codes; see Building the payload.
• Documents — inbound orders, receipts, shipments and so on.
• Read only — documents that are only created in the WMS; your system can read them but not send them.

The structure of each type is the one of the regular API: the links in each section open the matching operation in Swagger. See Building the payload for how identifiers differ.

Type	Code	Kind	Import	Change feed	Resync
Warehouse	WAREHOUSE	Reference data	yes	—	—
Counterparty	PARTY	Reference data	yes	yes	yes
Product	PRODUCT	Reference data	yes	yes	yes
Product set	PRODUCT_SET	Reference data	yes	yes	yes
Product feature	PRODUCT_FEATURE	Reference data	yes	yes	yes
Product category	PRODUCT_CATEGORY	Reference data	yes	—	yes
Product handling group	PRODUCT_HANDLING_GROUP	Reference data	yes	yes	yes
Attribute	ATTRIBUTE	Reference data	yes	yes	yes
Unit of measure	UNIT_OF_MEASURE	Reference data	yes	—	yes
Pack type	PACK_TYPE	Reference data	yes	—	yes
Pack type set	PACK_TYPE_SET	Reference data	yes	—	yes
Pack type handling group	PACK_TYPE_HANDLING_GROUP	Reference data	yes	yes	yes
Location	LOCATION	Reference data	yes	yes	—
Container type	CONTAINER_TYPE	Reference data	yes	yes	—
Container	CONTAINER	Reference data	yes	yes	yes
Lot tracking policy	LOT_TRACKING_POLICY	Reference data	yes	yes	—
Lot	LOT	Reference data	yes	yes	yes
Barcode	BARCODE	Reference data	yes	—	yes
Inbound order	INBOUND_ORDER	Document	yes	yes	—
Receipt	RECEIPT	Document	yes	yes	—
Outbound order	OUTBOUND_ORDER	Document	yes	yes	—
Opening balance	OPENING_BALANCE	Document	yes	—	—
Shipment	DISPATCH	Document	yes	yes	yes
Returnable container opening balance	RETURNABLE_CONTAINER_OPENING_BALANCE	Document	yes	—	—
Container debt settlement	CONTAINER_DEBT_SETTLEMENT	Document	yes	yes	—
Count	INVENTORY_COUNT	Read only	—	yes	yes
Unplanned picking	UNPLANNED_PICKING	Read only	—	yes	yes

Stock balances are not a data type: they are a query that returns the balances on a date and are never imported or published in the change feed.

Warehouse (WAREHOUSE)

A warehouse. Usually set up in the WMS; an external system mostly matches its own warehouses to the existing ones.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: not published
• What you send: POST /api/v1/topology/warehouses (WarehouseIncomeDto)
• What you read: GET /api/v1/topology/warehouses/{id} (WarehouseResponseFullDto)

The WMS does not publish this type. It reaches your system only as an identifier inside other data.

Counterparty (PARTY)

A counterparty: supplier, customer, carrier or owner of goods.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/party/parties (PartyIncomeDto)
• What you read: GET /api/v1/party/parties/{id} (PartyResponseFullDto)

Product (PRODUCT)

A product (stock item) of the catalogue.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/products (ProductIncomeDto)
• What you read: GET /api/v1/catalog/products/{id} (ProductResponseFullDto)

Product set (PRODUCT_SET)

A set of products handled together.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/product-sets (ProductSetIncomeDto)
• What you read: GET /api/v1/catalog/product-sets/{id} (ProductSetFullDto)

Product feature (PRODUCT_FEATURE)

A feature (variant) of a product, such as size or colour.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/product-features (ProductFeatureIncomeDto)
• What you read: GET /api/v1/catalog/product-features/{id} (ProductFeatureResponseFullDto)

The deleted flag is not supported; use the delete mode instead.

Product category (PRODUCT_CATEGORY)

A category of the product catalogue.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/categories (ProductCategoryIncomeDto)
• What you read: GET /api/v1/catalog/categories/{id} (ProductCategoryFullDto)

Product handling group (PRODUCT_HANDLING_GROUP)

A group of products with the same handling rules.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/product-handling-groups (ProductHandlingGroupIncomeDto)
• What you read: GET /api/v1/catalog/product-handling-groups/{id} (ProductHandlingGroupResponseDto)

Attribute (ATTRIBUTE)

An additional attribute that can be attached to catalogue records.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/attributes (AttributeIncomeDto)
• What you read: GET /api/v1/attributes/{id} (AttributeFullDto)

Unit of measure (UNIT_OF_MEASURE)

A unit of measure.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/units-of-measure (UnitsOfMeasureIncomeDto)
• What you read: GET /api/v1/catalog/units-of-measure/{id} (UnitsOfMeasureResponseFullDto)

Pack type (PACK_TYPE)

A pack type: box, pallet and the like, with its quantity of base units.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/pack-types (PackTypeIncomeDto)
• What you read: GET /api/v1/catalog/pack-types/{id} (PackTypeResponseFullDto)

Pack type set (PACK_TYPE_SET)

A set of pack types used by a product.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/pack-type-sets (PackTypeSetIncomeDto)
• What you read: GET /api/v1/catalog/pack-type-sets/{id} (PackTypeSetResponseDto)

Pack type handling group (PACK_TYPE_HANDLING_GROUP)

A group of pack types with the same handling rules.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/catalog/pack-type-handling-groups (PackTypeHandlingGroupIncomeDto)
• What you read: GET /api/v1/catalog/pack-type-handling-groups/{id} (PackTypeHandlingGroupResponseDto)

Location (LOCATION)

A storage location (cell or zone) of a warehouse.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/topology/locations (LocationIncomeDto)
• What you read: GET /api/v1/topology/locations/{id} (LocationFullDto)

Container type (CONTAINER_TYPE)

A container type: pallet, box, tote and the like.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/inventory/container-types (ContainerTypeIncomeDto)
• What you read: GET /api/v1/inventory/container-types/{id} (ContainerTypeResponseDto)

Container (CONTAINER)

A container identified by its own code.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/inventory/containers (ContainerIncomeDto)
• What you read: GET /api/v1/inventory/containers/{id} (ContainerWithStateDto)

Lot tracking policy (LOT_TRACKING_POLICY)

The rules for tracking lots of a product.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/inventory/lot-tracking-policies (LotTrackingPolicyIncomeDto)
• What you read: GET /api/v1/inventory/lot-tracking-policies/{id} (LotTrackingPolicyDto)

Lot (LOT)

A lot (batch) of a product.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/inventory/lots (LotIncomeDto)
• What you read: GET /api/v1/inventory/lots/{id} (LotResponseFullDto)

Barcode (BARCODE)

A barcode of a product or a pack.

• Kind: Reference data
• Import modes: Create only, Create or update, Match only, Enrich, Delete
• Capability for import: Reference import
• Reading: resync only — changes are not published to the change feed; both need Change feed read
• What you send: POST /api/v1/catalog/barcodes (BarcodeIncomeDto)
• What you read: GET /api/v1/catalog/barcodes/{id} (BarcodeResponseDto)

Changes of this type are not published to the change feed. To pick them up, run a resync of this type.

The WMS identifier of a barcode is a number, not a UUID; {"wmsId": …} for a barcode carries that number as a string.

The deleted flag is not supported; use the delete mode instead.

Inbound order (INBOUND_ORDER)

An inbound order: the goods a warehouse expects to receive.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/inbound/inbound-orders (InboundOrderIncomeDto)
• What you read: GET /api/v1/inbound/inbound-orders/{id} (InboundOrderResponseDto)

Receipt (RECEIPT)

A receipt: the goods actually received.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/inbound/receipts (ReceiptIncomeDto)
• What you read: GET /api/v1/inbound/receipts/{id} (ReceiptFullResponseDto)

Outbound order (OUTBOUND_ORDER)

An outbound order: the goods to pick and ship.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/outbound/outbound-orders (OutboundOrderIncomeDto)
• What you read: GET /api/v1/outbound/outbound-orders/{id} (OutboundOrderResponseDto)

Opening balance (OPENING_BALANCE)

Opening stock balances loaded when the WMS starts to be used.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: not published
• What you send: POST /api/v1/inventory/opening-balances (OpeningBalanceIncomeDto)
• What you read: GET /api/v1/inventory/opening-balances/{id} (OpeningBalanceResponseDto)

The WMS does not publish this type. It reaches your system only as an identifier inside other data.

Shipment (DISPATCH)

A shipment: the goods that actually left the warehouse.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: change feed and resync; both need Change feed read
• What you send: POST /api/v1/outbound/dispatches (DispatchIncomeDto)
• What you read: GET /api/v1/outbound/dispatches/{id} (DispatchFullResponseDto)

Returnable container opening balance (RETURNABLE_CONTAINER_OPENING_BALANCE)

Opening balances of returnable containers held by counterparties.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: not published
• What you send: POST /api/v1/returnable-containers/opening-balances (ReturnableContainerOpeningBalanceIncomeDto)
• What you read: GET /api/v1/returnable-containers/opening-balances/{id} (ReturnableContainerOpeningBalanceResponseDto)

The WMS does not publish this type. It reaches your system only as an identifier inside other data.

Container debt settlement (CONTAINER_DEBT_SETTLEMENT)

A settlement of a counterparty’s debt for returnable containers.

• Kind: Document
• Import modes: Create only, Create or update, Enrich, Delete
• Capability for import: Document import
• Reading: change feed only (resync is not available); both need Change feed read
• What you send: POST /api/v1/returnable-containers/debt-settlements (ContainerDebtSettlementIncomeDto)
• What you read: GET /api/v1/returnable-containers/debt-settlements/{id} (ContainerDebtSettlementResponseDto)

Count (INVENTORY_COUNT)

A count (stocktaking) carried out in the WMS.

• Kind: Read only
• Import modes: not imported
• Reading: change feed and resync; both need Change feed read
• What you read: GET /api/v1/inventory/counts/{id} (InventoryCountFullResponseDto)

Unplanned picking (UNPLANNED_PICKING)

An unplanned picking carried out in the WMS.

• Kind: Read only
• Import modes: not imported
• Reading: change feed and resync; both need Change feed read
• What you read: GET /api/v1/outbound/pickings/{id} (PickingFullResponseDto)