Skip to main content

Shipment

v1

Description

An order is generally divided into one or more shipments depending on the quantity and size. Get notified whenever shipments are created or modified.


Supported Type

  • Create
  • Update

Payload

{
"event": {
"id": "AR8Vh6y71n+76UjbnaCH66rIsH/9phDc7glrf6lHXXs=",
"name": "shipment",
"type": "update",
"version": "1",
"trace_id": [
"Avis-df28fde49bac4a3da2b18c0f766d56c9"
],
"created_timestamp": "2021-12-06T16:07:06+00:00"
},
"payload": {
"shipment": {
"bags": [
{
"item": {
"id": 183,
"code": "AW15NA8-JK-LM53@RED",
"name": "Red Blazer",
"size": "18",
"brand": "AND data",
"color": null,
"image": [
"https://hdn-1.fynd.com/media/pictures/tagged_items/270x0/2_AW15NA8-JK-LM53@RED/1.jpg",
"https://hdn-1.fynd.com/media/pictures/tagged_items/270x0/2_AW15NA8-JK-LM53@RED/2.jpg",
"https://hdn-1.fynd.com/media/pictures/tagged_items/270x0/2_AW15NA8-JK-LM53@RED/3.jpg",
"https://hdn-1.fynd.com/media/pictures/tagged_items/270x0/2_AW15NA8-JK-LM53@RED/4.jpg",
"https://hdn-1.fynd.com/media/pictures/tagged_items/270x0/2_AW15NA8-JK-LM53@RED/5.jpg"
],
"gender": null,
"brand_id": 2,
"slug_key": "and-red-blazer",
"attributes": {
"color": "Red",
"media": [
{
"url": "https://hdn-1.fynd.com/media/pictures/tagged_items/original/2_AW15NA8-JK-LM53@RED/1.jpg",
"type": "image"
},
{
"url": "https://hdn-1.fynd.com/media/pictures/tagged_items/original/2_AW15NA8-JK-LM53@RED/2.jpg",
"type": "image"
},
{
"url": "https://hdn-1.fynd.com/media/pictures/tagged_items/original/2_AW15NA8-JK-LM53@RED/3.jpg",
"type": "image"
},
{
"url": "https://hdn-1.fynd.com/media/pictures/tagged_items/original/2_AW15NA8-JK-LM53@RED/4.jpg",
"type": "image"
},
{
"url": "https://hdn-1.fynd.com/media/pictures/tagged_items/original/2_AW15NA8-JK-LM53@RED/5.jpg",
"type": "image"
}
],
"gender": [
"Women"
],
"season": "AW15",
"pattern": "Solid",
"currency": "INR",
"material": "Polyester",
"occasion": "Casual",
"item_code": "AW15NA8-JK-LM53@RED",
"brand_name": "AND data",
"product_fit": "Regular",
"sleeve_length": "Long",
"care_instructions": "Machine wash on normal cycle",
"primary_color_hex": "D0021B"
},
"branch_url": "http://go.fyndi.ng/iSyg/L71BUooQby",
"can_cancel": true,
"can_return": true,
"l1_category": [
"Clothing"
],
"l2_category": [
"Suits & Blazers"
],
"l3_category": 148,
"department_id": 99,
"last_updated_at": "2021-12-03T16:26:19+00:00",
"l3_category_name": "Blazers",
"webstore_product_url": null
},
"brand": {
"id": 2,
"logo": "http://hdn-1.fynd.com/media/logo/brand/original/775_5c7451891aed42c88a6e99bbe5eeeaf4.jpg",
"company": null,
"brand_name": "AND data",
"created_on": "2015-10-15T16:18:19+00:00",
"start_date": null,
"modified_on": "2020-12-08T07:23:29+00:00",
"invoice_prefix": null,
"pickup_location": null,
"script_last_ran": null,
"is_virtual_invoice": false,
"credit_note_allowed": false,
"credit_note_expiry_days": null
},
"bag_id": 251976,
"article": {
"_id": "614310cc9ab782e50fb09f1c",
"set": {},
"uid": "614310cc9ab782e50fb09f1c",
"code": "",
"size": "18",
"is_set": false,
"raw_meta": null,
"identifiers": {
"sku_code": "8907346067709"
},
"esp_modified": false,
"child_details": {},
"return_config": {
"time": 30,
"unit": "days",
"returnable": true
},
"seller_identifier": "8907346067709"
},
"entity_type": "bag",
"financial_breakup": [
{
"size": "18",
"gst_fee": 214.17,
"gst_tag": "SGST",
"discount": 0,
"hsn_code": "61040000",
"item_name": "Red Blazer",
"identifiers": {
"sku_code": "8907346067709"
},
"total_units": 1,
"price_marked": 1999,
"value_of_good": 1784.82,
"tcs_percentage": 0,
"gst_tax_percentage": 12,
"brand_calculated_amount": 1999,
"tax_collected_at_source": 0
}
],
"current_operational_status": {
"id": 505628,
"bag_id": 251976,
"status": "bag_confirmed",
"reasons": [],
"state_id": 2,
"store_id": 997,
"created_at": "2021-12-06T16:07:06+00:00",
"kafka_sync": false,
"state_type": "operational",
"updated_at": "2021-12-06T16:07:06+00:00",
"shipment_id": "16385275250501281287",
"bag_state_mapper": {
"id": 2,
"name": "bag_confirmed",
"is_active": true,
"app_facing": true,
"state_type": "operational",
"display_name": "Confirmed",
"journey_type": "forward",
"app_state_name": "confirmed",
"notify_customer": false,
"app_display_name": "Confirmed"
},
"delivery_awb_number": null,
"delivery_partner_id": null
}
}
],
"ordering_store": {

},
"fyndstore_emp": {

},
"user": {
"id": 474,
"email": "avinashsharma@fynd-external.com",
"gender": "male",
"mobile": "9891979302",
"last_name": "Sharma",
"first_name": "Avinash",
"mongo_user_id": "261",
"is_anonymous_user": false
},
"prices": {
"cashback": 0,
"discount": 0,
"amount_paid": 2098,
"cod_charges": 0,
"coupon_value": 0,
"fynd_credits": 0,
"price_marked": 1999,
"refund_amount": 2098,
"refund_credit": 0,
"value_of_good": 1784.82,
"delivery_charge": 99,
"price_effective": 1999,
"cashback_applied": 0,
"amount_paid_roundoff": 2098,
"tax_collected_at_source": 0
},
"status": "bag_confirmed",
"order_id": "FY61A9F22401FF5A6590",
"payments": {
"id": 4,
"logo": "https://hdn-1.fynd.com/payment/NB_ICICI.png",
"mode": "NB",
"source": "NB_ICICI",
"is_active": true,
"display_name": "Net Banking",
"display_priority": 3
},
"company_id": 873,
"shipment_id": "16385275250501281287",
"application_id": "000000000000000000000001",
"billing_address": {
"area": "abc",
"city": "Mumbai",
"email": "avinashsharma@fynd-external.com",
"phone": "9891979302",
"state": "Maharashtra",
"country": "India",
"pincode": "400059",
"version": "1.0",
"address1": "abc",
"address2": "",
"landmark": "test",
"latitude": 0,
"longitude": 0,
"created_at": "2021-12-03 16:02:05",
"updated_at": "2021-12-03 16:02:05",
"address_type": "home",
"contact_person": "Avinash Sharma",
"address_category": "billing"
},
"shipment_status": {
"id": 408694,
"status": "bag_confirmed",
"bag_list": [
"251976"
],
"created_at": "2021-12-06T16:07:06+00:00",
"shipment_id": "16385275250501281287",
"status_created_at": "2021-12-06T16:07:06+00:00",
"current_shipment_status": "bag_confirmed"
},
"delivery_address": {
"area": "abc",
"city": "Mumbai",
"name": "Avinash Sharma",
"email": "avinashsharma@fynd-external.com",
"phone": "9891979302",
"state": "Maharashtra",
"address": "abc",
"country": "India",
"pincode": "400059",
"version": "1.0",
"address1": "abc",
"address2": "",
"landmark": "test",
"latitude": 0,
"longitude": 0,
"created_at": "2021-12-03T16:02:05+00:00",
"updated_at": "2021-12-03T16:02:05+00:00",
"address_type": "home",
"contact_person": "Avinash Sharma",
"address_category": "delivery"
},
"fulfilling_store": {
"id": 997,
"city": "MUMBAI",
"code": "ADIL104",
"meta": {
"stage": "verified",
"timing": [
{
"open": true,
"closing": {
"hour": 21,
"minute": 0
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "monday"
},
{
"open": true,
"closing": {
"hour": 21,
"minute": 0
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "tuesday"
},
{
"open": true,
"closing": {
"hour": 21,
"minute": 0
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "wednesday"
},
{
"open": true,
"closing": {
"hour": 14,
"minute": 20
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "thursday"
},
{
"open": true,
"closing": {
"hour": 21,
"minute": 0
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "friday"
},
{
"open": true,
"closing": {
"hour": 21,
"minute": 0
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "saturday"
},
{
"open": true,
"closing": {
"hour": 21,
"minute": 0
},
"opening": {
"hour": 11,
"minute": 0
},
"weekday": "sunday"
}
],
"documents": {
"gst": {
"type": "gst",
"value": "27AACCO8356L1ZW",
"verified": true,
"legal_name": "OCHRE AND BLACK PRIVATE LIMITED"
}
},
"gst_number": "27AABPP6503E003",
"display_name": "Borivali",
"gst_credentials": {
"e_invoice": {
"enabled": true
},
"e_waybill": {
"enabled": false
}
},
"notification_emails": [
""
],
"product_return_config": {
"on_same_store": true
},
"ewaybill_portal_details": null,
"additional_contact_details": {
"number": [
"91 - 2265180644",
"91 - 770955424"
]
}
},
"name": "Borivali",
"state": "MAHARASHTRA",
"address": "29, SATRA PARK,SHIMPOLI ROAD, BORIVALI WEST, MUMBAI - 400092"
},
"delivery_partner_details": {
"id": null,
"name": null,
"awb_no": null,
"gst_tag": "sgst",
"track_url": null,
"eway_bill_id": null
}
}
},
"contains": [
"shipment"
],
"company_id": 873,
"application_id": "000000000000000000000001"
}
Other Sample Payload

Object Properties

KeyTypeDescription
statusStringWebhook shipment status, i.e., either create or update
shipment_statusstringStatus of the shipment indicating its current stage
application_idStringID of the sales channel to which the shipment belongs
shipment_idStringUnique shipment no. that is auto-generated
company_idIntegerID of the company fulfilling the shipment
order_idStringUnique ID of order in which the shipment is present
userObjectPurchaser's details such as name, last name, mobile no. and email
delivery_addressObjectAddress where the shipment is to be delivered
billing_addressObjectAddress by which the invoice is created
delivery_partner_detailsObjectDetails of the logistics company that will deliver the shipment
bagsListDetails of all the products/articles in a shipment
fulfilling_storeObjectDetails of the store responsible for fulfilling the order
pricesObjectDetails of all the charges, cashback, refunds, taxes, coupons, etc. applicable to the shipment
paymentsObjectObject containing payment mode and payment breakup
payment_modeStringMode of payment, e.g., NB, UPI, Wallet, Card, COD, etc.
price_breakupObjectObject containing discount, order value, and delivery charges
discountIntegerThe total amount discounted from the original MRP/actual price
delivery_chargesIntegerThe amount charged for delivery apart from the product price
order_valueIntegerValue of the order
fyndstore_empObjectFynd store employee details
ordering_storeObject / NullStore is from where the shipment is generated