@gofynd/fdk-client-javascript 0.1.35

package/documentation/application/ORDER.md

@@ -0,0 +1,3428 @@
+
+
+
+
+##### [Back to Application docs](./README.md)
+
+## Order Methods
+Handles all Application order and shipment api(s)
+* [getOrders](#getorders)
+* [getOrderById](#getorderbyid)
+* [getPosOrderById](#getposorderbyid)
+* [getShipmentById](#getshipmentbyid)
+* [getInvoiceByShipmentId](#getinvoicebyshipmentid)
+* [trackShipment](#trackshipment)
+* [getCustomerDetailsByShipmentId](#getcustomerdetailsbyshipmentid)
+* [sendOtpToShipmentCustomer](#sendotptoshipmentcustomer)
+* [verifyOtpShipmentCustomer](#verifyotpshipmentcustomer)
+* [getShipmentBagReasons](#getshipmentbagreasons)
+* [getShipmentReasons](#getshipmentreasons)
+* [updateShipmentStatus](#updateshipmentstatus)
+
+
+
+## Methods with example and description
+
+
+### getOrders
+Get all orders
+
+
+
+```javascript
+// Promise
+const promise = order.getOrders({  status : value,
+ pageNo : value,
+ pageSize : value,
+ fromDate : value,
+ toDate : value,
+ customMeta : value });
+
+// Async/Await
+const data = await order.getOrders({  status : value,
+ pageNo : value,
+ pageSize : value,
+ fromDate : value,
+ toDate : value,
+ customMeta : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |  
+| status | number | no | A filter to retrieve orders by their current status such as _placed_, _delivered_, etc. |    
+| pageNo | number | no | The page number to navigate through the given set of results. Default value is 1. |    
+| pageSize | number | no | The number of items to retrieve in each page. Default value is 10. |    
+| fromDate | string | no | The date from which the orders should be retrieved. |    
+| toDate | string | no | The date till which the orders should be retrieved. |    
+| customMeta | string | no | A filter and retrieve data using special fields included for special use-cases |  
+
+
+
+Use this API to retrieve all the orders.
+
+*Returned Response:*
+
+
+
+
+[OrderList](#OrderList)
+
+Success. Returns all the orders. Check the example shown below or refer `OrderList` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getOrderById
+Get details of an order
+
+
+
+```javascript
+// Promise
+const promise = order.getOrderById({  orderId : value });
+
+// Async/Await
+const data = await order.getOrderById({  orderId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| orderId | string | yes | A unique number used for identifying and tracking your orders. |  
+
+
+
+Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID.
+
+*Returned Response:*
+
+
+
+
+[OrderById](#OrderById)
+
+Success. Check the example shown below or refer `OrderById` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "order": {
+    "bags_for_reorder": [
+      {
+        "item_id": 7500429,
+        "item_size": "OS",
+        "store_id": 50,
+        "seller_id": 33,
+        "article_assignment": {
+          "level": "multi-companies",
+          "strategy": "low-price"
+        },
+        "quantity": 3
+      }
+    ],
+    "user_info": {
+      "mobile": "9892133001",
+      "first_name": "User",
+      "last_name": "-",
+      "gender": "male"
+    },
+    "order_created_time": "2022-09-23T12:07:20.000Z",
+    "total_shipments_in_order": 2,
+    "order_id": "FY632D541F01152493D0",
+    "breakup_values": [
+      {
+        "name": "mrp_total",
+        "display": "MRP Total",
+        "value": 3000
+      },
+      {
+        "name": "sub_total",
+        "display": "Sub Total",
+        "value": 1797
+      },
+      {
+        "name": "coupon",
+        "display": "Coupon",
+        "value": 0
+      },
+      {
+        "name": "discount",
+        "display": "Discount",
+        "value": -1203
+      },
+      {
+        "name": "promotion",
+        "display": "Promotion",
+        "value": 0
+      },
+      {
+        "name": "reward_points",
+        "display": "Reward Points",
+        "value": 0
+      },
+      {
+        "name": "cashback_applied",
+        "display": "Cashback Applied",
+        "value": 0
+      },
+      {
+        "name": "delivery_charges",
+        "display": "Delivery Charges",
+        "value": 0
+      },
+      {
+        "name": "cod_charges",
+        "display": "COD Charges",
+        "value": 0
+      },
+      {
+        "name": "total",
+        "display": "Total",
+        "value": 1797
+      }
+    ],
+    "shipments": [
+      {
+        "order_id": "FY632D541F01152493D0",
+        "breakup_values": [
+          {
+            "name": "mrp_total",
+            "display": "MRP Total",
+            "value": 2000
+          },
+          {
+            "name": "sub_total",
+            "display": "Sub Total",
+            "value": 1198
+          },
+          {
+            "name": "coupon",
+            "display": "Coupon",
+            "value": 0
+          },
+          {
+            "name": "discount",
+            "display": "Discount",
+            "value": -802
+          },
+          {
+            "name": "promotion",
+            "display": "Promotion",
+            "value": 0
+          },
+          {
+            "name": "reward_points",
+            "display": "Reward Points",
+            "value": 0
+          },
+          {
+            "name": "cashback_applied",
+            "display": "Cashback Applied",
+            "value": 0
+          },
+          {
+            "name": "delivery_charges",
+            "display": "Delivery Charges",
+            "value": 0
+          },
+          {
+            "name": "cod_charges",
+            "display": "COD Charges",
+            "value": 0
+          },
+          {
+            "name": "total",
+            "display": "Total",
+            "value": 1198
+          }
+        ],
+        "beneficiary_details": false,
+        "shipment_created_at": "2022-09-23T12:07:35.000Z",
+        "shipment_id": "16639150404761166748K",
+        "shipment_status": {
+          "title": "Placed",
+          "value": "processing",
+          "hex_code": "#02D1CB"
+        },
+        "track_url": "",
+        "traking_no": "",
+        "awb_no": "",
+        "dp_name": "",
+        "tracking_details": [
+          {
+            "status": "Order Placed",
+            "time": "2022-09-23T12:07:35.000Z",
+            "is_passed": true,
+            "value": "processing"
+          },
+          {
+            "status": "Order Confirmed",
+            "time": "",
+            "is_passed": false,
+            "value": "confirmed"
+          },
+          {
+            "status": "Delivery Partner Assigned",
+            "time": "",
+            "is_passed": false,
+            "value": "dp_assigned"
+          },
+          {
+            "status": "In Transit",
+            "time": "",
+            "is_passed": false,
+            "value": "in_transit"
+          },
+          {
+            "status": "Out For Delivery",
+            "time": "",
+            "is_passed": false,
+            "value": "out_for_delivery"
+          },
+          {
+            "status": "Delivered",
+            "time": "",
+            "is_passed": false,
+            "value": "delivered"
+          }
+        ],
+        "total_bags": 1,
+        "order_type": null,
+        "promise": {
+          "show_promise": true,
+          "timestamp": {
+            "dp_promise": null,
+            "min": "2022-09-26T06:37:17+00:00",
+            "max": "2022-09-27T06:37:17+00:00"
+          }
+        },
+        "bags": [
+          {
+            "id": 67631,
+            "current_status": {
+              "status": "placed",
+              "updated_at": "2022-09-23T12:07:35+00:00",
+              "name": "Placed",
+              "journey_type": "forward"
+            },
+            "prices": {
+              "price_effective": 599,
+              "discount": 401,
+              "amount_paid": 599,
+              "coupon_effective_discount": 0,
+              "delivery_charge": 0,
+              "fynd_credits": 0,
+              "cod_charges": 0,
+              "refund_credit": 0,
+              "cashback": 0,
+              "refund_amount": 599,
+              "added_to_fynd_cash": false,
+              "cashback_applied": 0,
+              "gst_tax_percentage": 5,
+              "value_of_good": 570.48,
+              "price_marked": 1000,
+              "transfer_price": 0,
+              "brand_calculated_amount": 599,
+              "promotion_effective_discount": 0,
+              "coupon_value": 0,
+              "pm_price_split": {
+                "": 599
+              }
+            },
+            "item": {
+              "name": "FYND Black T-Shirt 03",
+              "brand": {
+                "name": "lacoste",
+                "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
+              },
+              "image": [
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
+              ],
+              "slug_key": "fynd-black-cotton-mens-t-shirt",
+              "size": "OS",
+              "code": "SHIRT-01",
+              "id": 7500429,
+              "category": {
+                "l1": [
+                  {
+                    "uid": 124,
+                    "name": "Apparel",
+                    "level": 1,
+                    "departments": [
+                      {
+                        "uid": 24,
+                        "name": "Crafts Of India"
+                      },
+                      {
+                        "uid": 8,
+                        "name": "Fashion"
+                      }
+                    ],
+                    "gated_category_types": {}
+                  }
+                ],
+                "l2": [
+                  {
+                    "uid": 50,
+                    "name": "Western Wear",
+                    "level": 2,
+                    "departments": [
+                      {
+                        "uid": 8,
+                        "name": "Fashion"
+                      }
+                    ],
+                    "gated_category_types": {}
+                  }
+                ],
+                "l3": [
+                  {
+                    "uid": 25,
+                    "name": "T-Shirts",
+                    "level": 3,
+                    "departments": [
+                      {
+                        "uid": 1,
+                        "name": "Men's Fashionjhjh"
+                      },
+                      {
+                        "uid": 8,
+                        "name": "Fashion"
+                      }
+                    ],
+                    "gated_category_types": {
+                      "food": false
+                    }
+                  }
+                ]
+              },
+              "seller_identifier": "SHIRT-01"
+            },
+            "financial_breakup": [
+              {
+                "price_effective": 599,
+                "discount": 401,
+                "amount_paid": 599,
+                "coupon_effective_discount": 0,
+                "delivery_charge": 0,
+                "fynd_credits": 0,
+                "cod_charges": 0,
+                "refund_credit": 0,
+                "cashback": 0,
+                "refund_amount": 599,
+                "added_to_fynd_cash": false,
+                "cashback_applied": 0,
+                "gst_tax_percentage": 5,
+                "value_of_good": 570.48,
+                "price_marked": 1000,
+                "transfer_price": 0,
+                "brand_calculated_amount": 599,
+                "promotion_effective_discount": 0,
+                "coupon_value": 0,
+                "pm_price_split": {
+                  "": 599
+                },
+                "size": "OS",
+                "total_units": 1,
+                "hsn_code": "62063000",
+                "identifiers": {
+                  "sku_code": "SHIRT-01"
+                },
+                "item_name": "FYND Black T-Shirt 03",
+                "gst_fee": "28.52",
+                "gst_tag": "SGST"
+              }
+            ],
+            "quantity": 2,
+            "can_cancel": true,
+            "can_return": false,
+            "delivery_date": null,
+            "returnable_date": null
+          }
+        ],
+        "size_info": {
+          "SHIRT-01": {
+            "quantity": 2,
+            "price_effective": 599,
+            "amount_paid": 599,
+            "price_marked": 1000,
+            "margin": 40.1
+          }
+        },
+        "total_details": {
+          "sizes": 1,
+          "total_price": 599,
+          "pieces": 2
+        },
+        "fulfilling_store": {
+          "name": "Jio-market-store4",
+          "company_id": 33,
+          "id": 50,
+          "code": "store3"
+        },
+        "fulfilling_company": {
+          "id": 33,
+          "name": "RELIANCE JIO INFOCOMM LIMITED"
+        },
+        "delivery_date": null,
+        "delivery_address": {
+          "id": "62dfe1d112b842b2959de99e",
+          "uid": 660,
+          "area": "asd",
+          "city": "Mumbai",
+          "name": "Vaishakh Shetty",
+          "email": null,
+          "phone": "9892133001",
+          "state": "Maharashtra",
+          "address": "dsa",
+          "country": "India",
+          "pincode": "400059",
+          "version": "1.0",
+          "address1": " asd",
+          "address2": "",
+          "landmark": "tr",
+          "latitude": 19.1157486,
+          "address_1": " asd",
+          "area_code": "400059",
+          "longitude": 72.8773159,
+          "created_at": "2022-09-22T18:19:29+00:00",
+          "updated_at": "2022-09-22T18:19:29+00:00",
+          "address_type": "home",
+          "country_code": "91",
+          "geo_location": {
+            "latitude": 19.1157486,
+            "longitude": 72.8773159
+          },
+          "area_code_slug": "pincode",
+          "delivery_address_id": 660,
+          "addressee_name": "Vaishakh Shetty",
+          "delivery_code_required": 1
+        },
+        "can_cancel": true,
+        "can_return": false,
+        "returnable_date": null,
+        "show_download_invoice": false,
+        "show_track_link": false,
+        "prices": {
+          "amount_paid": 1198,
+          "refund_amount": 1198,
+          "price_marked": 2000,
+          "cod_charges": 0,
+          "coupon_value": 0,
+          "discount": 802,
+          "cashback_applied": 0,
+          "delivery_charge": 0,
+          "fynd_credits": 0,
+          "cashback": 0,
+          "price_effective": 1198,
+          "refund_credit": 0,
+          "value_of_good": 1140.96,
+          "discount_percent": 40
+        },
+        "can_break": {
+          "bag_repriced": {
+            "can_break_entity": false
+          },
+          "cancelled_seller": {
+            "can_break_entity": false
+          },
+          "bag_not_verified": {
+            "can_break_entity": false
+          },
+          "product_not_available": {
+            "can_break_entity": false
+          },
+          "bag_invoiced": {
+            "can_break_entity": false
+          },
+          "store_reassigned": {
+            "can_break_entity": false
+          },
+          "cancelled_fynd": {
+            "can_break_entity": false
+          },
+          "cancelled_operations": {
+            "can_break_entity": true
+          },
+          "cancelled_customer": {
+            "can_break_entity": true
+          },
+          "bag_not_confirmed": {
+            "can_break_entity": true
+          },
+          "delivery_sla_breached": {
+            "can_break_entity": false
+          },
+          "bag_confirmed": {
+            "can_break_entity": true
+          }
+        },
+        "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
+        "payment": {
+          "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
+          "mode": "Jio Partner Pay",
+          "mop": "PREPAID",
+          "status": "Paid"
+        },
+        "user_info": {
+          "email": "paymentsdummy@gofynd.com",
+          "gender": "male",
+          "mobile": "9892133001",
+          "name": "User -"
+        },
+        "comment": "",
+        "invoice": {
+          "updated_date": "1970-01-01T00:00:00.000Z",
+          "store_invoice_id": null,
+          "invoice_url": "",
+          "label_url": ""
+        },
+        "refund_details": {
+          "rrn": null
+        }
+      },
+      {
+        "order_id": "FY632D541F01152493D0",
+        "breakup_values": [
+          {
+            "name": "mrp_total",
+            "display": "MRP Total",
+            "value": 1000
+          },
+          {
+            "name": "sub_total",
+            "display": "Sub Total",
+            "value": 599
+          },
+          {
+            "name": "coupon",
+            "display": "Coupon",
+            "value": 0
+          },
+          {
+            "name": "discount",
+            "display": "Discount",
+            "value": -401
+          },
+          {
+            "name": "promotion",
+            "display": "Promotion",
+            "value": 0
+          },
+          {
+            "name": "reward_points",
+            "display": "Reward Points",
+            "value": 0
+          },
+          {
+            "name": "cashback_applied",
+            "display": "Cashback Applied",
+            "value": 0
+          },
+          {
+            "name": "delivery_charges",
+            "display": "Delivery Charges",
+            "value": 0
+          },
+          {
+            "name": "cod_charges",
+            "display": "COD Charges",
+            "value": 0
+          },
+          {
+            "name": "total",
+            "display": "Total",
+            "value": 599
+          }
+        ],
+        "beneficiary_details": false,
+        "shipment_created_at": "2022-09-23T12:07:58.000Z",
+        "shipment_id": "16639150772951172388K",
+        "shipment_status": {
+          "title": "Refund Initiated",
+          "value": "refund_initiated",
+          "hex_code": "#FE8F46"
+        },
+        "track_url": "",
+        "traking_no": "",
+        "awb_no": "",
+        "dp_name": "",
+        "tracking_details": [
+          {
+            "status": "Order Placed",
+            "time": "2022-09-23T12:07:35.000Z",
+            "is_passed": true,
+            "value": "processing"
+          },
+          {
+            "status": "Cancelled",
+            "time": "2022-09-23T12:07:57.000Z",
+            "is_passed": true,
+            "value": "cancelled"
+          },
+          {
+            "status": "Refund Processing",
+            "time": "2022-09-23T12:07:58.000Z",
+            "is_passed": true,
+            "value": "refund_initiated",
+            "tracking_details": [
+              {
+                "status": "Refund Initiated",
+                "time": "2022-09-23T12:07:58.000Z",
+                "is_passed": true,
+                "value": "refund_initiated"
+              },
+              {
+                "status": "Refund Completed",
+                "time": "",
+                "is_passed": false,
+                "value": "refund_done"
+              }
+            ]
+          }
+        ],
+        "total_bags": 1,
+        "order_type": null,
+        "promise": {
+          "show_promise": false,
+          "timestamp": {
+            "dp_promise": null,
+            "min": "2022-09-26T06:37:17+00:00",
+            "max": "2022-09-27T06:37:17+00:00"
+          }
+        },
+        "bags": [
+          {
+            "id": 67632,
+            "current_status": {
+              "status": "refund_acknowledged",
+              "updated_at": "2022-09-23T12:07:58+00:00",
+              "name": "Refund Acknowledged",
+              "journey_type": null
+            },
+            "prices": {
+              "price_effective": 599,
+              "discount": 401,
+              "amount_paid": 599,
+              "coupon_effective_discount": 0,
+              "delivery_charge": 0,
+              "fynd_credits": 0,
+              "cod_charges": 0,
+              "refund_credit": 0,
+              "cashback": 0,
+              "refund_amount": 599,
+              "added_to_fynd_cash": false,
+              "cashback_applied": 0,
+              "gst_tax_percentage": 5,
+              "value_of_good": 570.48,
+              "price_marked": 1000,
+              "transfer_price": 0,
+              "brand_calculated_amount": 599,
+              "promotion_effective_discount": 0,
+              "coupon_value": 0,
+              "pm_price_split": {
+                "": 599
+              }
+            },
+            "item": {
+              "name": "FYND Black T-Shirt 03",
+              "brand": {
+                "name": "lacoste",
+                "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/JK1ZUAgrl-Logo.png"
+              },
+              "image": [
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/Cg5vRX38t-FYND-Black-Cotton-Mens-T-shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QkYTI_VBn-FYND-Black-Cotton-Mens-T-shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/QRNIZFn7_-FYND-Black-T-Shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/TJLO6V8dW-FYND-Black-T-Shirt.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/h0HW_3rr5-FYND-Black-T-Shirt-01.jpeg",
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/u1zbaCncl-FYND-Black-T-Shirt-01.jpeg"
+              ],
+              "slug_key": "fynd-black-cotton-mens-t-shirt",
+              "size": "OS",
+              "code": "SHIRT-01",
+              "id": 7500429,
+              "category": {
+                "l1": [
+                  {
+                    "uid": 124,
+                    "name": "Apparel",
+                    "level": 1,
+                    "departments": [
+                      {
+                        "uid": 24,
+                        "name": "Crafts Of India"
+                      },
+                      {
+                        "uid": 8,
+                        "name": "Fashion"
+                      }
+                    ],
+                    "gated_category_types": {}
+                  }
+                ],
+                "l2": [
+                  {
+                    "uid": 50,
+                    "name": "Western Wear",
+                    "level": 2,
+                    "departments": [
+                      {
+                        "uid": 8,
+                        "name": "Fashion"
+                      }
+                    ],
+                    "gated_category_types": {}
+                  }
+                ],
+                "l3": [
+                  {
+                    "uid": 25,
+                    "name": "T-Shirts",
+                    "level": 3,
+                    "departments": [
+                      {
+                        "uid": 1,
+                        "name": "Men's Fashionjhjh"
+                      },
+                      {
+                        "uid": 8,
+                        "name": "Fashion"
+                      }
+                    ],
+                    "gated_category_types": {
+                      "food": false
+                    }
+                  }
+                ]
+              },
+              "seller_identifier": "SHIRT-01"
+            },
+            "financial_breakup": [
+              {
+                "price_effective": 599,
+                "discount": 401,
+                "amount_paid": 599,
+                "coupon_effective_discount": 0,
+                "delivery_charge": 0,
+                "fynd_credits": 0,
+                "cod_charges": 0,
+                "refund_credit": 0,
+                "cashback": 0,
+                "refund_amount": 599,
+                "added_to_fynd_cash": false,
+                "cashback_applied": 0,
+                "gst_tax_percentage": 5,
+                "value_of_good": 570.48,
+                "price_marked": 1000,
+                "transfer_price": 0,
+                "brand_calculated_amount": 599,
+                "promotion_effective_discount": 0,
+                "coupon_value": 0,
+                "pm_price_split": {
+                  "": 599
+                },
+                "size": "OS",
+                "total_units": 1,
+                "hsn_code": "62063000",
+                "identifiers": {
+                  "sku_code": "SHIRT-01"
+                },
+                "item_name": "FYND Black T-Shirt 03",
+                "gst_fee": "28.52",
+                "gst_tag": "SGST"
+              }
+            ],
+            "quantity": 1,
+            "can_cancel": false,
+            "can_return": false,
+            "delivery_date": null,
+            "returnable_date": null
+          }
+        ],
+        "size_info": {
+          "SHIRT-01": {
+            "quantity": 1,
+            "price_effective": 599,
+            "amount_paid": 599,
+            "price_marked": 1000,
+            "margin": 40.1
+          }
+        },
+        "total_details": {
+          "sizes": 1,
+          "total_price": 599,
+          "pieces": 1
+        },
+        "fulfilling_store": {
+          "name": "Jio-market-store4",
+          "company_id": 33,
+          "id": 50,
+          "code": "store3"
+        },
+        "fulfilling_company": {
+          "id": 33,
+          "name": "RELIANCE JIO INFOCOMM LIMITED"
+        },
+        "delivery_date": null,
+        "delivery_address": {
+          "id": "62dfe1d112b842b2959de99e",
+          "uid": 660,
+          "area": "asd",
+          "city": "Mumbai",
+          "name": "Vaishakh Shetty",
+          "email": null,
+          "phone": "9892133001",
+          "state": "Maharashtra",
+          "address": "dsa",
+          "country": "India",
+          "pincode": "400059",
+          "version": "1.0",
+          "address1": " asd",
+          "address2": "",
+          "landmark": "tr",
+          "latitude": 19.1157486,
+          "address_1": " asd",
+          "area_code": "400059",
+          "longitude": 72.8773159,
+          "created_at": "2022-09-22T18:19:29+00:00",
+          "updated_at": "2022-09-22T18:19:29+00:00",
+          "address_type": "home",
+          "country_code": "91",
+          "geo_location": {
+            "latitude": 19.1157486,
+            "longitude": 72.8773159
+          },
+          "area_code_slug": "pincode",
+          "delivery_address_id": 660,
+          "addressee_name": "Vaishakh Shetty",
+          "delivery_code_required": 1
+        },
+        "can_cancel": false,
+        "can_return": false,
+        "returnable_date": null,
+        "show_download_invoice": false,
+        "show_track_link": false,
+        "prices": {
+          "amount_paid": 599,
+          "refund_amount": 599,
+          "price_marked": 1000,
+          "cod_charges": 0,
+          "coupon_value": 0,
+          "discount": 401,
+          "cashback_applied": 0,
+          "delivery_charge": 0,
+          "fynd_credits": 0,
+          "cashback": 0,
+          "price_effective": 599,
+          "refund_credit": 0,
+          "value_of_good": 570.48,
+          "discount_percent": 40
+        },
+        "can_break": {
+          "refund_completed": {
+            "can_break_entity": false
+          },
+          "rto_delivery_attempt_failed": {
+            "can_break_entity": false
+          },
+          "return_rejected_by_dp": {
+            "can_break_entity": false
+          },
+          "return_to_origin": {
+            "can_break_entity": false
+          },
+          "rto_initiated": {
+            "can_break_entity": false
+          },
+          "refund_failed": {
+            "can_break_entity": false
+          },
+          "bag_picked": {
+            "can_break_entity": false
+          },
+          "rto_bag_delivered": {
+            "can_break_entity": false
+          },
+          "return_dp_assigned": {
+            "can_break_entity": false
+          },
+          "return_bag_in_transit": {
+            "can_break_entity": false
+          },
+          "return_bag_out_for_delivery": {
+            "can_break_entity": false
+          },
+          "return_initiated": {
+            "can_break_entity": true
+          },
+          "return_rejected_by_store": {
+            "can_break_entity": false
+          },
+          "rto_bag_out_for_delivery": {
+            "can_break_entity": false
+          },
+          "deadstock": {
+            "can_break_entity": false
+          },
+          "bag_lost": {
+            "can_break_entity": false
+          },
+          "return_bag_delivered": {
+            "can_break_entity": false
+          },
+          "return_completed": {
+            "can_break_entity": false
+          },
+          "return_bag_picked": {
+            "can_break_entity": false
+          },
+          "rto_bag_accepted": {
+            "can_break_entity": false
+          },
+          "deadstock_defective": {
+            "can_break_entity": false
+          },
+          "rto_in_transit": {
+            "can_break_entity": false
+          },
+          "return_accepted": {
+            "can_break_entity": false
+          },
+          "out_for_pickup": {
+            "can_break_entity": false
+          },
+          "return_bag_not_delivered": {
+            "can_break_entity": false
+          },
+          "cancelled_customer": {
+            "can_break_entity": true
+          },
+          "return_bag_lost": {
+            "can_break_entity": false
+          }
+        },
+        "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
+        "payment": {
+          "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
+          "mode": "Jio Partner Pay",
+          "mop": "PREPAID",
+          "status": "Paid"
+        },
+        "user_info": {
+          "email": "paymentsdummy@gofynd.com",
+          "gender": "male",
+          "mobile": "9892133001",
+          "name": "User -"
+        },
+        "comment": "",
+        "invoice": {
+          "updated_date": "1970-01-01T00:00:00.000Z",
+          "store_invoice_id": null,
+          "invoice_url": "",
+          "label_url": ""
+        },
+        "refund_details": {
+          "rrn": ""
+        }
+      }
+    ],
+    "is_validated": false
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getPosOrderById
+Get POS Order
+
+
+
+```javascript
+// Promise
+const promise = order.getPosOrderById({  orderId : value });
+
+// Async/Await
+const data = await order.getPosOrderById({  orderId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| orderId | string | yes | A unique number used for identifying and tracking your orders. |  
+
+
+
+Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID.
+
+*Returned Response:*
+
+
+
+
+[OrderList](#OrderList)
+
+Success. Check the example shown below or refer `PosOrderById` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "order": {
+    "order_created_time": "2022-08-11T16:09:17.000Z",
+    "total_shipments_in_order": 1,
+    "order_id": "FY62F4CE260113EFCC64",
+    "breakup_values": [
+      {
+        "name": "mrp_total",
+        "display": "MRP Total",
+        "value": 1000
+      },
+      {
+        "name": "sub_total",
+        "display": "Sub Total",
+        "value": 999
+      },
+      {
+        "name": "coupon",
+        "display": "Coupon",
+        "value": 0
+      },
+      {
+        "name": "discount",
+        "display": "Discount",
+        "value": -1
+      },
+      {
+        "name": "promotion",
+        "display": "Promotion",
+        "value": 0
+      },
+      {
+        "name": "reward_points",
+        "display": "Reward Points",
+        "value": 0
+      },
+      {
+        "name": "cashback_applied",
+        "display": "Cashback Applied",
+        "value": 0
+      },
+      {
+        "name": "delivery_charges",
+        "display": "Delivery Charges",
+        "value": 0
+      },
+      {
+        "name": "cod_charges",
+        "display": "COD Charges",
+        "value": 0
+      },
+      {
+        "name": "total",
+        "display": "Total",
+        "value": 999
+      }
+    ],
+    "shipments": [
+      {
+        "order_id": "FY62F4CE260113EFCC64",
+        "breakup_values": [
+          {
+            "name": "mrp_total",
+            "display": "MRP Total",
+            "value": 1000
+          },
+          {
+            "name": "sub_total",
+            "display": "Sub Total",
+            "value": 999
+          },
+          {
+            "name": "coupon",
+            "display": "Coupon",
+            "value": 0
+          },
+          {
+            "name": "discount",
+            "display": "Discount",
+            "value": -1
+          },
+          {
+            "name": "promotion",
+            "display": "Promotion",
+            "value": 0
+          },
+          {
+            "name": "reward_points",
+            "display": "Reward Points",
+            "value": 0
+          },
+          {
+            "name": "cashback_applied",
+            "display": "Cashback Applied",
+            "value": 0
+          },
+          {
+            "name": "delivery_charges",
+            "display": "Delivery Charges",
+            "value": 0
+          },
+          {
+            "name": "cod_charges",
+            "display": "COD Charges",
+            "value": 0
+          },
+          {
+            "name": "total",
+            "display": "Total",
+            "value": 999
+          }
+        ],
+        "beneficiary_details": false,
+        "shipment_created_at": "2022-08-22T21:33:33.000Z",
+        "shipment_id": "16602143565551542371K",
+        "shipment_status": {
+          "title": "DP Assigned",
+          "value": "dp_assigned",
+          "hex_code": "#FE8F46"
+        },
+        "track_url": "",
+        "traking_no": "Tracking No.: 118022046",
+        "awb_no": "118022046",
+        "dp_name": "ecom_jio",
+        "tracking_details": [
+          {
+            "status": "Order Placed",
+            "time": "2022-08-11T16:09:17.000Z",
+            "is_passed": true,
+            "value": "processing"
+          },
+          {
+            "status": "Order Confirmed",
+            "time": "2022-08-22T17:14:02.000Z",
+            "is_passed": true,
+            "value": "confirmed"
+          },
+          {
+            "status": "Delivery Partner Assigned",
+            "time": "2022-08-22T17:14:13.000Z",
+            "is_passed": true,
+            "value": "dp_assigned"
+          },
+          {
+            "status": "In Transit",
+            "time": "",
+            "is_passed": false,
+            "value": "in_transit"
+          },
+          {
+            "status": "Out For Delivery",
+            "time": "",
+            "is_passed": false,
+            "value": "out_for_delivery"
+          },
+          {
+            "status": "Delivered",
+            "time": "",
+            "is_passed": false,
+            "value": "delivered"
+          }
+        ],
+        "total_bags": 1,
+        "order_type": null,
+        "promise": {
+          "show_promise": false,
+          "timestamp": {
+            "dp_promise": null,
+            "min": "2022-08-15T09:38:44+00:00",
+            "max": "2022-08-18T09:38:44+00:00"
+          }
+        },
+        "bags": [
+          {
+            "id": 59987,
+            "current_status": {
+              "status": "bag_not_picked",
+              "updated_at": "2022-08-22T21:33:33+00:00",
+              "name": "Bag Not Picked",
+              "journey_type": "forward"
+            },
+            "prices": {
+              "price_effective": 999,
+              "discount": 1,
+              "amount_paid": 999,
+              "coupon_effective_discount": 0,
+              "delivery_charge": 0,
+              "fynd_credits": 0,
+              "cod_charges": 0,
+              "refund_credit": 0,
+              "cashback": 0,
+              "refund_amount": 999,
+              "added_to_fynd_cash": false,
+              "cashback_applied": 0,
+              "gst_tax_percentage": 18,
+              "value_of_good": 846.61,
+              "price_marked": 1000,
+              "transfer_price": 0,
+              "brand_calculated_amount": 999,
+              "promotion_effective_discount": 0,
+              "coupon_value": 0,
+              "pm_price_split": {
+                "Net Banking": 999
+              }
+            },
+            "item": {
+              "name": "Puma Men Tshirt",
+              "brand": {
+                "name": "Dabur",
+                "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/kv5DZy0J8-Logo.jpeg"
+              },
+              "image": [
+                "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/e6qJ_Bihn-61x838nYQUL._UL1440_.jpg"
+              ],
+              "slug_key": "puma-men-tshirt",
+              "size": "OS",
+              "code": "PUMATSHIRT",
+              "id": 7507572,
+              "category": [],
+              "seller_identifier": "PUMATSHIRT"
+            },
+            "financial_breakup": [
+              {
+                "price_effective": 999,
+                "discount": 1,
+                "amount_paid": 999,
+                "coupon_effective_discount": 0,
+                "delivery_charge": 0,
+                "fynd_credits": 0,
+                "cod_charges": 0,
+                "refund_credit": 0,
+                "cashback": 0,
+                "refund_amount": 999,
+                "added_to_fynd_cash": false,
+                "cashback_applied": 0,
+                "gst_tax_percentage": 18,
+                "value_of_good": 846.61,
+                "price_marked": 1000,
+                "transfer_price": 0,
+                "brand_calculated_amount": 999,
+                "promotion_effective_discount": 0,
+                "coupon_value": 0,
+                "pm_price_split": {
+                  "Net Banking": 999
+                },
+                "size": "OS",
+                "total_units": 1,
+                "hsn_code": "99972900",
+                "identifiers": {
+                  "sku_code": "PUMATSHIRT"
+                },
+                "item_name": "Puma Men Tshirt",
+                "gst_fee": "152.38",
+                "gst_tag": "IGST"
+              }
+            ],
+            "quantity": 1
+          }
+        ],
+        "size_info": {
+          "PUMATSHIRT": {
+            "quantity": 1,
+            "price_effective": 999,
+            "amount_paid": 999,
+            "price_marked": 1000,
+            "margin": 0.1
+          }
+        },
+        "total_details": {
+          "sizes": 1,
+          "total_price": 999,
+          "pieces": 1
+        },
+        "fulfilling_store": {
+          "name": "jio-location",
+          "company_id": 41,
+          "id": 8,
+          "code": "jio-location"
+        },
+        "fulfilling_company": {
+          "id": 41,
+          "name": "Jio"
+        }
+      }
+    ],
+    "is_validated": false
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getShipmentById
+Get details of a shipment
+
+
+
+```javascript
+// Promise
+const promise = order.getShipmentById({  shipmentId : value });
+
+// Async/Await
+const data = await order.getShipmentById({  shipmentId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+
+
+
+Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID.
+
+*Returned Response:*
+
+
+
+
+[ShipmentById](#ShipmentById)
+
+Success. Check the example shown below or refer `ShipmentById` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "shipment": {
+    "order_id": "FY62F3B8290150D13E36",
+    "breakup_values": [
+      {
+        "name": "mrp_total",
+        "display": "MRP Total",
+        "value": 50
+      },
+      {
+        "name": "sub_total",
+        "display": "Sub Total",
+        "value": 50
+      },
+      {
+        "name": "coupon",
+        "display": "Coupon",
+        "value": 0
+      },
+      {
+        "name": "discount",
+        "display": "Discount",
+        "value": 0
+      },
+      {
+        "name": "promotion",
+        "display": "Promotion",
+        "value": 0
+      },
+      {
+        "name": "reward_points",
+        "display": "Reward Points",
+        "value": 0
+      },
+      {
+        "name": "cashback_applied",
+        "display": "Cashback Applied",
+        "value": 0
+      },
+      {
+        "name": "delivery_charges",
+        "display": "Delivery Charges",
+        "value": 0
+      },
+      {
+        "name": "cod_charges",
+        "display": "COD Charges",
+        "value": 0
+      },
+      {
+        "name": "total",
+        "display": "Total",
+        "value": 50
+      }
+    ],
+    "beneficiary_details": false,
+    "need_help_url": "https://fynd.freshdesk.com/support/solutions/33000003306",
+    "shipment_created_at": "2022-08-10T19:22:42.000Z",
+    "shipment_id": "16601395620321798247K",
+    "shipment_status": {
+      "title": "DP Assigned",
+      "value": "dp_assigned",
+      "hex_code": "#FE8F46"
+    },
+    "track_url": "",
+    "traking_no": "Tracking No.: 5923410031146",
+    "awb_no": "5923410031146",
+    "dp_name": "delhivery_jio_surface",
+    "tracking_details": [
+      {
+        "status": "Order Placed",
+        "time": "2022-08-10T19:22:55.000Z",
+        "is_passed": true,
+        "value": "processing"
+      },
+      {
+        "status": "Order Confirmed",
+        "time": "2022-08-18T19:11:02.000Z",
+        "is_passed": true,
+        "value": "confirmed"
+      },
+      {
+        "status": "Delivery Partner Assigned",
+        "time": "2022-08-18T19:11:38.000Z",
+        "is_passed": true,
+        "value": "dp_assigned"
+      },
+      {
+        "status": "In Transit",
+        "time": "",
+        "is_passed": false,
+        "value": "in_transit"
+      },
+      {
+        "status": "Out For Delivery",
+        "time": "",
+        "is_passed": false,
+        "value": "out_for_delivery"
+      },
+      {
+        "status": "Delivered",
+        "time": "",
+        "is_passed": false,
+        "value": "delivered"
+      }
+    ],
+    "total_bags": 1,
+    "promise": {
+      "show_promise": false,
+      "timestamp": {
+        "min": "2022-08-14T13:52:37+00:00",
+        "max": "2022-08-17T13:52:37+00:00",
+        "dp_promise": null
+      }
+    },
+    "bags": [
+      {
+        "id": 59624,
+        "current_status": {
+          "status": "bag_not_picked",
+          "updated_at": "2022-08-18T23:46:11+00:00",
+          "name": "Bag Not Picked",
+          "journey_type": "forward"
+        },
+        "prices": {
+          "price_effective": 50,
+          "discount": 0,
+          "amount_paid": 50,
+          "coupon_effective_discount": 0,
+          "delivery_charge": 0,
+          "fynd_credits": 0,
+          "cod_charges": 0,
+          "refund_credit": 0,
+          "cashback": 0,
+          "refund_amount": 50,
+          "added_to_fynd_cash": false,
+          "cashback_applied": 0,
+          "gst_tax_percentage": 18,
+          "value_of_good": 42.37,
+          "price_marked": 50,
+          "transfer_price": 0,
+          "brand_calculated_amount": 50,
+          "promotion_effective_discount": 0,
+          "coupon_value": 0,
+          "pm_price_split": {
+            "COD": 50
+          }
+        },
+        "item": {
+          "name": "Tissues",
+          "brand": {
+            "name": "Zepto",
+            "logo": "https://hdn-1.jiomarketx0.de/x0/brands/pictures/square-logo/original/5XLRHXC5H-Logo.png"
+          },
+          "image": [
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/hGov80Pbv-411yLXtNYNL._SL1000_.jpg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg",
+            "https://hdn-1.jiomarketx0.de/x0/products/pictures/item/free/270x0/U-6bpneFP-Tissues.jpeg"
+          ],
+          "slug_key": "tissues",
+          "size": "OS",
+          "code": "TIS-102",
+          "id": 7500474,
+          "seller_identifier": "987432134"
+        },
+        "financial_breakup": [
+          {
+            "price_effective": 50,
+            "discount": 0,
+            "amount_paid": 50,
+            "coupon_effective_discount": 0,
+            "delivery_charge": 0,
+            "fynd_credits": 0,
+            "cod_charges": 0,
+            "refund_credit": 0,
+            "cashback": 0,
+            "refund_amount": 50,
+            "added_to_fynd_cash": false,
+            "cashback_applied": 0,
+            "gst_tax_percentage": 18,
+            "value_of_good": 42.37,
+            "price_marked": 50,
+            "transfer_price": 0,
+            "brand_calculated_amount": 50,
+            "promotion_effective_discount": 0,
+            "coupon_value": 0,
+            "pm_price_split": {
+              "COD": 50
+            },
+            "size": "OS",
+            "total_units": 1,
+            "hsn_code": "70099200",
+            "identifiers": {
+              "sku_code": "987432134"
+            },
+            "item_name": "Tissues",
+            "gst_fee": "7.62",
+            "gst_tag": "SGST"
+          }
+        ],
+        "quantity": 1,
+        "departments": [
+          31
+        ],
+        "can_cancel": false,
+        "can_return": false
+      }
+    ],
+    "size_info": {
+      "TIS-102": {
+        "quantity": 1,
+        "price_effective": 50,
+        "amount_paid": 50,
+        "price_marked": 50,
+        "margin": 0
+      }
+    },
+    "total_details": {
+      "sizes": 1,
+      "total_price": 50,
+      "pieces": 1
+    },
+    "fulfilling_store": {
+      "name": "Jio-market-store3",
+      "company_id": 33,
+      "id": 50,
+      "code": "store3"
+    },
+    "fulfilling_company": {
+      "id": 33,
+      "name": "RELIANCE JIO INFOCOMM LIMITED"
+    },
+    "delivery_address": {
+      "id": "62e8fc91c1700b808fe528bd",
+      "uid": 745,
+      "area": "test",
+      "city": "Mumbai",
+      "name": "abc",
+      "email": "abc@gofynd.com",
+      "phone": "1234567890",
+      "state": "Maharashtra",
+      "address": "1234",
+      "country": "India",
+      "pincode": "400074",
+      "version": "1.0",
+      "address1": " test",
+      "address2": "",
+      "landmark": "test",
+      "latitude": 19.0653252,
+      "address_1": " test",
+      "area_code": "400074",
+      "longitude": 72.8423802,
+      "created_at": "2022-08-10T18:52:38+00:00",
+      "updated_at": "2022-08-10T18:52:38+00:00",
+      "address_type": "home",
+      "country_code": "91",
+      "geo_location": {
+        "latitude": 19.0653252,
+        "longitude": 72.8423802
+      },
+      "area_code_slug": "pincode",
+      "delivery_address_id": 745,
+      "addressee_name": "abc",
+      "delivery_code_required": 1
+    },
+    "can_cancel": false,
+    "can_return": false,
+    "delivery_date": null,
+    "returnable_date": null,
+    "show_download_invoice": true,
+    "show_track_link": true,
+    "prices": {
+      "amount_paid": 50,
+      "refund_amount": 50,
+      "price_marked": 50,
+      "cod_charges": 0,
+      "coupon_value": 0,
+      "discount": 0,
+      "cashback_applied": 0,
+      "delivery_charge": 0,
+      "fynd_credits": 0,
+      "cashback": 0,
+      "price_effective": 50,
+      "refund_credit": 0,
+      "value_of_good": 42.37
+    },
+    "can_break": {
+      "bag_not_picked": {
+        "can_break_entity": false
+      },
+      "cancelled_customer": {
+        "can_break_entity": true
+      },
+      "bag_picked": {
+        "can_break_entity": false
+      },
+      "cancelled_fynd": {
+        "can_break_entity": true
+      },
+      "bag_rescheduled": {
+        "can_break_entity": false
+      },
+      "cancelled_at_dp": {
+        "can_break_entity": false
+      },
+      "handed_over_to_dg": {
+        "can_break_entity": false
+      },
+      "dp_assigned": {
+        "can_break_entity": false
+      },
+      "cancelled_operations": {
+        "can_break_entity": false
+      },
+      "cancelled_seller": {
+        "can_break_entity": false
+      },
+      "out_for_pickup": {
+        "can_break_entity": false
+      },
+      "bag_pick_failed": {
+        "can_break_entity": false
+      },
+      "update_qr_code": {
+        "can_break_entity": false
+      }
+    },
+    "payment": {
+      "logo": "https://hdn-1.fynd.com/payment/Pos+Logo.png",
+      "mode": "Jio Partner Pay",
+      "mop": "COD",
+      "display_name": "COD",
+      "payment_mode": "COD",
+      "status": "Unpaid"
+    },
+    "user_info": {
+      "email": "paymentsdummy@gofynd.com",
+      "gender": "male",
+      "mobile": "1234567890",
+      "name": "User -"
+    },
+    "comment": "",
+    "invoice": {
+      "updated_date": "2022-08-18T19:11:02.000Z",
+      "store_invoice_id": "00000050AA000147",
+      "invoice_url": "",
+      "label_url": ""
+    },
+    "refund_details": {
+      "rrn": ""
+    }
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getInvoiceByShipmentId
+Get Invoice of a shipment
+
+
+
+```javascript
+// Promise
+const promise = order.getInvoiceByShipmentId({  shipmentId : value });
+
+// Async/Await
+const data = await order.getInvoiceByShipmentId({  shipmentId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| shipmentId | string | yes | ID of the shipment. |  
+
+
+
+Use this API to retrieve shipment invoice.
+
+*Returned Response:*
+
+
+
+
+[ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
+
+Success. Check the example shown below or refer `ShipmentById` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### trackShipment
+Track shipment
+
+
+
+```javascript
+// Promise
+const promise = order.trackShipment({  shipmentId : value });
+
+// Async/Await
+const data = await order.trackShipment({  shipmentId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+
+
+
+Track Shipment by shipment id, for application based on application Id
+
+*Returned Response:*
+
+
+
+
+[ShipmentTrack](#ShipmentTrack)
+
+Success. Check the example shown below or refer `ShipmentTrack` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "results": [
+    {
+      "awb": "string",
+      "updated_at": "string",
+      "last_location_recieved_at": "string",
+      "reason": "string",
+      "shipment_type": "string",
+      "status": "string",
+      "updated_time": "string",
+      "account_name": "string"
+    }
+  ]
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getCustomerDetailsByShipmentId
+Get Customer Details by Shipment Id
+
+
+
+```javascript
+// Promise
+const promise = order.getCustomerDetailsByShipmentId({  orderId : value,
+ shipmentId : value });
+
+// Async/Await
+const data = await order.getCustomerDetailsByShipmentId({  orderId : value,
+ shipmentId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| orderId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |   
+| shipmentId | string | yes | A unique number used for identifying and tracking your orders. |  
+
+
+
+Use this API to retrieve customer details such as mobileno using Shipment ID.
+
+*Returned Response:*
+
+
+
+
+[CustomerDetailsResponse](#CustomerDetailsResponse)
+
+Success. Check the example shown below or refer `CustomerDetailsByShipmentId` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "order_id": "FYMP629D972D01B6BD76",
+  "shipment_id": "16544950215681060915J",
+  "name": "sagar Kulkarni",
+  "phone": "XXX-XXX-6780",
+  "country": "India"
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### sendOtpToShipmentCustomer
+Send and Resend Otp code to Order-Shipment customer
+
+
+
+```javascript
+// Promise
+const promise = order.sendOtpToShipmentCustomer({  orderId : value,
+ shipmentId : value });
+
+// Async/Await
+const data = await order.sendOtpToShipmentCustomer({  orderId : value,
+ shipmentId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| orderId | string | yes | A unique number used for identifying and tracking your orders. |   
+| shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+
+
+
+Use this API to send OTP to the customer of the mapped Shipment.
+
+*Returned Response:*
+
+
+
+
+[SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
+
+Success to acknowledge the service was notified
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "success": true,
+  "request_id": "0fe0d6e16205ddc57d212e947ee31896",
+  "message": "OTP sent",
+  "resend_timer": 30
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### verifyOtpShipmentCustomer
+Verify Otp code
+
+
+
+```javascript
+// Promise
+const promise = order.verifyOtpShipmentCustomer({  orderId : value,
+ shipmentId : value,
+ body : value });
+
+// Async/Await
+const data = await order.verifyOtpShipmentCustomer({  orderId : value,
+ shipmentId : value,
+ body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| orderId | string | yes | A unique number used for identifying and tracking your orders. |   
+| shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+| body | [VerifyOtp](#VerifyOtp) | yes | Request body |
+
+
+Use this API to verify OTP and create a session token with custom payload.
+
+*Returned Response:*
+
+
+
+
+[VerifyOtpResponse](#VerifyOtpResponse)
+
+Success, the code is valid and returns a session token
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getShipmentBagReasons
+Get reasons behind full or partial cancellation of a shipment
+
+
+
+```javascript
+// Promise
+const promise = order.getShipmentBagReasons({  shipmentId : value,
+ bagId : value });
+
+// Async/Await
+const data = await order.getShipmentBagReasons({  shipmentId : value,
+ bagId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| shipmentId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |   
+| bagId | string | yes | ID of the bag. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+
+
+
+Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
+
+*Returned Response:*
+
+
+
+
+[ShipmentBagReasons](#ShipmentBagReasons)
+
+Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "success": true,
+  "reasons": [
+    {
+      "id": 1,
+      "display_name": "Not available",
+      "qc_type": [],
+      "question_set": []
+    },
+    {
+      "reasons": [
+        {
+          "id": 2,
+          "display_name": "Processing other orders",
+          "qc_type": [],
+          "question_set": []
+        },
+        {
+          "id": 3,
+          "display_name": "Printer not working",
+          "qc_type": [],
+          "question_set": []
+        },
+        {
+          "reasons": [
+            {
+              "id": 4,
+              "display_name": "Card issues",
+              "qc_type": [],
+              "question_set": []
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "id": 4,
+      "display_name": "Card issues",
+      "qc_type": [],
+      "question_set": []
+    }
+  ]
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getShipmentReasons
+Get reasons behind full or partial cancellation of a shipment
+
+
+
+```javascript
+// Promise
+const promise = order.getShipmentReasons({  shipmentId : value });
+
+// Async/Await
+const data = await order.getShipmentReasons({  shipmentId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+
+
+
+Use this API to retrieve the issues that led to the cancellation of bags within a shipment.
+
+*Returned Response:*
+
+
+
+
+[ShipmentReasons](#ShipmentReasons)
+
+Success. Check the example shown below or refer `ShipmentBagReasons` for more details.
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "reasons": [
+    {
+      "reason_id": 115,
+      "priority": 9,
+      "reason_text": "Wrong size/colour delivered",
+      "show_text_area": false,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 116,
+      "priority": 10,
+      "reason_text": "Product does not fit me",
+      "show_text_area": false,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 117,
+      "priority": 11,
+      "reason_text": "Quality of product is not good",
+      "show_text_area": false,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 118,
+      "priority": 12,
+      "reason_text": "Wrong product delivered",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 119,
+      "priority": 13,
+      "reason_text": "Damaged product delivered",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 120,
+      "priority": 14,
+      "reason_text": "Used product delivered",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 124,
+      "priority": 15,
+      "reason_text": "Missing Items/Partially Received",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 121,
+      "priority": 16,
+      "reason_text": "Found better price elsewhere",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 122,
+      "priority": 17,
+      "reason_text": "Product looks different from image",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    },
+    {
+      "reason_id": 123,
+      "priority": 18,
+      "reason_text": "Other issue",
+      "show_text_area": true,
+      "feedback_type": "bag",
+      "flow": "return"
+    }
+  ]
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### updateShipmentStatus
+Update the shipment status
+
+
+
+```javascript
+// Promise
+const promise = order.updateShipmentStatus({  shipmentId : value,
+ body : value });
+
+// Async/Await
+const data = await order.updateShipmentStatus({  shipmentId : value,
+ body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| shipmentId | string | yes | ID of the shipment. An order may contain multiple items and may get divided into one or more shipment, each having its own ID. |  
+| body | [UpdateShipmentStatusRequest](#UpdateShipmentStatusRequest) | yes | Request body |
+
+
+Use this API to update the status of a shipment using its shipment ID.
+
+*Returned Response:*
+
+
+
+
+[ShipmentApplicationStatusResponse](#ShipmentApplicationStatusResponse)
+
+Successfully updateShipmentStatus!
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "statuses": [
+    {
+      "shipments": {
+        "16291129095851065963": {
+          "status": 400,
+          "message": {
+            "16291129095851065963": "Invalid State Transition bag_invoiced detected for given entity"
+          },
+          "code": null,
+          "exception": "ValidationError",
+          "stack_trace": null
+        }
+      }
+    }
+  ]
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+
+### Schemas
+
+ 
+ 
+ #### [OrderPage](#OrderPage)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | item_total | number |  no  |  |
+ | has_next | boolean |  no  |  |
+ | current | number |  no  |  |
+ | type | string |  no  |  |
+ | size | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [OrderStatuses](#OrderStatuses)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display | string |  no  |  |
+ | is_selected | boolean |  no  |  |
+ | value | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [OrderFilters](#OrderFilters)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | statuses | [[OrderStatuses](#OrderStatuses)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [UserInfo](#UserInfo)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | gender | string |  no  |  |
+ | name | string |  no  |  |
+ | mobile | string |  no  |  |
+ | email | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentTotalDetails](#ShipmentTotalDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | sizes | number |  no  |  |
+ | pieces | number |  no  |  |
+ | total_price | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Prices](#Prices)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | price_marked | number |  no  |  |
+ | cod_charges | number |  no  |  |
+ | added_to_fynd_cash | boolean |  no  |  |
+ | refund_amount | number |  no  |  |
+ | price_effective | number |  no  |  |
+ | value_of_good | number |  no  |  |
+ | coupon_value | number |  no  |  |
+ | promotion_effective_discount | number |  no  |  |
+ | amount_paid_roundoff | number |  no  |  |
+ | coupon_effective_discount | number |  no  |  |
+ | brand_calculated_amount | number |  no  |  |
+ | amount_paid | number |  no  |  |
+ | fynd_credits | number |  no  |  |
+ | cashback_applied | number |  no  |  |
+ | delivery_charge | number |  no  |  |
+ | cashback | number |  no  |  |
+ | discount | number |  no  |  |
+ | gst_tax_percentage | number |  no  |  |
+ | transfer_price | number |  no  |  |
+ | refund_credit | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentPayment](#ShipmentPayment)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display_name | string |  no  |  |
+ | mop | string |  no  |  |
+ | mode | string |  no  |  |
+ | logo | string |  no  |  |
+ | status | string |  no  |  |
+ | payment_mode | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CurrentStatus](#CurrentStatus)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | status | string |  no  |  |
+ | name | string |  no  |  |
+ | updated_at | string |  no  |  |
+ | journey_type | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [AppliedFreeArticles](#AppliedFreeArticles)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | free_gift_item_details | string |  no  |  |
+ | article_id | string |  no  |  |
+ | quantity | number |  no  |  |
+ | parent_item_identifier | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [AppliedPromos](#AppliedPromos)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | applied_free_articles | [[AppliedFreeArticles](#AppliedFreeArticles)] |  no  |  |
+ | article_quantity | number |  no  |  |
+ | promotion_type | string |  no  |  |
+ | amount | number |  no  |  |
+ | mrp_promotion | boolean |  no  |  |
+ | promo_id | string |  no  |  |
+ | promotion_name | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Identifiers](#Identifiers)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | ean | string |  no  |  |
+ | sku_code | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [FinancialBreakup](#FinancialBreakup)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | price_marked | number |  no  |  |
+ | cod_charges | number |  no  |  |
+ | size | string |  no  |  |
+ | added_to_fynd_cash | boolean |  no  |  |
+ | refund_amount | number |  no  |  |
+ | price_effective | number |  no  |  |
+ | value_of_good | number |  no  |  |
+ | coupon_value | number |  no  |  |
+ | gst_tag | string |  no  |  |
+ | promotion_effective_discount | number |  no  |  |
+ | amount_paid_roundoff | number |  no  |  |
+ | coupon_effective_discount | number |  no  |  |
+ | brand_calculated_amount | number |  no  |  |
+ | amount_paid | number |  no  |  |
+ | fynd_credits | number |  no  |  |
+ | cashback_applied | number |  no  |  |
+ | gst_fee | number |  no  |  |
+ | delivery_charge | number |  no  |  |
+ | cashback | number |  no  |  |
+ | discount | number |  no  |  |
+ | item_name | string |  no  |  |
+ | total_units | number |  no  |  |
+ | hsn_code | string |  no  |  |
+ | gst_tax_percentage | number |  no  |  |
+ | transfer_price | number |  no  |  |
+ | refund_credit | number |  no  |  |
+ | identifiers | [Identifiers](#Identifiers) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ItemBrand](#ItemBrand)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | name | string |  no  |  |
+ | logo | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Item](#Item)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | name | string |  no  |  |
+ | seller_identifier | string |  no  |  |
+ | code | string |  no  |  |
+ | id | number |  no  |  |
+ | size | string |  no  |  |
+ | slug_key | string |  no  |  |
+ | image | [string] |  no  |  |
+ | brand | [ItemBrand](#ItemBrand) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Bags](#Bags)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | can_cancel | boolean |  no  |  |
+ | line_number | number |  no  |  |
+ | current_status | [CurrentStatus](#CurrentStatus) |  no  |  |
+ | quantity | number |  no  |  |
+ | can_return | boolean |  no  |  |
+ | applied_promos | [[AppliedPromos](#AppliedPromos)] |  no  |  |
+ | financial_breakup | [[FinancialBreakup](#FinancialBreakup)] |  no  |  |
+ | seller_identifier | string |  no  |  |
+ | prices | [Prices](#Prices) |  no  |  |
+ | id | number |  no  |  |
+ | delivery_date | string |  no  |  |
+ | item | [Item](#Item) |  no  |  |
+ | parent_promo_bags | string |  no  |  |
+ | returnable_date | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [FulfillingStore](#FulfillingStore)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | name | string |  no  |  |
+ | code | string |  no  |  |
+ | id | number |  no  |  |
+ | company_name | string |  no  |  |
+ | company_id | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BreakupValues](#BreakupValues)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | value | number |  no  |  |
+ | display | string |  no  |  |
+ | name | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [DeliveryAddress](#DeliveryAddress)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | address2 | string |  no  |  |
+ | address_type | string |  no  |  |
+ | email | string |  no  |  |
+ | contact_person | string |  no  |  |
+ | latitude | number |  no  |  |
+ | area | string |  no  |  |
+ | created_at | string |  no  |  |
+ | country | string |  no  |  |
+ | name | string |  no  |  |
+ | longitude | number |  no  |  |
+ | version | string |  no  |  |
+ | updated_at | string |  no  |  |
+ | address | string |  no  |  |
+ | address1 | string |  no  |  |
+ | phone | string |  no  |  |
+ | address_category | string |  no  |  |
+ | state | string |  no  |  |
+ | pincode | string |  no  |  |
+ | city | string |  no  |  |
+ | landmark | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentUserInfo](#ShipmentUserInfo)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | gender | string |  no  |  |
+ | last_name | string |  no  |  |
+ | mobile | string |  no  |  |
+ | first_name | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [FulfillingCompany](#FulfillingCompany)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | name | string |  no  |  |
+ | id | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentStatus](#ShipmentStatus)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | title | string |  no  |  |
+ | hex_code | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [NestedTrackingDetails](#NestedTrackingDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | status | string |  no  |  |
+ | time | string |  no  |  |
+ | is_current | boolean |  no  |  |
+ | is_passed | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [TrackingDetails](#TrackingDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | time | string |  no  |  |
+ | tracking_details | [[NestedTrackingDetails](#NestedTrackingDetails)] |  no  |  |
+ | status | string |  no  |  |
+ | is_passed | boolean |  no  |  |
+ | is_current | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [TimeStampData](#TimeStampData)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | min | string |  no  |  |
+ | max | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Promise](#Promise)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | show_promise | boolean |  no  |  |
+ | timestamp | [TimeStampData](#TimeStampData) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Invoice](#Invoice)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | label_url | string |  no  |  |
+ | invoice_url | string |  no  |  |
+ | updated_date | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Shipments](#Shipments)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | traking_no | string |  no  |  |
+ | can_cancel | boolean |  no  |  |
+ | total_details | [ShipmentTotalDetails](#ShipmentTotalDetails) |  no  |  |
+ | total_bags | number |  no  |  |
+ | prices | [Prices](#Prices) |  no  |  |
+ | order_type | string |  no  |  |
+ | track_url | string |  no  |  |
+ | delivery_date | string |  no  |  |
+ | need_help_url | string |  no  |  |
+ | payment | [ShipmentPayment](#ShipmentPayment) |  no  |  |
+ | size_info | string |  no  |  |
+ | custom_meta | [string] |  no  |  |
+ | shipment_created_at | string |  no  |  |
+ | bags | [[Bags](#Bags)] |  no  |  |
+ | fulfilling_store | [FulfillingStore](#FulfillingStore) |  no  |  |
+ | breakup_values | [[BreakupValues](#BreakupValues)] |  no  |  |
+ | returnable_date | string |  no  |  |
+ | refund_details | string |  no  |  |
+ | beneficiary_details | boolean |  no  |  |
+ | delivery_address | [DeliveryAddress](#DeliveryAddress) |  no  |  |
+ | user_info | [ShipmentUserInfo](#ShipmentUserInfo) |  no  |  |
+ | fulfilling_company | [FulfillingCompany](#FulfillingCompany) |  no  |  |
+ | shipment_status | [ShipmentStatus](#ShipmentStatus) |  no  |  |
+ | shipment_id | string |  no  |  |
+ | tracking_details | [[TrackingDetails](#TrackingDetails)] |  no  |  |
+ | comment | string |  no  |  |
+ | can_return | boolean |  no  |  |
+ | show_track_link | boolean |  no  |  |
+ | dp_name | string |  no  |  |
+ | can_break | string |  no  |  |
+ | order_id | string |  no  |  |
+ | awb_no | string |  no  |  |
+ | promise | [Promise](#Promise) |  no  |  |
+ | invoice | [Invoice](#Invoice) |  no  |  |
+ | show_download_invoice | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | strategy | string |  no  |  |
+ | level | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BagsForReorder](#BagsForReorder)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | seller_id | number |  no  |  |
+ | quantity | number |  no  |  |
+ | item_size | string |  no  |  |
+ | store_id | number |  no  |  |
+ | article_assignment | [BagsForReorderArticleAssignment](#BagsForReorderArticleAssignment) |  no  |  |
+ | item_id | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [OrderSchema](#OrderSchema)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | total_shipments_in_order | number |  no  |  |
+ | order_created_time | string |  no  |  |
+ | order_id | string |  no  |  |
+ | user_info | [UserInfo](#UserInfo) |  no  |  |
+ | shipments | [[Shipments](#Shipments)] |  no  |  |
+ | breakup_values | [[BreakupValues](#BreakupValues)] |  no  |  |
+ | bags_for_reorder | [[BagsForReorder](#BagsForReorder)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [OrderList](#OrderList)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | page | [OrderPage](#OrderPage) |  no  |  |
+ | filters | [OrderFilters](#OrderFilters) |  no  |  |
+ | items | [[OrderSchema](#OrderSchema)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ApefaceApiError](#ApefaceApiError)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | success | boolean |  no  |  |
+ | message | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [OrderById](#OrderById)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | order | [OrderSchema](#OrderSchema) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentById](#ShipmentById)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | shipment | [Shipments](#Shipments) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ResponseGetInvoiceShipment](#ResponseGetInvoiceShipment)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | presigned_url | string |  yes  |  |
+ | success | boolean |  yes  |  |
+ | presigned_type | string |  yes  |  |
+ | shipment_id | string |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [Track](#Track)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reason | string |  no  |  |
+ | shipment_type | string |  no  |  |
+ | status | string |  no  |  |
+ | updated_at | string |  no  |  |
+ | last_location_recieved_at | string |  no  |  |
+ | updated_time | string |  no  |  |
+ | account_name | string |  no  |  |
+ | awb | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentTrack](#ShipmentTrack)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | results | [[Track](#Track)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CustomerDetailsResponse](#CustomerDetailsResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | phone | string |  no  |  |
+ | name | string |  no  |  |
+ | order_id | string |  no  |  |
+ | shipment_id | string |  no  |  |
+ | country | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [SendOtpToCustomerResponse](#SendOtpToCustomerResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | resend_timer | number |  no  |  |
+ | success | boolean |  no  |  |
+ | message | string |  no  |  |
+ | request_id | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [VerifyOtp](#VerifyOtp)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | request_id | string |  no  |  |
+ | otp_code | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [VerifyOtpResponse](#VerifyOtpResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | success | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BagReasonMeta](#BagReasonMeta)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | show_text_area | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [QuestionSet](#QuestionSet)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display_name | string |  no  |  |
+ | id | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BagReasons](#BagReasons)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | display_name | string |  no  |  |
+ | meta | [BagReasonMeta](#BagReasonMeta) |  no  |  |
+ | question_set | [[QuestionSet](#QuestionSet)] |  no  |  |
+ | reasons | [[BagReasons](#BagReasons)] |  no  |  |
+ | qc_type | [string] |  no  |  |
+ | id | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentBagReasons](#ShipmentBagReasons)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reasons | [[BagReasons](#BagReasons)] |  no  |  |
+ | success | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentReason](#ShipmentReason)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reason_text | string |  no  |  |
+ | flow | string |  no  |  |
+ | feedback_type | string |  no  |  |
+ | priority | number |  no  |  |
+ | reason_id | number |  no  |  |
+ | show_text_area | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentReasons](#ShipmentReasons)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reasons | [[ShipmentReason](#ShipmentReason)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EntityReasonData](#EntityReasonData)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reason_id | number |  no  |  |
+ | reason_text | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EntitiesReasons](#EntitiesReasons)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | filters | [string] |  no  |  |
+ | data | [EntityReasonData](#EntityReasonData) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProductsReasonsFilters](#ProductsReasonsFilters)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | line_number | number |  no  |  |
+ | quantity | number |  no  |  |
+ | identifier | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProductsReasonsData](#ProductsReasonsData)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reason_id | number |  no  |  |
+ | reason_text | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProductsReasons](#ProductsReasons)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | filters | [[ProductsReasonsFilters](#ProductsReasonsFilters)] |  no  |  |
+ | data | [ProductsReasonsData](#ProductsReasonsData) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ReasonsData](#ReasonsData)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | entities | [[EntitiesReasons](#EntitiesReasons)] |  no  |  |
+ | products | [[ProductsReasons](#ProductsReasons)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Products](#Products)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | line_number | number |  no  |  |
+ | quantity | number |  no  |  |
+ | identifier | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [EntitiesDataUpdates](#EntitiesDataUpdates)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | filters | [string] |  no  |  |
+ | data | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | line_number | number |  no  |  |
+ | identifier | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProductsDataUpdates](#ProductsDataUpdates)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | filters | [[ProductsDataUpdatesFilters](#ProductsDataUpdatesFilters)] |  no  |  |
+ | data | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [DataUpdates](#DataUpdates)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | entities | [[EntitiesDataUpdates](#EntitiesDataUpdates)] |  no  |  |
+ | products | [[ProductsDataUpdates](#ProductsDataUpdates)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentsRequest](#ShipmentsRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | reasons | [ReasonsData](#ReasonsData) |  no  |  |
+ | products | [[Products](#Products)] |  no  |  |
+ | identifier | string |  yes  |  |
+ | data_updates | [DataUpdates](#DataUpdates) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [StatuesRequest](#StatuesRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | status | string |  no  |  |
+ | exclude_bags_next_state | string |  no  |  |
+ | shipments | [[ShipmentsRequest](#ShipmentsRequest)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [UpdateShipmentStatusRequest](#UpdateShipmentStatusRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | lock_after_transition | boolean |  no  |  |
+ | unlock_before_transition | boolean |  no  |  |
+ | force_transition | boolean |  no  |  |
+ | statuses | [[StatuesRequest](#StatuesRequest)] |  no  |  |
+ | task | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [StatusesBodyResponse](#StatusesBodyResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | shipments | [string] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ShipmentApplicationStatusResponse](#ShipmentApplicationStatusResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | statuses | [[StatusesBodyResponse](#StatusesBodyResponse)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ErrorResponse](#ErrorResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | stack_trace | string |  no  |  |
+ | exception | string |  no  |  |
+ | status | number |  no  |  |
+ | code | string |  no  |  |
+ | message | string |  no  |  |
+
+---
+
+
+
+