POST v1/bigcity/create

Description

Create a new order. Each line_items entry resolves to EGV or PHYSICAL based on the SKU's product_type in the catalogue (see GET v1/bigcity/rewards). If any line item is PHYSICAL, shipping_address is required. Order status changes after creation (e.g. shipped, delivered) are pushed via the Order Status Webhook rather than returned synchronously.

Headers

Authorization

token generated from v1/customer/auth

Parameters

order_timestamp required, type: datetime

The timestamp which order placed.

order_total required, type: numeric

Total value of the order.

order_items required, type: numeric

Total no of unique items in the order.

line_items required, type: array

order object

shipping_address required if any line item is PHYSICAL, type: object

Recipient and delivery details: recipient_name, phone, address_line1, address_line2 (optional), city, state, pincode, country. Not required when all line items are EGV.

Example Request (mixed EGV + physical cart)

{
  "order_timestamp": "2026-07-06T15:42:36+05:30",
  "order_total": 2499,
  "order_items": 2,
  "line_items": [
    {
      "order_id": "asdsa3432",
      "SKU": "SKU1",
      "qty": 1
    },
    {
      "order_id": "asdsa3432",
      "SKU": "BC-MUG-BLUE-01",
      "qty": 1
    }
  ],
  "shipping_address": {
    "recipient_name": "Kavitha",
    "phone": "98765*****",
    "address_line1": "12 MG Road",
    "address_line2": "",
    "city": "Bengaluru",
    "state": "Karnataka",
    "pincode": "560001",
    "country": "IN"
  }
}

Example Response

{
  "id": 45654654654,
  "order_id": "asdsa3432",
  "state": "success",
  "vouchers": [
    {
      "sku": "SKU1",
      "voucher_code": "BCP123456",
      "pin": "4 charachets / optional*",
      "validity": "2026-08-06"
    }
  ],
  "orders": [
    {
      "sku": "BC-MUG-BLUE-01",
      "order_ref": "BCP-ORD-98213",
      "status": "processing"
    }
  ],
  "redemption_url": "bigcity.in",
  "how_to_avail": "< html content >",
  "terms": "< html content >",
  "note": "Order created successfully.",
  "created_at": "2026-07-06T15:42:36+05:30",
  "updated_at": "2026-07-06T15:42:36+05:30"
}

Status updates for the orders block (e.g. shipped, delivered) are delivered asynchronously via the Order Status Webhook — this response only reflects the initial state at creation time.

Example Of Failure Response

{
  "name": "Unprocessable entity",
  "message": "Validation Failed",
  "code": 37,
  "status": 422,
  "type": "yii\\web\\HttpException"
}