Skip to main content

Forward Shipment API

Creates and manifests a forward shipment (create an order and assign to a courier) after successful serviceability validation.

Method: POST Endpoint: /custom/api/v1/forward-order-orchestration

Request Fields

Order, Channel & Carrier

FieldTypeRequiredDescriptionExample
order_idstringYesUnique per orderORDER-49
order_datestringYesYYYY-MM-DD HH:mm2018-05-08 12:23
carrier_idstringOptionalLeave blank for automatic courier assignment based on shipping rulesCARO0ZZQH1H6U

Billing & Shipping

FieldTypeRequiredDescriptionExample
billing_customer_namestringYesFirst nameSaurabh
billing_last_namestringOptionalLast nameJindal
billing_addressstringYesAddress line 1Incubex, Velocity
billing_citystringYesCityBangalore
billing_pincodestringYes6-digit PIN560102
billing_statestringYesStateKarnataka
billing_countrystringYesCountryIndia
billing_emailstringOptionalEmailsaurabh@velocity.in
billing_phonestringYesPhone8860697807
shipping_is_billingbooleanOptionalTrue if shipping same as billingtrue
print_labelbooleanYesAuto-generate labeltrue

Items & Payment

FieldTypeRequiredDescriptionExample
order_items[]arrayYesList of itemssee below
payment_methodenumYesCOD or PREPAIDCOD
sub_totalnumberYesOrder subtotal990
cod_collectiblenumberYesRequired if COD, pass 0 for PREPAID990

Order Item Fields

FieldTypeRequiredDescription
namestringYesItem name
skustringYesSKU code
unitsnumberYesQuantity
selling_pricenumberYesPrice per unit
discountnumberOptionalDiscount amount
taxnumberOptionalTax amount

Dimensions & Warehouse

FieldTypeRequiredDescriptionExample
lengthnumberYesLength in cm100
breadthnumberYesBreadth in cm50
heightnumberYesHeight in cm10
weightnumberYesWeight in kg0.5
pickup_locationstringYesPickup Location NameLucknow Warehouse
warehouse_idstringYesPickup warehouse IDWHYYB5
rto_warehouse_idstringOptionalRTO warehouse ID (if different)MYZUXH

Vendor Details (Optional)

FieldTypeDescription
vendor_details.emailstringVendor email
vendor_details.phonestringVendor phone
vendor_details.namestringVendor name
vendor_details.addressstringAddress
vendor_details.citystringCity
vendor_details.statestringState
vendor_details.countrystringCountry
vendor_details.pin_codestringPIN

Sample Request

curl --location 'https://shazam.velocity.in/custom/api/v1/forward-order-orchestration' \
--header 'Content-Type: application/json' \
--header 'Authorization: DO190JE4z8qD4S7ly6hx9Q' \
--data-raw '{
"order_id": "ORDER-43242",
"order_date": "2018-05-08 12:23",
"carrier_id": "CARO0ZZQH1H6U",
"billing_customer_name": "Saurabh",
"billing_last_name": "Jindal",
"billing_address": "Incubex, Velocity",
"billing_city": "Bangalore",
"billing_pincode": "560102",
"billing_state": "Karnataka",
"billing_country": "India",
"billing_email": "saurabh+123891@velocity.in",
"billing_phone": "8860697807",
"shipping_is_billing": true,
"print_label": true,
"order_items": [
{
"name": "T-shirt Round Neck",
"sku": "t-shirt-round1474",
"units": 2,
"selling_price": 1000,
"discount": 100,
"tax": 10
}
],
"payment_method": "COD",
"sub_total": 990,
"cod_collectible": 990,
"length": 100,
"breadth": 50,
"height": 10,
"weight": 0.5,
"pickup_location": "HomeNew",
"warehouse_id": "WHZWUN",
"rto_warehouse_id": "MYZYN",
"vendor_details": {
"email": "abcdd@abcdd.com",
"phone": "9879879879",
"name": "Coco Cookie",
"address": "Street 1",
"city": "delhi",
"state": "new delhi",
"country": "india",
"pin_code": "110077",
"pickup_location": "HomeNew"
}
}'

Success Response

{
"status": 1,
"payload": {
"pickup_location_added": 1,
"order_created": 1,
"awb_generated": 1,
"label_generated": 1,
"pickup_generated": 1,
"manifest_generated": 0,
"pickup_scheduled_date": null,
"pickup_booked_date": null,
"order_id": "ORDKDKHOFL07I",
"shipment_id": "SHIHB0BMT4DYM",
"awb_code": "34812010700125",
"courier_company_id": "CARO0ZZQH1H6U",
"courier_name": "Delhivery Standard",
"assigned_date_time": {
"date": "2025-09-30T17:50:50.424+05:30",
"timezone_type": 3,
"timezone": "Asia/Kolkata"
},
"applied_weight": 0.5,
"cod": 1,
"label_url": "https://velocity-shazam-prod.s3.ap-south-1.amazonaws.com/...",
"manifest_url": null,
"routing_code": null,
"rto_routing_code": null,
"pickup_token_number": null,
"charges": {
"frwd_charges": {
"shipping_charges": "44.40",
"cod_charges": "31.30",
"dead_weight_billing": true
},
"rto_charges": {
"rto_charges": "40.00"
}
}
}
}

Create Order and Shipment Separately

Velocity Shipping allows you to create an order without assigning a courier and assign the courier later.

Step 1: Create Order Only

Endpoint: /custom/api/v1/forward-order

curl --location 'https://shazam.velocity.in/custom/api/v1/forward-order' \
--header 'Authorization: Iu9npoZf8PWpvIIBeMZXWQ' \
--header 'Content-Type: application/json' \
--data-raw '{
"order_id": "ORDER-0099iyhih",
"order_date": "2018-05-08 12:23",
"billing_customer_name": "Saurabh",
"billing_address": "Incubex, Velocity",
"billing_city": "Bangalore",
"billing_pincode": "560102",
"billing_state": "Karnataka",
"billing_country": "India",
"billing_phone": "8860697807",
"shipping_is_billing": true,
"print_label": true,
"order_items": [
{
"name": "T-shirt Round Neck",
"sku": "t-shirt-round1474",
"units": 2,
"selling_price": 1000
}
],
"payment_method": "COD",
"sub_total": 990,
"cod_collectible": 990,
"length": 100,
"breadth": 50,
"height": 10,
"weight": 0.50,
"pickup_location": "HomeNew",
"warehouse_id": "WHYYB5"
}'

Response: (No courier assigned yet)

{
"status": 1,
"payload": {
"pickup_location_added": 1,
"order_created": 1,
"awb_generated": 0,
"pickup_generated": 0,
"shipment_id": "SHIXRE1ER7BQI",
"order_id": "ORDBJSDAMG9YN"
}
}

Step 2: Assign Courier (Create Shipment)

Endpoint: /custom/api/v1/forward-order-shipment

curl --location 'https://shazam.velocity.in/custom/api/v1/forward-order-shipment' \
--header 'Authorization: RJShHQFn_YuXsMzfZb9-1A' \
--header 'Content-Type: application/json' \
--data '{
"shipment_id": "SHIXRE1ER7BQI",
"carrier_id": ""
}'

Response: (Courier now assigned)

{
"status": 1,
"payload": {
"awb_generated": 1,
"label_generated": 1,
"pickup_generated": 1,
"awb_code": "34812010700125",
"courier_name": "Delhivery Standard",
"label_url": "https://..."
}
}