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'\''"
}'
{
  "date": "2022-06-10T07:51:12.510Z",
  "date_created": "2022-03-25T03:17:44.092Z",
  "date_modified": "2022-06-10T07:51:12.510Z",
  "discount": 120,
  "id": "623d3455ec3c4b3548eb4a349",
  "number": 1234,
  "orderStatus": {
    "date": "2022-06-10T07:51:12.510Z",
    "status": "New Order"
  },
  "payment": {
    "amount": 123,
    "currency": "INR",
    "date": "2022-06-10T07:51:12.510Z",
    "method": "pre-paid",
    "status": "success",
    "statusReason": "Transaction failed due to network error",
    "transactionId": 123456
  },
  "products": {
    "CGST": 120,
    "SGST": 100,
    "name": "Test",
    "price": 120,
    "productId": 1234,
    "quantity": 4,
    "sku": 1234,
    "total": 124,
    "variantId": 1234
  },
  "reference": "null",
  "shipping": {
    "address": {
      "city": "Hyderabad",
      "country": "India",
      "email": "john@lightbooks",
      "line1": "7-52/1",
      "line2": "ram nagar",
      "state": "Telangana",
      "zipcode": 500098
    },
    "carrier": "pickrr",
    "countryCode": "IN",
    "date": "2022-06-10T07:51:12.510Z",
    "email": "john@gmail.com",
    "fee": 100,
    "firstName": "John",
    "lastName": "mathews",
    "mobileNumber": 9949891734,
    "trackingId": 123456,
    "weight": 10
  },
  "subtotal": 100,
  "tax": 100,
  "total": 1200
}

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
date
string

The order created date.

date_created
string

Created date

date_modified
string

Modified date

discount
string

The total discount for given order.

id
string

The Order Object ID.

number
string

The Order number.

orderStatus
object
payment
object

The payment details for given order

products
object

The ordered products

reference
string

The Order reference number.

shipping
object

The shipping details for given order

subtotal
string

The order subtotal amount.

tax
string

The total tax for given order.

total
string

The order total amount.