find_order

POST 
/find_order

The merchant sends a request to this endpoint to get the details of an order including the status of the order e.g. 'order_placed', 'order_confirmed', 'refund'.

Request

application/json

Body

required

backd_order_id stringrequired

Responses

200

Order details.

application/json

Schema

Schema

order_total numberrequired
cart_amount numberrequired
tax_amount numberrequired
shipping_amount numberrequired
discount_amount numberrequired
status stringrequired
merchant_order_id stringrequired
merchant_order_status stringrequired
items object[]
Array [
item_id stringrequired
name stringrequired
quantity integerrequired
price numberrequired
]

Example (from schema)

{
  "order_total": 150,
  "cart_amount": 120,
  "tax_amount": 20,
  "shipping_amount": 10,
  "discount_amount": 0,
  "status": "order_placed",
  "merchant_order_id": "12345ABC",
  "merchant_order_status": "confirmed",
  "items": [
    {
      "item_id": "item001",
      "name": "Product Name",
      "quantity": 2,
      "price": 50
    }
  ]
}

Loading...