Skip to main content

Common Data Objects

Carton object

Used in carton_details (Save Order) and cartons (Get Rates):

FieldTypeDescription
idUUIDOptional, if referencing an existing carton
typestringe.g. BOX
lengthnumbercm
breadthnumbercm
heightnumbercm
weightnumberkg (dead weight)
quantitynumberNumber of cartons of this type
volumetric_weightnumberkg
awbstring[]Populated once booked

SKU object (order)

Used in sku_details for Save Order / Update Order:

FieldTypeDescription
idUUIDOptional, if referencing an existing SKU
codestringSKU code
namestringSKU name
channel_codestringChannel-specific SKU code
hsnstringHSN code
quantitynumber
cost_pricenumber
pricenumber
mrpnumber
tax_amountnumber
taxable_amountnumber
cgst / cgst_percentagenumber
sgst / sgst_percentagenumber
igst / igst_percentagenumber
cess / cess_percentagenumber
eanstring

Price breakdown object

{ "base_price": 850, "fuel_surcharge": 51, "gst": 102, "total": 1003 }