1. user-order-cancel-delete
ProductA Regrouped
  • user-order-get
    • List all users
      GET
    • List all orders
      GET
    • Get user by ID
      GET
    • Get order by ID
      GET
  • user-order-create
    • Create a new user
      POST
    • Create a new order
      POST
  • user-order-update
    • Update user
      PUT
    • Update order status
      PATCH
  • user-order-cancel-delete
    • Delete user
      DELETE
    • Cancel an order
      POST
  • Schemas
    • ErrorResponse
    • UserResponse
    • OrderResponse
    • CreateUserRequest
    • OrderItem
    • UpdateUserRequest
    • Address
    • UserListResponse
    • CreateOrderRequest
    • UpdateOrderStatusRequest
    • OrderListResponse
  1. user-order-cancel-delete

Cancel an order

Cloud Mock
https://mock.apidog.com/m1/1332400-0-default
Cloud Mock
https://mock.apidog.com/m1/1332400-0-default
POST
/orders/{order-id}/cancel
Cancel an existing order if it hasn't been shipped

Request

Authorization
OAuth 2.0
Authorization Code
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Authorize URL: https://account-service-test-user-pool.auth.us-east-1.amazoncognito.com/oauth2/authorize
Token URL: https://account-service-test-user-pool.auth.us-east-1.amazoncognito.com/oauth2/token
Scopes:
openid-OpenID Connect sign-in
or
Path Params

Body Params application/json

Examples

Responses

🟢200OK
application/json
Order cancelled successfully
Headers

Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://mock.apidog.com/m1/1332400-0-default/orders/ord_abc123def/cancel' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "reason": "Customer requested cancellation"
}'
Response Response Example
200 - Example 1
{
    "orderId": "ord_abc123def",
    "userId": "usr_1a2b3c4d",
    "status": "pending",
    "totalAmount": 1049.99,
    "currency": "USD",
    "items": [
        {
            "orderItemId": "itm_001",
            "productId": "prd_laptop001",
            "quantity": 1,
            "unitPrice": 999.99,
            "subtotal": 999.99
        }
    ],
    "shippingAddress": {
        "street": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94102",
        "country": "US"
    },
    "trackingNumber": "1Z999AA10123456784",
    "createdAt": "2024-01-20T11:00:00Z",
    "updatedAt": "2024-01-20T12:30:00Z"
}
Modified at 2026-07-10 12:05:58
Previous
Delete user
Next
ErrorResponse
Built with