Skip to main content

Courier Partner

v1

Description

The seller has the choice between self-managed logistics or admin-managed logistics. The administrator is responsible for enabling or disabling the account of any particular company. Account status updates for any account need to be communicated to the specific courier partner extension. This webhook will serve the purpose of updating account statuses.


Supported Type

  • account-status

  • assign

  • cancel


Payload

account-status

{
"payload": {
"courier-partner": {
"extension_id": "",
"scheme_id": "",
"account_id": "",
"stage": "enabled",
"is_own_account": true
}
},
"meta": {
"event": {
"name": "courier-partner",
"type": "account-status",
"version": "1"
},
"company_id": 3,
"trace_id": [
"e6629efee60995ae911e24f7d5e9388f"
],
"created_timestamp": 1697011837,
"service": {
"name": "stormbreaker"
}
}
}

assign

{
"payload": {
"shipment_id": "17054569937341849402",
"courier-partner": {
"extension_id": "656f20c89117f06286a7c6f2",
"scheme_id": "65952c02974836aaa986a3b2",
"mixed_cart": false,
"order_creation_time": "2024-01-17T07:33:14+00:00",
"MPS": false,
"qc_required": true,
"pickup_details": {
"address": "3V93J49, KOLIVERY VILLAGE UNIVERSITY OF MUMBAI,VIDYA NAGARI, KALINA, SANTACRUZ EAST,\nMumbai Maharashtra 400098\nIndia UNIVERSITY OF MUMBAI,VIDYA NAGARI, KALINA, SANTACRUZ EAST, ",
"area": "",
"landmark": "",
"lat": 19.0653252,
"long": 72.8423802,
"postal_code": "400098",
"district": "",
"city": "Mumbai",
"country_code": "IN",
"country_iso_code": "IN",
"state": "Maharashtra",
"sector": "",
"country": "India",
"e_waybill": {
"enabled": false,
"ewaybill_portal_details": {}
},
"contact_details": {
"name": "Serviceability-Mumbai-HS",
"phone": "919898765432",
"email": "Increff1@gmail.com",
"phone_code": "91",
"company": {
"name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED",
"address": [
{
"address_type": "office",
"address1": "FYND KONDIVITA\nSBI\nMUMBAI MAHARASHTRA 400053\nINDIA",
"address2": "KONDIVITA",
"pincode": 400053,
"city": "MUMBAI",
"country": "INDIA",
"state": "MAHARASHTRA",
"country_code": "IN",
"landmark": "SBI",
"country_iso_code": "IN",
"display_address": "FYND KONDIVITA\nSBI\nMUMBAI MAHARASHTRA 400053\nINDIA",
"latitude": 19.0653252,
"longitude": 72.8423802
},
{
"address_type": "registered",
"address1": "H H Y MAROL, INDUSTRIAL AREA,\nMoteravvvuvuvyuvycyyv\nGANDHI NAGAR GUJARAT 382424\nINDIA",
"address2": "MAROL, INDUSTRIAL AREA,",
"pincode": 382424,
"city": "GANDHI NAGAR",
"country": "INDIA",
"state": "GUJARAT",
"country_code": "IN",
"landmark": "Moteravvvuvuvyuvycyyv",
"country_iso_code": "IN",
"display_address": "H H Y MAROL, INDUSTRIAL AREA,\nMoteravvvuvuvyuvycyyv\nGANDHI NAGAR GUJARAT 382424\nINDIA",
"latitude": 19.1173012,
"longitude": 72.8840395
}
]
}
},
"pickup_location_id": 15411,
"merchant_id": null,
"pickup_time": "2024-01-17 07:33:49"
},
"delivery_details": {
"address": "opop opop\nopop\nThane Maharashtra 400603\nIndia opop opop",
"area": "opop",
"landmark": "opop",
"lat": 28.6667,
"long": 77.2167,
"postal_code": "400603",
"district": "",
"city": "Thane",
"country_code": "IN",
"country_iso_code": "IN",
"state": "Maharashtra",
"sector": "",
"country": "India",
"contact_details": {
"name": "opop",
"phone": "9773973517",
"phone_code": "+91",
"email": ""
}
},
"rto_details": {
"address": "3V93J49, KOLIVERY VILLAGE UNIVERSITY OF MUMBAI,VIDYA NAGARI, KALINA, SANTACRUZ EAST,\nMumbai Maharashtra 400098\nIndia UNIVERSITY OF MUMBAI,VIDYA NAGARI, KALINA, SANTACRUZ EAST, ",
"area": "",
"landmark": "",
"lat": 19.0653252,
"long": 72.8423802,
"postal_code": "400098",
"district": "",
"city": "Mumbai",
"country_code": "IN",
"country_iso_code": "IN",
"state": "Maharashtra",
"sector": "",
"country": "India",
"contact_details": {
"name": "Serviceability-Mumbai-HS",
"phone": "919898765432",
"email": "Increff1@gmail.com",
"phone_code": "91",
"company": {
"name": "FUCHSIA VINE DESIGNS PRIVATE LIMITED",
"address": [
{
"address_type": "office",
"address1": "FYND KONDIVITA\nSBI\nMUMBAI MAHARASHTRA 400053\nINDIA",
"address2": "KONDIVITA",
"pincode": 400053,
"city": "MUMBAI",
"country": "INDIA",
"state": "MAHARASHTRA",
"country_code": "IN",
"landmark": "SBI",
"country_iso_code": "IN",
"display_address": "FYND KONDIVITA\nSBI\nMUMBAI MAHARASHTRA 400053\nINDIA",
"latitude": 19.0653252,
"longitude": 72.8423802
},
{
"address_type": "registered",
"address1": "H H Y MAROL, INDUSTRIAL AREA,\nMoteravvvuvuvyuvycyyv\nGANDHI NAGAR GUJARAT 382424\nINDIA",
"address2": "MAROL, INDUSTRIAL AREA,",
"pincode": 382424,
"city": "GANDHI NAGAR",
"country": "INDIA",
"state": "GUJARAT",
"country_code": "IN",
"landmark": "Moteravvvuvuvyuvycyyv",
"country_iso_code": "IN",
"display_address": "H H Y MAROL, INDUSTRIAL AREA,\nMoteravvvuvuvyuvycyyv\nGANDHI NAGAR GUJARAT 382424\nINDIA",
"latitude": 19.1173012,
"longitude": 72.8840395
}
]
}
},
"merchant_id": null,
"pickup_time": "2024-01-17 07:33:49"
},
"shipment_details": {
"ordering_channel": "FYND_STORE",
"affiliate_id": "5d636e12f7863f6fde711303",
"order_id": "FY65A735600EE9B12943",
"shipment_id": "17054569937341849402",
"delivery_type": "forward",
"weight": 11,
"order_category": null,
"batch_id": null,
"gstin": null,
"dimensions": {
"width": 2,
"height": 3,
"length": 1
},
"total_item_count": 1,
"currency_code": "INR",
"currency_conversion": {
"base": "INR",
"rates": {
"INR": {
"name": "Indian Rupee",
"value": 1,
"symbol": "₹",
"sub_unit": "Paisa"
}
},
"timestamp": 1705449600000
},
"invoice": {
"number": "pikoijbvjhc",
"date": "2024-01-17T07:33:49+00:00",
"created_ts": "2024-01-17T07:33:49Z"
},
"order_type": "COD",
"items": [
{
"size": "OS",
"prices": {
"price_effective": 3.0,
"amount_paid": 110.0,
"refund_amount": 110.0,
"gst_tax_percentage": 5.0,
"value_of_good": 2.86,
"price_marked": 3.0,
"amount_paid_roundoff": 110,
"gst_fee": 0.14,
"igst_tax_percentage": 0.0,
"sgst_tax_percentage": 2.5,
"cgst_tax_percentage": 2.5,
"igst_gst_fee": 0.0,
"cgst_gst_fee": 0.07,
"sgst_gst_fee": 0.07
},
"quantity": 1.0,
"name": "Nike Jacket-SVCBLTY",
"hsn_code": "61099010",
"l1_category": [
"Clothing"
],
"category": "Activewear",
"sub_category": "Activewear Jackets",
"brand": "Nike",
"sku": "SVCBLTY567",
"description": "Nike Jacket-SVCBLTY SVCBLTY567 Activewear Activewear Jackets",
"images_url": [
"https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/products/pictures/item/free/270x0/si15q2pZF-1117Wx1400H-469564425-black-MODEL.jpg"
],
"color": "Red",
"attributes": {
"name": "Nike Jacket-SVCBLTY",
"gender": [
"Men"
],
"essential": "Yes",
"brand_name": "Nike",
"net-quantity": "1 N",
"marketer-name": "Aditya K",
"primary_color": "Red",
"marketer-address": "Aditya nagpur",
"primary_material": "Acrylic",
"primary_color_hex": "D0021B",
"primary-colour-hex-code": "D0021B",
"is_food": null,
"weight": 11.0
},
"tax_head": "SGST",
"return_qc_json": {},
"child_details": []
}
],
"prices": {
"price_effective": 3.0,
"amount_paid": 110.0,
"refund_amount": 110.0,
"value_of_good": 2.86,
"price_marked": 3.0,
"amount_paid_roundoff": 110.0,
"gst_fee": 0.14,
"igst_gst_fee": 0.0,
"cgst_gst_fee": 0.07,
"sgst_gst_fee": 0.07,
"tax_head": "SGST"
}
},
"ewaybill_info": {}
}
},
"meta": {
"event": {
"name": "courier-partner",
"type": "assign",
"version": "1"
},
"company_id": 61,
"application_id": [
"5d636e12f7863f6fde711303"
],
"extension_id": "656f20c89117f06286a7c6f2",
"trace_id": [
"0000000000000000a0c41d2734029f0a"
],
"created_timestamp": 1705457029,
"service": {
"name": "avis"
},
"trace": "0000000000000000a0c41d2734029f0a"
},
"shipment_id": "17054569937341849402"
}

cancel


{
"payload": {
"shipment_id": "17054684498801319368",
"courier-partner": {
"extension_id": "656f1f18c24dabc79325b1ba",
"scheme_id": "65952a7b199ac0fd9537b1a7",
"mixed_cart": false,
"order_creation_time": "2024-01-17T10:44:07+00:00",
"MPS": false,
"qc_required": true,
"awb_number": "998940754216"
}
},
"meta": {
"event": {
"name": "courier-partner",
"type": "cancel",
"version": "1"
},
"company_id": 46,
"application_id": [
"5eafc9121cfbb666d7959353"
],
"extension_id": "656f1f18c24dabc79325b1ba",
"trace_id": [
"0000000000000000c221799163987a91"
],
"created_timestamp": 1705484321,
"service": {
"name": "avis"
},
"trace": "0000000000000000c221799163987a91"
},
"shipment_id": "17054684498801319368"
}


Object Properties

keyTypeDescription
extension_idstringextension api key
scheme_idstringunique id of scheme
account_idstringunique id of account
stagestringaccount status flag
is_own_accountbooleanflag help is determining if account is admin-controlled or self-controlled
awb_numberstringAWB number assigned
mixed_cartbooleandefines whether shipment assigned is of mixed_cart
order_creation_timestringOrder created time
qc_requiredbooleanflag determines whether quality check needs to be done at delivery partner ends
MPSbooleanIndicates whether shipment is of Multi Part Shipment
pickup_detailsObjectShipment pick up address
delivery_detailsObjectShipment delivery address
rto_detailsObjectShipment return address
shipment_detailsObjectShipment details
ewaybill_infoObjectEwaybill generated for the shipment