Update a order status.

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 @- <<EOF
{
  "status": "'ORDER_PLACED', 'ACCEPTED', 'SHIPPED', 'UNSHIPPED', 'SENT'"
}
EOF

{
  "id": "623d3455ec3c4b3548eb4a349",
  "reference": null,
  "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": "[email protected]",
    "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"
  }
}

PATCH

orders

status

{orderId}

Update a order status.

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 @- <<EOF
{
  "status": "'ORDER_PLACED', 'ACCEPTED', 'SHIPPED', 'UNSHIPPED', 'SENT'"
}
EOF

{
  "id": "623d3455ec3c4b3548eb4a349",
  "reference": null,
  "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": "[email protected]",
    "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

header

required

Path Parameters

orderId

string

required

Order Id

Body

application/json

status

string

required

Order Status

Example:

"'ORDER_PLACED', 'ACCEPTED', 'SHIPPED', 'UNSHIPPED', 'SENT'"

Response

Get an order by id.

string

The Order Object ID.

Example:

"623d3455ec3c4b3548eb4a349"

reference

string

The Order reference number.

Example:

null

number

string

The Order number.

Example:

1234

discount

string

The total discount for given order.

Example:

120

tax

string

The total tax for given order.

Example:

100

total

string

The order total amount.

Example:

1200

subtotal

string

The order subtotal amount.

Example:

100

date

string

The order created date.

Example:

"2022-06-10T07:51:12.510Z"

date_created

string

Created date

Example:

"2022-03-25T03:17:44.092Z"

date_modified

string

Modified date

Example:

"2022-06-10T07:51:12.510Z"

orderStatus

object

Show child attributes

orderStatus.status

string

Order Status.

Example:

"New Order"

orderStatus.date

string

Order Status date

Example:

"2022-06-10T07:51:12.510Z"

products

object

The ordered products

Show child attributes

products.productId

string

Ordered product Id.

Example:

1234

products.variantId

string

Ordered variant Id.

Example:

1234

products.name

string

Ordered product name.

Example:

"Test"

products.sku

string

Ordered product sku.

Example:

1234

products.price

integer

Ordered product price.

Example:

120

products.CGST

integer

Ordered product cgst.

Example:

120

products.SGST

integer

Ordered product sgst

Example:

100

products.total

string

Ordered product total price.

Example:

124

products.quantity

integer

Ordered product quantity.

Example:

4

shipping

object

The shipping details for given order

Show child attributes

shipping.firstName

string

Customer first name

Example:

"John"

shipping.lastName

string

Customer last name

Example:

"mathews"

shipping.trackingId

string

Shipping tracking id

Example:

123456

shipping.carrier

string

Shipping carrier

Example:

"pickrr"

shipping.weight

string

Shipping weight

Example:

10

shipping.fee

string

Shipping fees

Example:

100

shipping.date

string

Shipping created date

Example:

"2022-06-10T07:51:12.510Z"

shipping.mobileNumber

string

Customer mobile number

Example:

9949891734

shipping.countryCode

string

Shipping country code

Example:

"IN"

shipping.email

string

Customer email

Example:

"[email protected]"

shipping.address

object

Shipping address

Show child attributes

shipping.address.line1

string

Address line 1.

Example:

"7-52/1"

shipping.address.line2

string

Address line 2.

Example:

"ram nagar"

shipping.address.city

string

City name.

Example:

"Hyderabad"

shipping.address.zipcode

string

Zip code.

Example:

500098

shipping.address.state

string

State name.

Example:

"Telangana"

shipping.address.country

string

Country name.

Example:

"India"

shipping.address.email

string

email address.

Example:

"john@lightbooks"

payment

object

The payment details for given order

Show child attributes

payment.transactionId

string

Payment transactionId.

Example:

123456

payment.amount

string

Payment amount.

Example:

123

payment.currency

string

Payment currency.

Example:

"INR"

payment.method

string

Payment method.

Example:

"pre-paid"

payment.date

string

Payment created date.

Example:

"2022-06-10T07:51:12.510Z"

payment.status

string

Payment status.

Example:

"success"

payment.statusReason

string

Payment status reason.

Example:

"Transaction failed due to network error"

Get an order info.Get all channels.

⌘I

GETTING STARTED

WEBHOOKS

Store

Category

Brand

Product

Orders

Channel

Update a order status.

Authorizations

Path Parameters

Body

Response