Enum Reference

All enumeration types used in the External API.

RestAPIDocumentType

Defines the type of warehouse document. Each type is associated with either a reception or expedition operation.

Value	Operation	Description
`PURCHASE_ORDER`	Reception	Goods received from a supplier purchase order
`CLIENT_RETURN`	Reception	Goods returned by a customer
`WAREHOUSE_TRANSFER_IN`	Reception	Goods received from another warehouse within the organization
`PRODUCTION_RETURN`	Reception	Goods returned from production
`CLIENT_EXPEDITION`	Expedition	Goods shipped to a customer
`SUPPLIER_RETURN`	Expedition	Goods returned to a supplier
`WAREHOUSE_TRANSFER_OUT`	Expedition	Goods sent to another warehouse within the organization
`FACTORY_DELIVER`	Expedition	Goods sent for a production order

Represents the current status of a warehouse document.

Value	Description
`OPEN`	Document created, pending processing by warehouse operators
`SATISFIED`	All lines fully processed (received or shipped)
`CANCELED`	Document cancelled, no further processing possible

Identifies the type of stock movement that caused a change in inventory levels.

Value	Description
`INITIALIZATION`	Initial stock load when setting up the warehouse
`RECEPTION`	Stock added via goods reception
`SHIPPING`	Stock allocated for a shipping order (reserved but not yet dispatched)
`EXPEDITION`	Stock physically shipped/dispatched from the warehouse
`TRANSFER`	Stock moved between locations within the warehouse
`ADJUSTMENT`	Manual stock adjustment (inventory count, damage, correction)
`NA`	Not applicable
`CANCEL`	Cancelled movement (reversal of a previous movement)

Result status of an API call, used in the integration audit trail.

Value	Description
`SUCCESS`	API call completed successfully
`ERROR`	API call failed
`WARNING`	Completed with warnings
`IN_PROGRESS`	Still processing (asynchronous operations)
`CANCELLED`	Call was cancelled
`PARTIAL_SUCCESS`	Some operations succeeded, some failed (batch operations)

Identifies the type of external API operation, used in audit logging to track all API activity.

Value	Description
`CREATE_PRODUCT`	Create a new product
`UPDATE_PRODUCT`	Update an existing product
`GET_PRODUCT`	Retrieve a single product
`GET_ALL_PRODUCTS`	Retrieve all products
`GET_PRODUCT_STOCK`	Retrieve stock levels for a product
`UPDATE_PRODUCT_OBSERVATIONS`	Update product observations
`GET_ALL_EXTERNAL_CODES`	Retrieve all external codes

Value	Description
`GET_RECEPTION_DIFFERENCES`	Retrieve reception quantity differences

Value	Description
`GET_PACKING_BY_DOCUMENT_CODE`	Retrieve packing details by document code
`GET_PACKING_BY_EXTERNAL_CODE`	Retrieve packing details by external code

Value	Description
`CREATE_DELIVERY_POINT`	Create a new delivery point
`UPDATE_DELIVERY_POINT`	Update an existing delivery point
`GET_DELIVERY_POINT`	Retrieve a single delivery point
`GET_ALL_DELIVERY_POINTS`	Retrieve all delivery points