The Statuses API provides endpoints for managing order status workflows in your system. These endpoints allow you to create, retrieve, update, and delete status options that represent the different stages of an order lifecycle.
https://www.venddor.com.br/api
Access all available order statuses or create a new status.
| Method | Description |
|---|---|
| GET | Retrieve all order statuses |
| POST | Create a new order status |
{
"data": [
{
"id": "status_001",
"name": "New Order",
"description": "Order has been placed but not yet processed",
"color": "#3498db",
"position": 1,
"is_default": true,
"notifications": {
"customer": true,
"admin": true
}
},
{
"id": "status_002",
"name": "Processing",
"description": "Order is being prepared for shipping",
"color": "#f39c12",
"position": 2,
"is_default": false,
"notifications": {
"customer": true,
"admin": false
}
}
],
"meta": {
"total": 6,
"page": 1,
"per_page": 10
}
}
{
"name": "Delivered",
"description": "Order has been successfully delivered to the customer",
"color": "#27ae60",
"position": 4,
"is_default": false,
"notifications": {
"customer": true,
"admin": true
},
"actions": [
"send_thank_you_email",
"request_review"
]
}
position field to control the order in which statuses appear in your application. Lower values will appear first.
Access, update, or delete a specific order status by its ID.
| Parameter | Type | Description |
|---|---|---|
| id* | string | The unique identifier of the status |
| Method | Description |
|---|---|
| GET | Retrieve a specific status |
| PUT | Update a specific status |
| DELETE | Delete a specific status |
{
"name": "Shipped",
"description": "Order has been shipped and is in transit",
"color": "#9b59b6",
"notifications": {
"customer": true,
"admin": false
}
}
| Status Code | Description |
|---|---|
200 OK |
Operation completed successfully |
400 Bad Request |
Invalid request parameters |
404 Not Found |
Status with the specified ID does not exist |
409 Conflict |
Cannot delete a status that is in use by orders |