Endpoints, Finders, and Commands

The Axacon WMS REST API uses three main endpoint patterns:

1. Entity endpoints
2. Finders
3. Commands

Entity endpoints

Entity endpoints create, retrieve, update, or delete records.

Retrieve one item

GET https://[SERVER]/integration/rest/V1/Item/Item6

Retrieve all items

GET https://[SERVER]/integration/rest/V1/Item?finder=findAll

Delete an item

DELETE https://[SERVER]/integration/rest/V1/Item/Item6

Finders

A finder is a predefined query that retrieves data using business-specific criteria.

Find stock for an item

POST https://[SERVER]/integration/rest/V1/executeFinderInfo/Stock/findByItem

{
  "0": "Item6"
}

Parameter names such as "0" and "1" represent finder parameters in their expected order.

Commands

Commands execute an operation rather than returning a normal entity collection.

Block an item

POST https://[SERVER]/integration/rest/V1/executeCommandInfo/BlockItems

{
  "0": "Item6"
}

Which endpoint type should you use?