Update Order Status
There are three separate endpoints for updating order statuses, one per context.
Required Scopes
edit-orders
Body
| Param Name | Param Type | Description | Required |
|---|---|---|---|
status | string | Slug of the target status from the statuses list | yes |
If the provided slug does not exist in the statuses list, it will be used as-is as the status label.
PUT /orders/{id}/status — Update General Status
Endpoint: https://api.youcan.shop/orders/{id}/status
Method: PUT
Updates the general order status (status field).
Status Values
| Slug | Description |
|---|---|
open | Order is open |
closed | Order is closed |
processed | Order has been processed |
canceled-by-seller | Order was canceled by the seller |
Response
[200] OK
json
{
"status": 200,
"detail": "Status is successfully updated",
"meta": []
}[404] Not Found
json
{
"status": 0,
"detail": "order not found",
"meta": []
}PUT /orders/{id}/status/shipping — Update Shipping Status
Endpoint: https://api.youcan.shop/orders/{id}/status/shipping
Method: PUT
Updates the shipping status of an order.
Status Values
| Slug | Description |
|---|---|
unfulfilled | Order not yet shipped |
processing | Order is being prepared |
shipped | Order has been shipped |
fulfilled | Order shipped and delivered |
canceled | Shipping canceled |
Response
[200] OK
json
{
"status": 200,
"detail": "Status is successfully updated",
"meta": []
}[404] Not Found
json
{
"status": 0,
"detail": "order not found",
"meta": []
}PUT /orders/{id}/status/payment — Update Payment Status
Endpoint: https://api.youcan.shop/orders/{id}/status/payment
Method: PUT
Updates the payment status of an order.
Status Values
| Slug | Description |
|---|---|
pending | Payment not yet received |
paid | Payment received |
captured | Payment captured |
unpaid | Payment not received |
refunded | Payment refunded |
Response
[200] OK
json
{
"status": 200,
"detail": "Status is successfully updated",
"meta": []
}[404] Not Found
json
{
"status": 0,
"detail": "order not found",
"meta": []
}