Application

Events categorised under application/sales channel level will be triggered when any action performed for sales channel. e.g. If new Coupon is created for sales channel.

Courier partner

This event will be generated where there is any action done on courier-partner

Events
application/courier-partner/assign/v1
# This event is triggered when courier-partner is assigned
application/courier-partner/ndr/v1
# This event is triggered when a courier partner's delivery attempt fails and the shipment requires scheduling a reattempt based on reattempt count
application/courier-partner/cancel/v1
# This event is triggered when courier-partner is canceled

Courier Partner/courier-partner/assign/v1

This event is triggered when courier-partner is assigned

Payload
Hide
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Show
payload
object
Required
Show
Payload Schema JSON
1{
2 "type": "object",
3 "required": [
4 "company_id",
5 "contains",
6 "event",
7 "payload",
8 "application_id"
9 ],
10 "properties": {
11 "application_id": {
12 "type": [
13 "array",
14 "string"
15 ],
16 "description": "sales channel ID for which this event is triggered"
17 },
18 "company_id": {
19 "type": "integer",
20 "description": "company ID for which this event is triggered"
21 },
22 "contains": {
23 "type": "array",
24 "description": "This array will have all the keys present at root level of 'payload' object",
25 "items": {
26 "type": "string"
27 }
28 },
29 "event": {
30 "type": "object",
31 "required": [
32 "category",
33 "created_timestamp",
34 "id",
35 "name",
36 "trace_id",
37 "type",
38 "version"
39 ],
40 "properties": {
41 "category": {
42 "type": "string",
43 "description": "category of the event. If it is at sales channel level or company level"
44 },
45 "created_timestamp": {
46 "type": "integer",
47 "description": "event generation timestamp in epoch milliseconds"
48 },
49 "id": {
50 "type": "string",
51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52 },
53 "name": {
54 "type": "string",
55 "description": "Name of the event"
56 },
57 "trace_id": {
58 "type": "array",
59 "description": "internal trace_id for Fynd Platform services",
60 "items": {
61 "type": "string"
62 }
63 },
64 "type": {
65 "type": "string",
66 "description": "Type/Action of the event. e.g. create/update/delete"
67 },
68 "version": {
69 "type": "string",
70 "description": "Version of the event."
71 }
72 }
73 },
74 "payload": {
75 "type": "object",
76 "properties": {
77 "courier-partner": {
78 "type": "object",
79 "description": "An object containing details of the shipment, pickup details, delivery details that is useful for courier partner for delivering the shipment successfully",
80 "properties": {
81 "extension_id": {
82 "type": "string",
83 "description": "extension api key"
84 },
85 "mixed_cart": {
86 "type": "boolean",
87 "description": "defines whether shipment assigned is of mixed_cart"
88 },
89 "order_creation_time": {
90 "type": "string",
91 "description": "Order created time"
92 },
93 "MPS": {
94 "type": "boolean",
95 "description": "Indicates whether shipment is of Multi Part Shipment"
96 },
97 "qc_required": {
98 "type": "boolean",
99 "description": "flag determines whether quality check needs to be done at delivery partner ends"
100 },
101 "is_b2b": {
102 "type": "boolean",
103 "description": "Flag indicating whether the order is a business-to-business (B2B) transaction"
104 },
105 "packages": {
106 "type": "array",
107 "description": "List of packages associated with the shipment",
108 "items": {
109 "type": "object",
110 "properties": {
111 "id": {
112 "type": "string",
113 "description": "Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.",
114 "example": "PK0000000001"
115 },
116 "packaging_id": {
117 "type": [
118 "string",
119 "null"
120 ],
121 "description": "Optional reference to a predefined packaging configuration or template used for creating physical packages.",
122 "example": "6733286311a57c1546561690"
123 },
124 "name": {
125 "type": [
126 "string",
127 "null"
128 ],
129 "description": "A human-readable name or label for the package, used for identification and organizational purposes.",
130 "example": "Package 1"
131 },
132 "size": {
133 "type": [
134 "string",
135 "null"
136 ],
137 "description": "The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.",
138 "example": "medium"
139 },
140 "package_type": {
141 "type": [
142 "string",
143 "null"
144 ],
145 "description": "The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).",
146 "example": "Box",
147 "x-not-enum": true
148 },
149 "length": {
150 "type": [
151 "number",
152 "null"
153 ],
154 "format": "float",
155 "description": "The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
156 "example": 25
157 },
158 "width": {
159 "type": [
160 "number",
161 "null"
162 ],
163 "format": "float",
164 "description": "The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
165 "example": 15
166 },
167 "height": {
168 "type": [
169 "number",
170 "null"
171 ],
172 "format": "float",
173 "description": "The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
174 "example": 10
175 },
176 "weight": {
177 "type": [
178 "number",
179 "null"
180 ],
181 "format": "float",
182 "description": "The actual weight of the package in kilograms, including packaging materials and products.",
183 "example": 2.5
184 },
185 "error_rate": {
186 "type": [
187 "number",
188 "null"
189 ],
190 "format": "float",
191 "description": "The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).",
192 "example": 0.02,
193 "nullable": true
194 },
195 "package_vol_weight": {
196 "type": [
197 "number",
198 "null"
199 ],
200 "format": "float",
201 "description": "The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.",
202 "example": 3.75,
203 "nullable": true
204 },
205 "max_weight": {
206 "type": [
207 "number",
208 "null"
209 ],
210 "format": "float",
211 "description": "The maximum weight capacity that this package can handle, used for validation and logistics planning.",
212 "example": 5,
213 "nullable": true
214 },
215 "awb": {
216 "type": [
217 "string",
218 "null"
219 ],
220 "description": "Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.",
221 "example": "AWB1234567890",
222 "nullable": true
223 },
224 "pdf_links": {
225 "type": "object",
226 "description": "Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.",
227 "additionalProperties": {
228 "type": "string",
229 "format": "uri"
230 },
231 "default": {},
232 "example": {
233 "label_a4": "https://sample.com/documents/label_a4/PDFs/17512794597831303808_label_a4.pdf",
234 "label_a6": "https://sample.com/documents/label_a6/PDFs/17512794597831303808_label_a6.pdf",
235 "label_pos": "https://sample.com/documents/label_pos/PDFs/17512794597831303808_label_pos.pdf"
236 }
237 },
238 "products": {
239 "type": "array",
240 "description": "List of products contained within this package. Each product specifies its line number, quantity, and identifier.",
241 "items": {
242 "type": "object",
243 "required": [
244 "line_number",
245 "quantity",
246 "identifier"
247 ],
248 "properties": {
249 "line_number": {
250 "type": "integer",
251 "description": "The line number of the product within the shipment, used for tracking and identification purposes.",
252 "example": 1
253 },
254 "quantity": {
255 "type": "number",
256 "description": "The quantity of the product included in this package.",
257 "example": 2
258 },
259 "identifier": {
260 "type": "string",
261 "description": "The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.",
262 "example": "PROD001"
263 }
264 }
265 },
266 "example": [
267 {
268 "line_number": 1,
269 "quantity": 2,
270 "identifier": "PROD001"
271 },
272 {
273 "line_number": 2,
274 "quantity": 1,
275 "identifier": "PROD002"
276 }
277 ]
278 }
279 }
280 }
281 },
282 "logistics_meta": {
283 "type": "object",
284 "description": "Contains metadata related to logistics and delivery operations. This field is intended to store supplementary information that supports shipment handling, courier interactions, and overall logistics workflows throughout the delivery lifecycle."
285 },
286 "pickup_details": {
287 "type": "object",
288 "description": "Address from where the shipment needs to be picked up",
289 "properties": {
290 "address": {
291 "type": "string",
292 "description": "A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
293 },
294 "area": {
295 "type": "string",
296 "description": "A string specifying the locality or area associated with the pickup address"
297 },
298 "landmark": {
299 "type": "string",
300 "description": "A string representing a prominent nearby landmark that aids in locating the pickup address"
301 },
302 "postal_code": {
303 "type": "string",
304 "description": "A string indicating the postal code or PIN code of the pickup address area"
305 },
306 "district": {
307 "type": "string",
308 "description": "A string denoting the district of the pickup address"
309 },
310 "city": {
311 "type": "string",
312 "description": "A string denoting the city or municipality of the pickup address"
313 },
314 "country_code": {
315 "type": "string",
316 "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"
317 },
318 "state": {
319 "type": "string",
320 "description": "A string indicating the state or province of the pickup address"
321 },
322 "country": {
323 "type": "string",
324 "description": "A string indicating the country of the pickup address"
325 },
326 "e_waybill": {
327 "type": "object",
328 "description": "An object containing details i.e ewaybill_portal_details, enabled (flag representing whether ewaybill is activated) required for generating Electronic Waybill"
329 },
330 "contact_details": {
331 "type": "object",
332 "description": "Contact details of the person from whom the shipment needs to be picked up.",
333 "properties": {
334 "name": {
335 "type": "string",
336 "description": "Name of the contact person associated with the pickup address"
337 },
338 "phone": {
339 "type": "string",
340 "description": "Phone number associated with the pickup address user"
341 },
342 "phone_code": {
343 "type": "string",
344 "description": "Phone code for the country of the pickup address"
345 },
346 "email": {
347 "type": [
348 "string",
349 "null"
350 ],
351 "description": "Email of the recipient associated with the pickup address"
352 }
353 },
354 "required": [
355 "name",
356 "phone",
357 "phone_code",
358 "email"
359 ]
360 },
361 "pickup_time": {
362 "type": "string",
363 "description": "The pickup time indicates when the store prepares the order and when delivery partners should pick up the shipments"
364 }
365 },
366 "required": [
367 "address",
368 "area",
369 "landmark",
370 "postal_code",
371 "district",
372 "city",
373 "country_code",
374 "state",
375 "country",
376 "contact_details",
377 "pickup_time"
378 ]
379 },
380 "delivery_details": {
381 "type": "object",
382 "description": "Address from where the shipment needs to be delivered",
383 "properties": {
384 "address": {
385 "type": "string",
386 "description": "A string representing the complete address, combining address line 1, address line 2, area, landmark, sector, city, state, and pincode. This provides a comprehensive view of the address details"
387 },
388 "area": {
389 "type": "string",
390 "description": "A string specifying the locality or area associated with the delivery address"
391 },
392 "landmark": {
393 "type": "string",
394 "description": "A string representing a prominent nearby landmark that aids in locating the delivery address"
395 },
396 "lat": {
397 "type": [
398 "number",
399 "string"
400 ],
401 "description": "Latitude is the geographic coordinate that specifies the north-south position of an delivery address"
402 },
403 "long": {
404 "type": [
405 "number",
406 "string"
407 ],
408 "description": "Longitude is the geographic coordinate that specifies the north-south position of an delivery address"
409 },
410 "postal_code": {
411 "type": "string",
412 "description": "A string indicating the postal code or PIN code of the delivery address area"
413 },
414 "district": {
415 "type": "string",
416 "description": "A string denoting the district of the delivery address"
417 },
418 "city": {
419 "type": "string",
420 "description": "A string denoting the city or municipality of the delivery address"
421 },
422 "country_code": {
423 "type": "string",
424 "description": "The ISO 3166-1 alpha-2 country code of the country where the business operates"
425 },
426 "state": {
427 "type": "string",
428 "description": "A string indicating the state or province of the delivery address"
429 },
430 "country": {
431 "type": "string",
432 "description": "A string indicating the country of the delivery address"
433 },
434 "e_waybill": {
435 "type": "object",
436 "description": "An object containing details i.e ewaybill_portal_details, enabled (flag representing whether ewaybill is activated) required for generating Electronic Waybill"
437 },
438 "contact_details": {
439 "type": "object",
440 "description": "Contact details of the person to whom the shipment needs to be delivered.",
441 "properties": {
442 "name": {
443 "type": "string",
444 "description": "Name of the contact person associated with the delivery address"
445 },
446 "phone": {
447 "type": "string",
448 "description": "Phone code for the country of the delivery address"
449 },
450 "email": {
451 "type": [
452 "string",
453 "null"
454 ],
455 "description": "Email of the recipient associated with the delivery address"
456 },
457 "phone_code": {
458 "type": "string",
459 "description": "Phone code for the country of the delivery address"
460 }
461 },
462 "required": [
463 "name",
464 "phone",
465 "email",
466 "phone_code"
467 ]
468 }
469 },
470 "required": [
471 "address",
472 "area",
473 "landmark",
474 "postal_code",
475 "district",
476 "city",
477 "country_code",
478 "state",
479 "country",
480 "contact_details"
481 ]
482 },
483 "shipment_details": {
484 "type": "object",
485 "description": "Details of the product in a shipment",
486 "properties": {
487 "ordering_channel": {
488 "type": "string",
489 "description": "The specific channel through which your order was placed. This field will be phased out after version 2.4.0. Please use ordering_source instead to ensure accurate order tracking and processing."
490 },
491 "ordering_source": {
492 "type": "string",
493 "nullable": true,
494 "description": "To uniquely identify the source through which order has been placed."
495 },
496 "affiliate_id": {
497 "type": "string",
498 "description": "External reference id of the shipment"
499 },
500 "order_id": {
501 "type": "string",
502 "description": "Unique identifier of the order"
503 },
504 "shipment_id": {
505 "type": "string",
506 "description": "Unique identifier of the shipment"
507 },
508 "delivery_type": {
509 "type": "string",
510 "description": "A string indicating the typical flow of goods, forward (delivery to the customer) or reverse (pickup from the customer)"
511 },
512 "weight": {
513 "type": "number",
514 "description": "Weight of the shipment"
515 },
516 "order_category": {
517 "type": "null"
518 },
519 "batch_id": {
520 "type": "null"
521 },
522 "gstin": {
523 "type": [
524 "string",
525 "null"
526 ],
527 "description": "The GSTIN (Goods and Services Tax Identification Number) number of the seller"
528 },
529 "dimensions": {
530 "type": [
531 "object",
532 "null"
533 ],
534 "description": "Object containing Length, Width and Height of a package"
535 },
536 "total_item_count": {
537 "type": "integer",
538 "description": "Total quantity of the item present in the shipment"
539 },
540 "currency_code": {
541 "type": "string",
542 "description": "The ISO 4217 currency code indicates the currency in which the order was placed."
543 },
544 "currency_conversion": {
545 "type": "object",
546 "description": "An object of the currency conversion",
547 "properties": {
548 "base": {
549 "type": "string",
550 "description": "The base currency for the conversion rates given. The 3-letter ISO 4217 currency code."
551 },
552 "rates": {
553 "type": "object",
554 "description": "Conversion rate of the base currency"
555 }
556 },
557 "required": [
558 "base",
559 "rates"
560 ]
561 },
562 "invoice": {
563 "type": "object",
564 "description": "Object containing invoice related details of the shipment.",
565 "properties": {
566 "number": {
567 "type": "string",
568 "description": "The invoice number for the current shipment."
569 },
570 "date": {
571 "type": "string",
572 "description": "The date on which the invoice was created."
573 }
574 },
575 "required": [
576 "number",
577 "date"
578 ]
579 },
580 "order_type": {
581 "type": "string",
582 "description": "A string indicating type of order [COD or Prepaid]"
583 },
584 "items": {
585 "type": "array",
586 "description": "Details of all the items in a shipment",
587 "items": {
588 "type": "object",
589 "properties": {
590 "size": {
591 "type": "string",
592 "description": "A string denoting the size of the item."
593 },
594 "prices": {
595 "type": "object",
596 "description": "Details of all the charges, refunds, taxes, etc. applicable to the product",
597 "properties": {
598 "price_effective": {
599 "type": "number",
600 "description": "MRP - Initial Seller provided discount"
601 },
602 "amount_paid": {
603 "type": "number",
604 "description": "Amount paid by the customer"
605 },
606 "refund_amount": {
607 "type": "number",
608 "description": "Amount refundable if order is returned"
609 },
610 "gst_tax_percentage": {
611 "type": "number",
612 "description": "The percentage rate of GST applied to a product or service"
613 },
614 "value_of_good": {
615 "type": "number",
616 "description": "Effective selling price - Product GST Amount"
617 },
618 "price_marked": {
619 "type": "number",
620 "description": "The indicated price or value assigned to an item before any discounts or adjustments"
621 },
622 "amount_paid_roundoff": {
623 "type": "number",
624 "description": "Amount paid rounded off"
625 },
626 "gst_fee": {
627 "type": "number",
628 "description": "The fee associated with Goods and Services Tax (GST) for a product or service"
629 },
630 "igst_tax_percentage": {
631 "type": "number",
632 "description": "The percentage rate of Integrated Goods and Services Tax (GST) applied to an interstate transaction"
633 },
634 "sgst_tax_percentage": {
635 "type": "number",
636 "description": "The percentage rate of State Goods and Services Tax (GST) applied to a transaction within a State"
637 },
638 "cgst_tax_percentage": {
639 "type": "number",
640 "description": "The percentage rate of Central Goods and Services Tax (GST) applied to an intra-state transaction"
641 },
642 "igst_gst_fee": {
643 "type": "number",
644 "description": "The fee associated with Integrated Goods and Services Tax (GST) for an interstate transaction"
645 },
646 "cgst_gst_fee": {
647 "type": "number",
648 "description": "The fee associated with Central Goods and Services Tax (GST) for an intra-state transaction"
649 },
650 "sgst_gst_fee": {
651 "type": "number",
652 "description": "The fee associated with State Goods and Services Tax (GST) for a transaction within a State"
653 }
654 },
655 "required": [
656 "price_effective",
657 "amount_paid",
658 "refund_amount",
659 "gst_tax_percentage",
660 "value_of_good",
661 "price_marked",
662 "amount_paid_roundoff",
663 "gst_fee",
664 "igst_tax_percentage",
665 "sgst_tax_percentage",
666 "cgst_tax_percentage",
667 "igst_gst_fee",
668 "cgst_gst_fee",
669 "sgst_gst_fee"
670 ]
671 },
672 "quantity": {
673 "type": "integer",
674 "description": "Quantity of products"
675 },
676 "name": {
677 "type": "string",
678 "description": "A string indicating name of the product"
679 },
680 "hsn_code": {
681 "type": "string",
682 "description": "The Harmonized System of Nomenclature (HSN) code, used for classifying goods traded internationally"
683 },
684 "category": {
685 "type": "string",
686 "description": "A string indicating category of the product"
687 },
688 "sub_category": {
689 "type": "string",
690 "description": "A string indicating sub category classification of the product"
691 },
692 "brand": {
693 "type": "string",
694 "description": "A string indicating The brand of the item"
695 },
696 "brand_id": {
697 "type": [
698 "integer",
699 "null"
700 ],
701 "description": "Unique numeric identifier of the brand associated with the item. Enables downstream courier-partner extensions to perform brand-specific routing or workflows."
702 },
703 "sku": {
704 "type": "string",
705 "description": "A string indication of Stock Keeping Unit of the item"
706 },
707 "description": {
708 "type": "string",
709 "description": "A string representing a product description"
710 },
711 "images_url": {
712 "type": "array",
713 "description": "List of product images URL",
714 "items": {
715 "type": "string"
716 }
717 },
718 "attributes": {
719 "type": "object",
720 "description": "Attributes of the product."
721 },
722 "tax_head": {
723 "type": "string",
724 "description": "The tax rate applicable for the tax applicable to the product (IGST,SGST)."
725 }
726 },
727 "required": [
728 "size",
729 "prices",
730 "quantity",
731 "name",
732 "hsn_code",
733 "category",
734 "sub_category",
735 "brand",
736 "sku",
737 "description",
738 "images_url",
739 "tax_head"
740 ]
741 }
742 },
743 "prices": {
744 "type": "object",
745 "description": "Details of all the charges, refunds, taxes, etc. applicable to the shipment",
746 "properties": {
747 "price_effective": {
748 "type": "number",
749 "description": "MRP - Initial Seller provided discount for the shipment"
750 },
751 "amount_paid": {
752 "type": "number",
753 "description": "Amount paid by the customer for the shipment"
754 },
755 "refund_amount": {
756 "type": "number",
757 "description": "Amount refundable if order is returned for the shipment"
758 },
759 "value_of_good": {
760 "type": "number",
761 "description": "Effective selling price - Product GST Amount for the shipment"
762 },
763 "price_marked": {
764 "type": "number",
765 "description": "The indicated price or value assigned to an shipment before any discounts or adjustments for the shipment"
766 },
767 "amount_paid_roundoff": {
768 "type": "number",
769 "description": "Amount paid rounded off for the shipment"
770 },
771 "gst_fee": {
772 "type": "number",
773 "description": "The fee associated with Goods and Services Tax (GST) for the product or service of the shipment."
774 },
775 "igst_gst_fee": {
776 "type": "number",
777 "description": "The fee associated with Integrated Goods and Services Tax (GST) for an interstate transaction applied to the shipment"
778 },
779 "cgst_gst_fee": {
780 "type": "number",
781 "description": "The fee associated with Central Goods and Services Tax (GST) for an intra-state transaction applied to the shipment"
782 },
783 "sgst_gst_fee": {
784 "type": "number",
785 "description": "The fee associated with State Goods and Services Tax (GST) for a transaction within a State applied to the shipment"
786 },
787 "tax_head": {
788 "type": "string",
789 "description": "The tax rate applicable for the tax applicable to the shipment (IGST,SGST)."
790 }
791 },
792 "required": [
793 "price_effective",
794 "amount_paid",
795 "refund_amount",
796 "value_of_good",
797 "price_marked",
798 "amount_paid_roundoff",
799 "gst_fee",
800 "igst_gst_fee",
801 "cgst_gst_fee",
802 "sgst_gst_fee",
803 "tax_head"
804 ]
805 }
806 },
807 "required": [
808 "ordering_channel",
809 "affiliate_id",
810 "order_id",
811 "shipment_id",
812 "delivery_type",
813 "weight",
814 "order_category",
815 "batch_id",
816 "gstin",
817 "dimensions",
818 "total_item_count",
819 "currency_code",
820 "currency_conversion",
821 "invoice",
822 "order_type",
823 "items",
824 "prices"
825 ]
826 },
827 "ewaybill_info": {
828 "type": "object",
829 "description": "Electronic Way Bill details i.e ewayBillNo, ewayBillDate that are utilized in the transportation of goods"
830 },
831 "ship_to_gst_details": {
832 "type": "object",
833 "description": "ShipTo GST identity of the consignee, used by the courier partner to generate the e-way bill. Sourced from order.tax_details; gstin is \"URP\" when the consignee is unregistered.",
834 "properties": {
835 "gstin": {
836 "type": [
837 "string",
838 "null"
839 ],
840 "description": "ShipTo GSTIN of the consignee; \"URP\" when unregistered."
841 },
842 "trade_name": {
843 "type": [
844 "string",
845 "null"
846 ],
847 "description": "Registered trade name of the ShipTo consignee."
848 }
849 }
850 }
851 },
852 "required": [
853 "extension_id",
854 "order_creation_time",
855 "MPS",
856 "pickup_details",
857 "delivery_details",
858 "shipment_details",
859 "ewaybill_info"
860 ]
861 },
862 "shipment_id": {
863 "type": "string",
864 "description": "Unique identifier of the shipment"
865 }
866 },
867 "required": [
868 "courier-partner",
869 "shipment_id"
870 ]
871 }
872 }
873}
Payload Example
1{
2 "application_id": [
3 "6365f991cd0a31594e443bce",
4 "*"
5 ],
6 "company_id": 3523,
7 "contains": [
8 "shipment_id",
9 "courier-partner"
10 ],
11 "event": {
12 "category": "application",
13 "created_timestamp": 1712161343,
14 "id": "dTEeqnGsRT540xwEW2aFzsh53FFXLIg2pjpKyS/x0Ns=",
15 "name": "courier-partner",
16 "trace_id": [
17 "0000000000000000ba8a2062b3d44235"
18 ],
19 "type": "assign",
20 "version": "1"
21 },
22 "payload": {
23 "courier-partner": {
24 "MPS": false,
25 "delivery_details": {
26 "address": " test test",
27 "area": "test ",
28 "city": "test",
29 "contact_details": {
30 "email": "test@example.com",
31 "name": "test test",
32 "phone": "1111111111",
33 "phone_code": "+91"
34 },
35 "country": "India",
36 "country_code": "IN",
37 "country_iso_code": "IN",
38 "district": "",
39 "landmark": " mandir",
40 "lat": "",
41 "long": "",
42 "postal_code": "781354",
43 "sector": "",
44 "state": "Assam"
45 },
46 "ewaybill_info": {},
47 "extension_id": "656f1f18c24dabc79325b1ba",
48 "mixed_cart": false,
49 "order_creation_time": "2024-04-03T11:47:03+00:00",
50 "pickup_details": {
51 "address": "test test 782003\nIndia test",
52 "area": "",
53 "city": "Nagaon",
54 "contact_details": {
55 "company": {
56 "address": [
57 {
58 "address1": "\nINDIA",
59 "address_type": "office",
60 "city": "Howrah",
61 "country": "INDIA",
62 "country_code": "IN",
63 "country_iso_code": "IN",
64 "display_address": ", test",
65 "latitude": 22.5957689,
66 "longitude": 88.26363940000002,
67 "pincode": 711104,
68 "state": "West Bengal"
69 },
70 {
71 "address1": " test",
72 "address_type": "registered",
73 "city": "Howrah",
74 "country": "INDIA",
75 "country_code": "IN",
76 "country_iso_code": "IN",
77 "display_address": "test",
78 "latitude": 22.5957689,
79 "longitude": 88.26363940000002,
80 "pincode": 711104,
81 "state": "West Bengal"
82 }
83 ],
84 "name": "test"
85 },
86 "email": "test@example.com",
87 "name": "SB-NAGAON",
88 "phone": "1111111111",
89 "phone_code": "91"
90 },
91 "country": "India",
92 "country_code": "IN",
93 "country_iso_code": "IN",
94 "district": "",
95 "e_waybill": {
96 "enabled": false,
97 "ewaybill_portal_details": {}
98 },
99 "landmark": "SHREE SMITA COMMERCIAL COMPLEX ITACHALI",
100 "lat": 26.3462288,
101 "long": 92.7185992,
102 "merchant_id": null,
103 "pickup_location_id": 20914,
104 "pickup_time": "2024-04-03 21:52:23",
105 "postal_code": "782003",
106 "sector": "",
107 "state": "Assam"
108 },
109 "qc_required": true,
110 "rto_details": {
111 "address": "test",
112 "area": "",
113 "city": "Nagaon",
114 "contact_details": {
115 "company": {
116 "address": [
117 {
118 "address1": " test",
119 "address_type": "office",
120 "city": "Howrah",
121 "country": "INDIA",
122 "country_code": "IN",
123 "country_iso_code": "IN",
124 "display_address": ", test",
125 "latitude": 22.5957689,
126 "longitude": 88.26363940000002,
127 "pincode": 711104,
128 "state": "West Bengal"
129 },
130 {
131 "address1": " test",
132 "address_type": "registered",
133 "city": "Howrah",
134 "country": "INDIA",
135 "country_code": "IN",
136 "country_iso_code": "IN",
137 "display_address": " test",
138 "latitude": 22.5957689,
139 "longitude": 88.26363940000002,
140 "pincode": 711104,
141 "state": "West Bengal"
142 }
143 ],
144 "name": "Baazar Style Retail Limited"
145 },
146 "email": "test@example.com",
147 "name": "SB-NAGAON",
148 "phone": "1111111111",
149 "phone_code": "91"
150 },
151 "country": "India",
152 "country_code": "IN",
153 "country_iso_code": "IN",
154 "district": "",
155 "landmark": "test",
156 "lat": 26.3462288,
157 "long": 92.7185992,
158 "merchant_id": null,
159 "pickup_time": "2024-04-03 21:52:23",
160 "postal_code": "782003",
161 "sector": "",
162 "state": "Assam"
163 },
164 "scheme_id": "65952a7b199ac0fd9537b1a7",
165 "shipment_details": {
166 "affiliate_id": "6365f991cd0a31594e443bce",
167 "batch_id": null,
168 "currency_code": "INR",
169 "currency_conversion": {
170 "base": "INR",
171 "rates": {
172 "INR": {
173 "name": "Indian Rupee",
174 "sub_unit": "Paisa",
175 "symbol": "₹",
176 "value": 1
177 }
178 },
179 "timestamp": 1712102400000
180 },
181 "delivery_type": "forward",
182 "dimensions": {
183 "height": 7,
184 "length": 35.56,
185 "width": 29.21
186 },
187 "gstin": "18AAECD7575J1Z5",
188 "invoice": {
189 "created_ts": "2024-04-03T21:52:22Z",
190 "date": "2024-04-03T21:52:22+00:00",
191 "number": "E00020914A000051"
192 },
193 "items": [
194 {
195 "attributes": {
196 "brand_name": "STYLE BAAZAR",
197 "essential": "No",
198 "gender": [
199 "Men"
200 ],
201 "is_food": null,
202 "marketer-address": " test address",
203 "marketer-name": "Style Baazar",
204 "name": "SHIRT HS (MC)",
205 "net-quantity": "1 N",
206 "primary_color": "White",
207 "primary_color_hex": "FFFFFF",
208 "primary_material": "Others",
209 "season": "SS24_Q1",
210 "weight": 250
211 },
212 "brand": "STYLE BAAZAR",
213 "brand_id": 13905,
214 "category": "Dresses & Jumpsuits",
215 "child_details": [],
216 "color": "White",
217 "description": "SHIRT HS (MC) SB3207206 Dresses & Jumpsuits Shirt Dress",
218 "hsn_code": "62032900",
219 "images_url": [
220 "https://cdn.fynd.com/v2/falling-surf-7c8bb8/fyprod/wrkr/common/default_item_image.jpg"
221 ],
222 "l1_category": [
223 "Clothing"
224 ],
225 "name": "SHIRT HS (MC)",
226 "prices": {
227 "amount_paid": 499,
228 "amount_paid_roundoff": 499,
229 "cgst_gst_fee": 11.88,
230 "cgst_tax_percentage": 2.5,
231 "gst_fee": 23.76,
232 "gst_tax_percentage": 5,
233 "igst_gst_fee": 0,
234 "igst_tax_percentage": 0,
235 "price_effective": 499,
236 "price_marked": 499,
237 "refund_amount": 499,
238 "sgst_gst_fee": 11.88,
239 "sgst_tax_percentage": 2.5,
240 "value_of_good": 475.24
241 },
242 "quantity": 1,
243 "return_qc_json": {},
244 "size": "2XL-44 INCH",
245 "sku": "SB3207206",
246 "sub_category": "Shirt Dress",
247 "tax_head": "SGST"
248 }
249 ],
250 "order_category": null,
251 "order_id": "FY660CF45F0ED654F87D",
252 "order_type": "COD",
253 "ordering_channel": "FYND_STORE",
254 "ordering_source": "store_os_pos",
255 "prices": {
256 "amount_paid": 499,
257 "amount_paid_roundoff": 499,
258 "cgst_gst_fee": 11.88,
259 "gst_fee": 23.76,
260 "igst_gst_fee": 0,
261 "price_effective": 499,
262 "price_marked": 499,
263 "refund_amount": 499,
264 "sgst_gst_fee": 11.88,
265 "tax_head": "SGST",
266 "value_of_good": 475.24
267 },
268 "shipment_id": "17121570428911842368",
269 "total_item_count": 1,
270 "weight": 250
271 }
272 },
273 "shipment_id": "17121570428911842368"
274 }
275}

Courier Partner/courier-partner/ndr/v1

This event is triggered when a courier partner's delivery attempt fails and the shipment requires scheduling a reattempt based on reattempt count

Payload
Hide
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Show
payload
object
Required
Show
Payload Schema JSON
1{
2 "type": "object",
3 "required": [
4 "company_id",
5 "contains",
6 "event",
7 "payload",
8 "application_id"
9 ],
10 "properties": {
11 "application_id": {
12 "type": [
13 "array",
14 "string"
15 ],
16 "description": "sales channel ID for which this event is triggered"
17 },
18 "company_id": {
19 "type": "integer",
20 "description": "company ID for which this event is triggered"
21 },
22 "contains": {
23 "type": "array",
24 "description": "This array will have all the keys present at root level of 'payload' object",
25 "items": {
26 "type": "string"
27 }
28 },
29 "event": {
30 "type": "object",
31 "required": [
32 "category",
33 "created_timestamp",
34 "id",
35 "name",
36 "trace_id",
37 "type",
38 "version"
39 ],
40 "properties": {
41 "category": {
42 "type": "string",
43 "description": "category of the event. If it is at sales channel level or company level"
44 },
45 "created_timestamp": {
46 "type": "integer",
47 "description": "event generation timestamp in epoch milliseconds"
48 },
49 "id": {
50 "type": "string",
51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52 },
53 "name": {
54 "type": "string",
55 "description": "Name of the event"
56 },
57 "trace_id": {
58 "type": "array",
59 "description": "internal trace_id for Fynd Platform services",
60 "items": {
61 "type": "string"
62 }
63 },
64 "type": {
65 "type": "string",
66 "description": "Type/Action of the event. e.g. create/update/delete"
67 },
68 "version": {
69 "type": "string",
70 "description": "Version of the event."
71 }
72 }
73 },
74 "payload": {
75 "type": "object",
76 "properties": {
77 "courier-partner": {
78 "type": "object",
79 "properties": {
80 "extension_id": {
81 "type": "string",
82 "description": "Extension's unique identifier associated with the courier partner's extension integration."
83 },
84 "scheme_id": {
85 "type": "string",
86 "description": "Unique identifier for the courier scheme under which the shipment is being processed."
87 },
88 "awb": {
89 "type": "string",
90 "description": "Air Waybill number assigned to the shipment for tracking and logistics purposes."
91 },
92 "action": {
93 "type": "string",
94 "description": "NDR (Non-Delivery Report) action selected by the seller or customer.",
95 "enum": [
96 "re-schedule",
97 "return-to-shipper"
98 ]
99 },
100 "is_b2b": {
101 "type": "boolean",
102 "description": "Indicates whether the order is a business-to-business (B2B) order"
103 },
104 "packages": {
105 "type": "array",
106 "description": "List of packages associated with the shipment",
107 "items": {
108 "type": "object",
109 "properties": {
110 "id": {
111 "type": "string",
112 "description": "Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.",
113 "example": "PK0000000001"
114 },
115 "packaging_id": {
116 "type": [
117 "string",
118 "null"
119 ],
120 "description": "Optional reference to a predefined packaging configuration or template used for creating physical packages.",
121 "example": "6733286311a57c1546561690"
122 },
123 "name": {
124 "type": [
125 "string",
126 "null"
127 ],
128 "description": "A human-readable name or label for the package, used for identification and organizational purposes.",
129 "example": "Package 1"
130 },
131 "size": {
132 "type": [
133 "string",
134 "null"
135 ],
136 "description": "The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.",
137 "example": "medium"
138 },
139 "package_type": {
140 "type": [
141 "string",
142 "null"
143 ],
144 "description": "The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).",
145 "example": "Box",
146 "x-not-enum": true
147 },
148 "length": {
149 "type": [
150 "number",
151 "null"
152 ],
153 "format": "float",
154 "description": "The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
155 "example": 25
156 },
157 "width": {
158 "type": [
159 "number",
160 "null"
161 ],
162 "format": "float",
163 "description": "The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
164 "example": 15
165 },
166 "height": {
167 "type": [
168 "number",
169 "null"
170 ],
171 "format": "float",
172 "description": "The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
173 "example": 10
174 },
175 "weight": {
176 "type": [
177 "number",
178 "null"
179 ],
180 "format": "float",
181 "description": "The actual weight of the package in kilograms, including packaging materials and products.",
182 "example": 2.5
183 },
184 "error_rate": {
185 "type": [
186 "number",
187 "null"
188 ],
189 "format": "float",
190 "description": "The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).",
191 "example": 0.02,
192 "nullable": true
193 },
194 "package_vol_weight": {
195 "type": [
196 "number",
197 "null"
198 ],
199 "format": "float",
200 "description": "The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.",
201 "example": 3.75,
202 "nullable": true
203 },
204 "max_weight": {
205 "type": [
206 "number",
207 "null"
208 ],
209 "format": "float",
210 "description": "The maximum weight capacity that this package can handle, used for validation and logistics planning.",
211 "example": 5,
212 "nullable": true
213 },
214 "awb": {
215 "type": [
216 "string",
217 "null"
218 ],
219 "description": "Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.",
220 "example": "AWB1234567890",
221 "nullable": true
222 },
223 "pdf_links": {
224 "type": "object",
225 "description": "Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.",
226 "additionalProperties": {
227 "type": "string",
228 "format": "uri"
229 },
230 "default": {},
231 "example": {
232 "label_a4": "https://sample.com/documents/label_a4/PDFs/17512794597831303808_label_a4.pdf",
233 "label_a6": "https://sample.com/documents/label_a6/PDFs/17512794597831303808_label_a6.pdf",
234 "label_pos": "https://sample.com/documents/label_pos/PDFs/17512794597831303808_label_pos.pdf"
235 }
236 },
237 "products": {
238 "type": "array",
239 "description": "List of products contained within this package. Each product specifies its line number, quantity, and identifier.",
240 "items": {
241 "type": "object",
242 "required": [
243 "line_number",
244 "quantity",
245 "identifier"
246 ],
247 "properties": {
248 "line_number": {
249 "type": "integer",
250 "description": "The line number of the product within the shipment, used for tracking and identification purposes.",
251 "example": 1
252 },
253 "quantity": {
254 "type": "number",
255 "description": "The quantity of the product included in this package.",
256 "example": 2
257 },
258 "identifier": {
259 "type": "string",
260 "description": "The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.",
261 "example": "PROD001"
262 }
263 }
264 },
265 "example": [
266 {
267 "line_number": 1,
268 "quantity": 2,
269 "identifier": "PROD001"
270 },
271 {
272 "line_number": 2,
273 "quantity": 1,
274 "identifier": "PROD002"
275 }
276 ]
277 }
278 }
279 }
280 },
281 "schedule_date": {
282 "type": "string",
283 "description": "ISO 8601 UTC-formatted timestamp (e.g., 2025-06-07T10:00:00Z) specifying the scheduled date and time for the next delivery attempt as requested by the customer."
284 },
285 "delivery_address": {
286 "type": "object",
287 "description": "Structured object representing the customer’s delivery address, dynamically formatted according to country-specific standards (e.g., Indian addresses may include pincode and landmark, while UAE addresses may not)."
288 },
289 "alternate_phone": {
290 "type": "string",
291 "description": "Alternative contact number provided by the customer for communication during delivery."
292 },
293 "remark": {
294 "type": "string",
295 "description": "Additional notes or reasons provided by the customer for requesting a reattempt, such as “Changed phone number”, “New address”, or “Unavailable on earlier date”."
296 },
297 "logistics_meta": {
298 "type": "object",
299 "description": "Supplementary metadata containing operational or contextual information to aid logistics coordination, shipment handling, or courier interactions throughout the delivery process."
300 }
301 },
302 "required": [
303 "extension_id",
304 "awb"
305 ]
306 },
307 "shipment_id": {
308 "type": "string"
309 }
310 },
311 "required": [
312 "courier-partner",
313 "shipment_id"
314 ]
315 }
316 }
317}
Payload Example
1{
2 "event": {
3 "trace_id": [
4 "8fbfdacb721d99f2551612caffcf4626"
5 ],
6 "name": "courier-partner",
7 "type": "ndr",
8 "version": "1",
9 "created_timestamp": 1714493912,
10 "id": "O8MqLspwLuLWfXQy+V+1mn4jYngKSVVNop56H0jxAVM=",
11 "category": "application",
12 "referer": "sit.fyndx1.de"
13 },
14 "company_id": 2,
15 "application_id": [
16 "64aed475db2cfb5b8a9f623d",
17 "*"
18 ],
19 "contains": [
20 "shipment_info",
21 "shipment_id",
22 "courier-partner"
23 ],
24 "payload": {
25 "shipment_info": {
26 "extension_id": "6543d9e612912d23cb13da1a",
27 "scheme_id": "6569e9eb0a578b0045552338",
28 "mixed_cart": false,
29 "order_creation_time": "2024-04-25T17:05:03+00:00",
30 "MPS": false,
31 "qc_required": true
32 },
33 "shipment_id": "17140449027591545985",
34 "courier-partner": {
35 "action": "re-schedule",
36 "remark": "fewfefwe",
37 "schedule_date": "2024-05-02T16:18:32.521183Z",
38 "alternate_phone": "8888888888",
39 "delivery_address": {
40 "address": "aterere",
41 "id": "66278f5e53c381c500fbe785",
42 "uid": 48923,
43 "area": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik",
44 "city": "PUNE",
45 "name": "ssss",
46 "email": "test@example.com",
47 "phone": "8888888888",
48 "state": "MAHARASHTRA",
49 "sector": "",
50 "country": "India",
51 "pincode": "411045",
52 "user_id": 296,
53 "version": "1.0",
54 "address1": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
55 "address2": "",
56 "landmark": "",
57 "latitude": 19.1570343,
58 "area_code": "411045",
59 "longitude": 72.93274439999999,
60 "created_at": "2024-04-25 17:05:02",
61 "state_code": "MH",
62 "updated_at": "2024-04-25 17:05:02",
63 "address_type": "office",
64 "country_code": "+91",
65 "geo_location": {
66 "latitude": 19.1570343,
67 "longitude": 72.93274439999999
68 },
69 "area_code_slug": "pincode",
70 "contact_person": "ssss",
71 "display_address": "724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik 724724727472872787277782lkijyuthgrfdsxdcfgthyjukik724724727472872787277782lkijyuthgrfdsxdcfgthyjukik\nPUNE MAHARASHTRA 411045\nIndia",
72 "address_category": "",
73 "country_iso_code": "IN",
74 "country_phone_code": "+91",
75 "delivery_address_id": 48923
76 },
77 "awb": "6806110011756",
78 "auto_action_taken": false,
79 "extension_id": "6543d9e612912d23cb13da1a",
80 "scheme_id": "6569e9eb0a578b0045552338"
81 }
82 }
83}

Courier Partner/courier-partner/cancel/v1

This event is triggered when courier-partner is canceled

Payload
Hide
application_id
array|string
Required
sales channel ID for which this event is triggered
company_id
integer
Required
company ID for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Show
payload
object
Required
Show
Payload Schema JSON
1{
2 "type": "object",
3 "required": [
4 "company_id",
5 "contains",
6 "event",
7 "payload",
8 "application_id"
9 ],
10 "properties": {
11 "application_id": {
12 "type": [
13 "array",
14 "string"
15 ],
16 "description": "sales channel ID for which this event is triggered"
17 },
18 "company_id": {
19 "type": "integer",
20 "description": "company ID for which this event is triggered"
21 },
22 "contains": {
23 "type": "array",
24 "description": "This array will have all the keys present at root level of 'payload' object",
25 "items": {
26 "type": "string"
27 }
28 },
29 "event": {
30 "type": "object",
31 "required": [
32 "category",
33 "created_timestamp",
34 "id",
35 "name",
36 "trace_id",
37 "type",
38 "version"
39 ],
40 "properties": {
41 "category": {
42 "type": "string",
43 "description": "category of the event. If it is at sales channel level or company level"
44 },
45 "created_timestamp": {
46 "type": "integer",
47 "description": "event generation timestamp in epoch milliseconds"
48 },
49 "id": {
50 "type": "string",
51 "description": "Unique ID for an event. This id can be used to verifiy if event is already processed by receiver"
52 },
53 "name": {
54 "type": "string",
55 "description": "Name of the event"
56 },
57 "trace_id": {
58 "type": "array",
59 "description": "internal trace_id for Fynd Platform services",
60 "items": {
61 "type": "string"
62 }
63 },
64 "type": {
65 "type": "string",
66 "description": "Type/Action of the event. e.g. create/update/delete"
67 },
68 "version": {
69 "type": "string",
70 "description": "Version of the event."
71 }
72 }
73 },
74 "payload": {
75 "type": "object",
76 "properties": {
77 "courier-partner": {
78 "type": "object",
79 "properties": {
80 "extension_id": {
81 "type": "string",
82 "description": "extension api key"
83 },
84 "scheme_id": {
85 "type": "string",
86 "description": "unique id of scheme"
87 },
88 "mixed_cart": {
89 "type": "boolean",
90 "description": "defines whether shipment assigned is of mixed_cart"
91 },
92 "order_creation_time": {
93 "type": "string",
94 "description": "Order created time"
95 },
96 "MPS": {
97 "type": "boolean",
98 "description": "Indicates whether shipment is of Multi Part Shipment"
99 },
100 "qc_required": {
101 "type": "boolean",
102 "description": "flag determines whether quality check needs to be done at delivery partner ends"
103 },
104 "is_b2b": {
105 "type": "boolean",
106 "description": "Indicates whether the order is a business-to-business (B2B) order or not"
107 },
108 "packages": {
109 "type": "array",
110 "description": "List of packages associated with the shipment",
111 "items": {
112 "type": "object",
113 "properties": {
114 "id": {
115 "type": "string",
116 "description": "Unique identifier of the physical package. If not provided, the system will auto-generate a unique ID with format 'PK' followed by a 10-digit number.",
117 "example": "PK0000000001"
118 },
119 "packaging_id": {
120 "type": [
121 "string",
122 "null"
123 ],
124 "description": "Optional reference to a predefined packaging configuration or template used for creating physical packages.",
125 "example": "6733286311a57c1546561690"
126 },
127 "name": {
128 "type": [
129 "string",
130 "null"
131 ],
132 "description": "A human-readable name or label for the package, used for identification and organizational purposes.",
133 "example": "Package 1"
134 },
135 "size": {
136 "type": [
137 "string",
138 "null"
139 ],
140 "description": "The size category of the package (e.g., small, medium, large). Used for logistics and carrier selection.",
141 "example": "medium"
142 },
143 "package_type": {
144 "type": [
145 "string",
146 "null"
147 ],
148 "description": "The type or category of packaging material used (e.g., Box, Paper Bag, Poly Mailer, Envelope).",
149 "example": "Box",
150 "x-not-enum": true
151 },
152 "length": {
153 "type": [
154 "number",
155 "null"
156 ],
157 "format": "float",
158 "description": "The length dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
159 "example": 25
160 },
161 "width": {
162 "type": [
163 "number",
164 "null"
165 ],
166 "format": "float",
167 "description": "The width dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
168 "example": 15
169 },
170 "height": {
171 "type": [
172 "number",
173 "null"
174 ],
175 "format": "float",
176 "description": "The height dimension of the package in centimeters. Used for volumetric weight calculation and carrier requirements.",
177 "example": 10
178 },
179 "weight": {
180 "type": [
181 "number",
182 "null"
183 ],
184 "format": "float",
185 "description": "The actual weight of the package in kilograms, including packaging materials and products.",
186 "example": 2.5
187 },
188 "error_rate": {
189 "type": [
190 "number",
191 "null"
192 ],
193 "format": "float",
194 "description": "The acceptable error rate or tolerance for the package weight, expressed as a decimal (e.g., 0.02 for 2% tolerance).",
195 "example": 0.02,
196 "nullable": true
197 },
198 "package_vol_weight": {
199 "type": [
200 "number",
201 "null"
202 ],
203 "format": "float",
204 "description": "The volumetric weight of the package calculated based on dimensions, used for shipping cost calculation when greater than actual weight.",
205 "example": 3.75,
206 "nullable": true
207 },
208 "max_weight": {
209 "type": [
210 "number",
211 "null"
212 ],
213 "format": "float",
214 "description": "The maximum weight capacity that this package can handle, used for validation and logistics planning.",
215 "example": 5,
216 "nullable": true
217 },
218 "awb": {
219 "type": [
220 "string",
221 "null"
222 ],
223 "description": "Air Waybill number assigned by the courier partner for tracking this specific package throughout the delivery process.",
224 "example": "AWB1234567890",
225 "nullable": true
226 },
227 "pdf_links": {
228 "type": "object",
229 "description": "Dictionary containing PDF document links related to this package (labels, invoices, etc.). Always returns an object - empty object {} if no links are present, populated object if links exist. Users can update values by providing new key-value pairs.",
230 "additionalProperties": {
231 "type": "string",
232 "format": "uri"
233 },
234 "default": {},
235 "example": {
236 "label_a4": "https://sample.com/documents/label_a4/PDFs/17512794597831303808_label_a4.pdf",
237 "label_a6": "https://sample.com/documents/label_a6/PDFs/17512794597831303808_label_a6.pdf",
238 "label_pos": "https://sample.com/documents/label_pos/PDFs/17512794597831303808_label_pos.pdf"
239 }
240 },
241 "products": {
242 "type": "array",
243 "description": "List of products contained within this package. Each product specifies its line number, quantity, and identifier.",
244 "items": {
245 "type": "object",
246 "required": [
247 "line_number",
248 "quantity",
249 "identifier"
250 ],
251 "properties": {
252 "line_number": {
253 "type": "integer",
254 "description": "The line number of the product within the shipment, used for tracking and identification purposes.",
255 "example": 1
256 },
257 "quantity": {
258 "type": "number",
259 "description": "The quantity of the product included in this package.",
260 "example": 2
261 },
262 "identifier": {
263 "type": "string",
264 "description": "The unique identifier or SKU (Stock Keeping Unit) of the product. This is used to match products across packages and bags.",
265 "example": "PROD001"
266 }
267 }
268 },
269 "example": [
270 {
271 "line_number": 1,
272 "quantity": 2,
273 "identifier": "PROD001"
274 },
275 {
276 "line_number": 2,
277 "quantity": 1,
278 "identifier": "PROD002"
279 }
280 ]
281 }
282 }
283 }
284 },
285 "awb_number": {
286 "type": "string",
287 "description": "AWB number assigned"
288 },
289 "logistics_meta": {
290 "type": "object",
291 "description": "Contains metadata related to logistics and delivery operations. This field is intended to store supplementary information that supports shipment handling, courier interactions, and overall logistics workflows throughout the delivery lifecycle."
292 }
293 },
294 "required": [
295 "extension_id",
296 "mixed_cart",
297 "order_creation_time",
298 "MPS",
299 "qc_required",
300 "awb_number"
301 ]
302 },
303 "shipment_id": {
304 "type": "string"
305 }
306 },
307 "required": [
308 "courier-partner",
309 "shipment_id"
310 ]
311 }
312 }
313}
Payload Example
1{
2 "application_id": [
3 "625e5c3709a289b56d6d4621",
4 "*"
5 ],
6 "company_id": 2250,
7 "contains": [
8 "shipment_id",
9 "courier-partner"
10 ],
11 "event": {
12 "category": "application",
13 "created_timestamp": 1712041791,
14 "id": "Tz4/K0LgVBWRE7wRZpA+9lkREpWxKaR3T3mdecE6kTY=",
15 "name": "courier-partner",
16 "trace_id": [
17 "000000000000000047cd6c09bb46d1f1"
18 ],
19 "type": "cancel",
20 "version": "1"
21 },
22 "payload": {
23 "courier-partner": {
24 "MPS": false,
25 "awb_number": "998942173750",
26 "extension_id": "656f1f18c24dabc79325b1ba",
27 "mixed_cart": false,
28 "order_creation_time": "2024-03-25T18:41:09+00:00",
29 "qc_required": true,
30 "scheme_id": "65952a7b199ac0fd9537b1a7"
31 },
32 "shipment_id": "17117038817621037997"
33 }
34}