PATCH
/
orders
/
status
/
{orderId}
curl --request PATCH \
  --url https://api.aasaan.shop/api/v1/stores/orders/status/{orderId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "status": "'\''ORDER_PLACED'\'', '\''ACCEPTED'\'', '\''SHIPPED'\'', '\''UNSHIPPED'\'', '\''SENT'\''"
}'
{
  "id": "623d3455ec3c4b3548eb4a349",
  "reference": "<string>",
  "number": 1234,
  "discount": 120,
  "tax": 100,
  "total": 1200,
  "subtotal": 100,
  "date": "2022-06-10T07:51:12.510Z",
  "date_created": "2022-03-25T03:17:44.092Z",
  "date_modified": "2022-06-10T07:51:12.510Z",
  "orderStatus": {
    "status": "New Order",
    "date": "2022-06-10T07:51:12.510Z"
  },
  "products": {
    "productId": 1234,
    "variantId": 1234,
    "name": "Test",
    "sku": 1234,
    "price": 120,
    "CGST": 120,
    "SGST": 100,
    "total": 124,
    "quantity": 4
  },
  "shipping": {
    "firstName": "John",
    "lastName": "mathews",
    "trackingId": 123456,
    "carrier": "pickrr",
    "weight": 10,
    "fee": 100,
    "date": "2022-06-10T07:51:12.510Z",
    "mobileNumber": 9949891734,
    "countryCode": "IN",
    "email": "john@gmail.com",
    "address": {
      "line1": "7-52/1",
      "line2": "ram nagar",
      "city": "Hyderabad",
      "zipcode": 500098,
      "state": "Telangana",
      "country": "India",
      "email": "john@lightbooks"
    }
  },
  "payment": {
    "transactionId": 123456,
    "amount": 123,
    "currency": "INR",
    "method": "pre-paid",
    "date": "2022-06-10T07:51:12.510Z",
    "status": "success",
    "statusReason": "Transaction failed due to network error"
  }
}

Authorizations

x-api-key
string
headerrequired

Path Parameters

orderId
string
required

Order Id

Body

application/json
status
string
required

Order Status

Response

200 - application/json
id
string

The Order Object ID.

reference
string

The Order reference number.

number
string

The Order number.

discount
string

The total discount for given order.

tax
string

The total tax for given order.

total
string

The order total amount.

subtotal
string

The order subtotal amount.

date
string

The order created date.

date_created
string

Created date

date_modified
string

Modified date

orderStatus
object
products
object

The ordered products

shipping
object

The shipping details for given order

payment
object

The payment details for given order