Endpoint catalog
cancelStorefrontOrder
POST /api/v1/open/storefront/orders/{orderId}/cancellations
POST /api/v1/open/storefront/orders/{orderId}/cancellations
- operationId:
cancelStorefrontOrder - Stability: candidate
- Authentication:
Authorizationheader API Key; required scopes:catalog:read - Idempotency: required
Parameters
| Name | In | Required | Type |
|---|---|---|---|
orderId | path | Yes | string |
Request body
- Required: Yes
- Schema:
#/components/schemas/StorefrontOrderTransitionRequest
Responses and errors
| Status | Description | Schema |
|---|---|---|
200 | Successful response | #/components/schemas/StorefrontOrderCancellationResponse |
400 | Request does not match the public contract | #/components/schemas/PublicErrorResponse |
401 | Authentication failed | #/components/schemas/PublicErrorResponse |
403 | Insufficient authorization scope | #/components/schemas/PublicErrorResponse |
404 | Public resource not found | #/components/schemas/PublicErrorResponse |
409 | Idempotency or state conflict | #/components/schemas/PublicErrorResponse |
429 | Rate limited | #/components/schemas/PublicErrorResponse |
Rate limiting
The spec declares a 429 response.
The Retry-After header is not declared by the spec.
- Top-level shape:
{ data: object }
Success response schema
{
"$ref": "#/components/schemas/StorefrontOrderCancellationResponse"
}
Error response schema
{
"$ref": "#/components/schemas/PublicErrorResponse"
}
Generated from the verified public-only OpenAPI artifact; no speculative request example is provided.