Common Data Objects
Carton object
Used in carton_details (Save Order) and cartons
(Get Rates):
| Field | Type | Description |
|---|---|---|
id | UUID | Optional, if referencing an existing carton |
type | string | e.g. BOX |
length | number | cm |
breadth | number | cm |
height | number | cm |
weight | number | kg (dead weight) |
quantity | number | Number of cartons of this type |
volumetric_weight | number | kg |
awb | string[] | Populated once booked |
SKU object (order)
Used in sku_details for Save Order /
Update Order:
| Field | Type | Description |
|---|---|---|
id | UUID | Optional, if referencing an existing SKU |
code | string | SKU code |
name | string | SKU name |
channel_code | string | Channel-specific SKU code |
hsn | string | HSN code |
quantity | number | |
cost_price | number | |
price | number | |
mrp | number | |
tax_amount | number | |
taxable_amount | number | |
cgst / cgst_percentage | number | |
sgst / sgst_percentage | number | |
igst / igst_percentage | number | |
cess / cess_percentage | number | |
ean | string |
Price breakdown object
{ "base_price": 850, "fuel_surcharge": 51, "gst": 102, "total": 1003 }