Send or cancel a purchase order

Admin and branch manager. Moves an order to SENT or CANCELLED and writes an audit entry. A status that is neither, or an order already received or cancelled, is refused with 400.

PUT/api/v1/purchase-orders/{purchaseOrderId}/status

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Path parameters

purchaseOrderIdstringrequired

The purchase order being moved.

Request body

requiredapplication/json

statusstringrequired

Responses

200

The new status

idstringrequired

statusstringrequired

400

status is neither SENT nor CANCELLED, the PO is already received, or it is already cancelled

detailstringrequired

401

Not authenticated

detailstringrequired

403

Access forbidden for this role

detailstringrequired

404

PO not found

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

purchaseOrderIdpath*The purchase order being moved.

Bodyapplication/json

statusstring*

Request

curl -X PUT 'http://localhost:8000/api/v1/purchase-orders/string/status' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "status": "string"
}'

const response = await fetch("http://localhost:8000/api/v1/purchase-orders/string/status", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"status\": \"string\"\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/purchase-orders/string/status",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"status\": \"string\"\n}",
)

Response

{
  "id": "string",
  "status": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}