Raw schema
{
"type": "object",
"properties": {
"order_id": {
"type": "string",
"description": "Your own order reference (any unique string). Optional โ a timestamp-based id is generated if omitted."
},
"order_date": {
"type": "string",
"description": "Order date \"YYYY-MM-DD HH:mm\". Optional โ defaults to now."
},
"pickup_location": {
"type": "string",
"description": "The nickname of a pickup address ALREADY registered in your Shiprocket dashboard (Settings โ Pickup Addresses). Required โ must match exactly. This is where the courier collects the parcel."
},
"billing_customer_name": {
"type": "string",
"description": "Buyer first name."
},
"billing_last_name": {
"type": "string",
"description": "Buyer last name. Optional."
},
"billing_address": {
"type": "string",
"description": "Buyer street address line 1."
},
"billing_address_2": {
"type": "string",
"description": "Buyer street address line 2. Optional."
},
"billing_city": {
"type": "string",
"description": "Buyer city."
},
"billing_pincode": {
"type": "string",
"description": "Buyer 6-digit Indian pincode."
},
"billing_state": {
"type": "string",
"description": "Buyer state (e.g. Maharashtra, Karnataka)."
},
"billing_country": {
"type": "string",
"description": "Buyer country. Default India."
},
"billing_email": {
"type": "string",
"description": "Buyer email."
},
"billing_phone": {
"type": "string",
"description": "Buyer 10-digit phone."
},
"shipping_is_billing": {
"type": "boolean",
"description": "true (default) = ship to the billing address. Set false to provide a separate shipping_* address."
},
"shipping_customer_name": {
"type": "string",
"description": "Shipping recipient name (only if shipping_is_billing=false)."
},
"shipping_address": {
"type": "string",
"description": "Shipping street address (only if shipping_is_billing=false)."
},
"shipping_city": {
"type": "string",
"description": "Shipping city (only if shipping_is_billing=false)."
},
"shipping_pincode": {
"type": "string",
"description": "Shipping pincode (only if shipping_is_billing=false)."
},
"shipping_state": {
"type": "string",
"description": "Shipping state (only if shipping_is_billing=false)."
},
"shipping_country": {
"type": "string",
"description": "Shipping country (only if shipping_is_billing=false). Default India."
},
"shipping_phone": {
"type": "string",
"description": "Shipping phone (only if shipping_is_billing=false)."
},
"order_items": {
"type": "array",
"description": "Line items in the parcel. At least one. Each: { name (required), units (required int), selling_price (required INR), sku (optional) }.",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Product name."
},
"sku": {
"type": "string",
"description": "Stock keeping unit / product code. Optional โ derived from name if omitted."
},
"units": {
"type": "number",
"description": "Quantity (integer >= 1)."
},
"selling_price": {
"type": "number",
"description": "Unit price in INR."
}
},
"required": [
"name",
"units",
"selling_price"
]
}
},
"payment_method": {
"type": "string",
"description": "COD or Prepaid. Required."
},
"sub_total": {
"type": "number",
"description": "Order value in INR (sum of line items). Required. Owner policy headers gate this amount before the order is created."
},
"length": {
"type": "number",
"description": "Parcel length in CENTIMETRES (cm). Required, > 0.5."
},
"breadth": {
"type": "number",
"description": "Parcel breadth in CENTIMETRES (cm). Required, > 0.5."
},
"height": {
"type": "number",
"description": "Parcel height in CENTIMETRES (cm). Required, > 0.5."
},
"weight": {
"type": "number",
"description": "Parcel weight in KILOGRAMS (kg). Required, > 0."
}
},
"required": [
"pickup_location",
"billing_customer_name",
"billing_address",
"billing_city",
"billing_pincode",
"billing_state",
"billing_email",
"billing_phone",
"order_items",
"payment_method",
"sub_total",
"length",
"breadth",
"height",
"weight"
]
}