Skip to content

Close Order

Endpoint: https://api.youcan.shop/orders/{id}/close

Method: PUT

Required Scopes

  • edit-orders

Body

Param NameParam TypeDescriptionRequired
cancel_orderbooleancancel order & return it to stockno

Response

[200] OK

json
{
  "message": "The order closed successfully.",
  "http_code": 200,
  "code": "UPDATED",
  "type": "success",
  "data": null
}

[404] Not Found

json
{
  "status": 404,
  "detail": "Order not found",
  "meta": []
}

[422] Unprocessable Entity — order is already closed

json
{
  "status": 0,
  "detail": "Order #021A is already closed.",
  "meta": []
}