Cancel Order
POST
/v1/orders/{id}/cancel
Request
Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.Example:
Authorization: Bearer ********************Path Params
id
string
required
Header Params
Accept
string
required
Example:
application/json
Request samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-v2.fastpod.net/v1/orders//cancel' \
--header 'Accept: application/json'Responses
🟢200Success
application/json
Body
status
boolean
required
message
string
required
data
object
required
id
string
required
order_type
string
required
reference_id
string
required
order_status
string
required
test_order
boolean
required
item_total
number
required
shipping_total
integer
required
surcharge_total
integer
required
labeling_fee
integer
required
peak_season_surchage
integer
required
order_total
number
required
payment_method
string
required
payment_status
string
required
point_earned
integer
required
point_used
integer
required
quantity_total
integer
required
shipping_method
string
required
rush_production
boolean
required
gift_message
null
required
created_at
string
required
updated_at
string
required
rejected_at
null
required
rejected_status
null
required
cancelled_at
string
required
address
object
required
line_items
array [object {13}]
required
shipments
array[string]
required
label_url
string
required
coupon_code
string
required
discount_total
integer
required
discount_labeling_fee
integer
required
Example
{
"status": true,
"message": "Order cancelled successfully.",
"data": {
"id": "string",
"reference_id": "string",
"order_status": "cancelled",
"test_order": false,
"item_total": 14.4,
"shipping_total": 24,
"surcharge_total": 0,
"order_total": 38.4,
"payment_method": "cash",
"payment_status": "unpaid",
"point_earned": 0,
"point_used": 3840,
"quantity_total": 1,
"shipping_method": "3",
"boost_production": true,
"gift_message": null,
"created_at": "2023-12-07T07:54:35.000000Z",
"updated_at": "2023-12-07T08:29:50.000000Z",
"rejected_at": null,
"rejected_status": null,
"cancelled_at": "2023-12-07T08:29:50.000000Z",
"address": {
"name": "Michael Brown",
"company": "My company",
"email": "michaelbrown@demo.com",
"phone": "(330) 829-0294",
"street1": "3431 Reeves Street",
"street2": null,
"city": "Milwaukee",
"state": "WI",
"country": "US",
"zip": "53202"
},
"line_items": [
{
"id": 100009,
"item_id": "string",
"name": "Line Item 1",
"sku": "UABSTAQUBXL3",
"style": "3001",
"color": "AQUA",
"size": "3XL",
"unit_price": 14,
"quantity": 1,
"point_earned": 1440,
"price": 14.4,
"print_areas": {
"front": "url"
},
"preview_areas": {
"front": "url"
}
}
],
"shipments": []
}
}🟠422Parameter Error
🔴500Server Error
Modified at 2024-01-07 13:14:29