Skip to content

Update Order Status

There are three separate endpoints for updating order statuses, one per context.

Required Scopes

  • edit-orders

Body

Param NameParam TypeDescriptionRequired
statusstringSlug of the target status from the statuses listyes

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

SlugDescription
openOrder is open
closedOrder is closed
processedOrder has been processed
canceled-by-sellerOrder 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

SlugDescription
unfulfilledOrder not yet shipped
processingOrder is being prepared
shippedOrder has been shipped
fulfilledOrder shipped and delivered
canceledShipping 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

SlugDescription
pendingPayment not yet received
paidPayment received
capturedPayment captured
unpaidPayment not received
refundedPayment refunded

Response

[200] OK

json
{
    "status": 200,
    "detail": "Status is successfully updated",
    "meta": []
}

[404] Not Found

json
{
    "status": 0,
    "detail": "order not found",
    "meta": []
}