Consumable Types
Retrieve available consumable type definitions. Consumable types define materials used during warehouse operations (e.g., pallets, shrink wrap, labels).
Endpoints Overview
| Method | Endpoint | Description |
|---|---|---|
GET |
/v1/consumable-types |
Get a page of consumable types |
Get Consumable Types Page
Retrieve a paginated list of consumable types.
Endpoint: GET /v1/consumable-types
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
PageIndex |
integer | No | Page number (default: 1) |
PageSize |
integer | No | Items per page (default: 25, max: 500) |
SearchText |
string | No | Filter by consumable type name or code |
Request Example
curl -X GET "https://api.consignlyhq.com/v1/consumable-types?PageIndex=1&PageSize=50" \
-H "Authorization: Bearer ACCESS_TOKEN"
Response Example
{
"index": 1,
"total": 12,
"consumableTypes": [
{
"id": "550e8400-e29b-41d4-a716-446655449000",
"name": "Pallet"
},
{
"id": "550e8400-e29b-41d4-a716-446655449001",
"name": "Shrink Wrap (metres)"
}
]
}
Response Fields
| Field | Type | Description |
|---|---|---|
id |
uuid | Consumable type ID |
name |
string | Consumable type name |
Related Endpoints
- Consignment Consumables - Manage consumables on consignments
- Consignment Import - Create consignments with consumables