Skip to main content

PATCH /v1/orders/{id}/status

Scope

write_shipping

Request parameters

NameInTypeRequiredDescription
idpathintegerrequiredorder_id
Idempotency-Keyheaderstringrequired冪等キー(必須・ADR-010)。UUID v4 推奨。同一キー再送は保存レスポンスを再生
statusbodyenum(partial_shippedshippedre_shipped

Response example

{
"order_id": 0,
"status": "string",
"previous_status": "string"
}

Description

注文の出荷ステータスを遷移する(同期直行・行ロックで原子検証)(write_shipping)

Error response example

{
"error": {
"code": "insufficient_scope",
"message": "requires scope 'read_orders'",
"request_id": "req_01H..."
}
}

Possible errors: 401 / 403 / 404 / 409 / 503