cancel_order

POST 
/cancel_order

The merchant sends a request to this endpoint to cancel an order. This can only be done when the order has been placed ('order_placed').

Request

application/json

Body

required

backd_order_id stringrequired

Responses

200

Canceled order details.

application/json

Schema

Schema

data object
Order data returned by post-order management endpoints.
backd_order_id string
create_date string
order_total number
cart_amount number
tax_amount number
shipping_amount number
discount_amount number
status string
merchant_order_id string
merchant_order_status string
Not returned by cancel_order.
shipping object
Name, address, phone, and email for a shipping or billing contact.
name objectrequired
First and last name of a person.
first stringrequired
last stringrequired
company_name stringrequired
address objectrequired
Postal address.
line1 stringrequired
line2 string
Second address line (optional).
city stringrequired
state stringrequired
zipcode stringrequired
country stringrequired
phone_number stringrequired
email stringrequired
billing object
Name, address, phone, and email for a shipping or billing contact.
name objectrequired
First and last name of a person.
first stringrequired
last stringrequired
company_name stringrequired
address objectrequired
Postal address.
line1 stringrequired
line2 string
Second address line (optional).
city stringrequired
state stringrequired
zipcode stringrequired
country stringrequired
phone_number stringrequired
email stringrequired
items object[]
Array [
display_name stringrequired
sku stringrequired
unit_price numberrequired
qty numberrequired
item_image_url string
URL of the item's image (optional).
item_url string
URL of the item's page (optional).
]
refunds object[]
Present on find_order, refund POST, and refund DELETE responses.
Array [
amount number
create_date string
status string
locked_at string
]
message string
status object
type string
code integer
error boolean

Example (from schema)

{
  "data": {
    "backd_order_id": "BO-20260416-0001",
    "create_date": "2026-04-16 10:30:00",
    "order_total": 9150,
    "cart_amount": 9000,
    "tax_amount": 100,
    "shipping_amount": 50,
    "discount_amount": 0,
    "status": "order_placed",
    "merchant_order_id": "JKLMO4321",
    "merchant_order_status": "processing",
    "shipping": {
      "name": {
        "first": "Joe",
        "last": "Doe"
      },
      "company_name": "Big Business",
      "address": {
        "line1": "123 Main St",
        "line2": "Floor 1",
        "city": "Austin",
        "state": "TX",
        "zipcode": "78704",
        "country": "USA"
      },
      "phone_number": "4153334567",
      "email": "joedoe@123fakestreet.com"
    },
    "billing": {
      "name": {
        "first": "Joe",
        "last": "Doe"
      },
      "company_name": "Big Business",
      "address": {
        "line1": "123 Main St",
        "line2": "Floor 1",
        "city": "Austin",
        "state": "TX",
        "zipcode": "78704",
        "country": "USA"
      },
      "phone_number": "4153334567",
      "email": "joedoe@123fakestreet.com"
    },
    "items": [
      {
        "display_name": "MacBook Pro",
        "sku": "ABC-123",
        "unit_price": 3000,
        "qty": 3,
        "item_image_url": "http://merchant.website.com/images/macbook-pro.jpg",
        "item_url": "http://merchant.website.com/products/macbook-pro.html"
      }
    ],
    "refunds": [
      {
        "amount": 50,
        "create_date": "2026-04-15 12:49:46",
        "status": "draft",
        "locked_at": "2026-04-15 22:00:00"
      }
    ]
  },
  "message": "API Backd - Success",
  "status": {
    "type": "success",
    "code": 200
  },
  "error": false
}

Loading...