@gofynd/fdk-client-javascript 0.1.35 → 0.1.37

package/documentation/application/LOGISTIC.md

@@ -2,21 +2,173 @@
 
 
 
+
 ##### [Back to Application docs](./README.md)
 
 ## Logistic Methods
-Handles Platform websites OMS
+Logistics Promise Engine APIs allows you to configure zone, pincode, TAT, logistics and many more useful features. 
+
+* [getPincodeCity](#getpincodecity)
 * [getTatProduct](#gettatproduct)
+* [getAllCountries](#getallcountries)
 * [getPincodeZones](#getpincodezones)
-* [getPincodeCity](#getpincodecity)
 
 
 
 ## Methods with example and description
 
 
+
+
+### getPincodeCity
+Get Pincode API
+
+
+
+```javascript
+// Promise
+const promise = logistic.getPincodeCity({  pincode : value,
+ countryCode : value });
+
+// Async/Await
+const data = await logistic.getPincodeCity({  pincode : value,
+ countryCode : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| pincode | string | yes | A `pincode` contains a specific address of a location. |    
+| countryCode | string | no | A 3 alphabetic country code |  
+
+
+
+Get pincode data
+
+*Returned Response:*
+
+
+
+
+[PincodeApiResponse](#PincodeApiResponse)
+
+Get pincode data
+
+
+
+
+<details>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Pincode data found</i></summary>
+
+```json
+{
+  "value": {
+    "data": [
+      {
+        "sub_type": "pincode",
+        "name": "421202",
+        "error": {
+          "type": null,
+          "value": null,
+          "message": null
+        },
+        "uid": "pincode:INDIA|MAHARASHTRA|MUMBAI|421202",
+        "display_name": "421202",
+        "meta": {
+          "zone": "West",
+          "internal_zone_id": 4
+        },
+        "meta_code": {
+          "country_code": "IND",
+          "isd_code": "+91"
+        },
+        "parents": [
+          {
+            "sub_type": "country",
+            "name": "India",
+            "display_name": "India",
+            "uid": "country:INDIA"
+          },
+          {
+            "sub_type": "state",
+            "name": "Maharashtra",
+            "display_name": "Maharashtra",
+            "uid": "state:INDIA|MAHARASHTRA"
+          },
+          {
+            "sub_type": "city",
+            "name": "Thane",
+            "display_name": "Thane",
+            "uid": "city:INDIA|MAHARASHTRA|MUMBAI"
+          }
+        ]
+      }
+    ],
+    "request_uuid": "fce9f431215e71c9ee0e86e792ae1dce4",
+    "stormbreaker_uuid": "56cca764-9fab-41f4-adb8-6e9683532aa5",
+    "error": {
+      "type": null,
+      "value": null,
+      "message": null
+    },
+    "success": true
+  }
+}
+```
+</details>
+
+<details>
+<summary><i>&nbsp; Pincode not found</i></summary>
+
+```json
+{
+  "value": {
+    "data": [
+      {
+        "sub_type": "pincode",
+        "name": "999999",
+        "error": {
+          "type": "DoesNotExist",
+          "value": "999999",
+          "message": "pincode 999999 does not exist"
+        }
+      }
+    ],
+    "request_uuid": "fce9fb9215e71c9ee0e86e792ae1dce4",
+    "stormbreaker_uuid": "03b353ed-9dbd-4629-80b2-2be337859a20",
+    "error": {
+      "type": null,
+      "value": null,
+      "message": null
+    },
+    "success": false
+  }
+}
+```
+</details>
+
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
 ### getTatProduct
-Get TAT of a product
+Get TAT API
 
 
 
@@ -34,31 +186,138 @@ const data = await logistic.getTatProduct({  body : value });
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- |
-| body | [GetTatProductReqBody](#GetTatProductReqBody) | yes | Request body |
+| body | [TATViewRequest](#TATViewRequest) | yes | Request body |
 
 
-Use this API to know the delivery turnaround time (TAT) by entering the product details along with the PIN Code of the location.
+Get TAT data
 
 *Returned Response:*
 
 
 
 
-[GetTatProductResponse](#GetTatProductResponse)
+[TATViewResponse](#TATViewResponse)
 
-Success. Check the example shown below or refer `GetTatProductResponse` for more details.
+Get TAT  data
 
 
 
 
 <details>
-<summary><i>&nbsp; Example:</i></summary>
+<summary><i>&nbsp; Examples:</i></summary>
+
+
+<details>
+<summary><i>&nbsp; Pincode data found</i></summary>
 
 ```json
+{
+  "value": {
+    "source": "FYND-APP",
+    "identifier": "PDP",
+    "journey": "forward",
+    "action": "get_tat",
+    "to_pincode": "143001",
+    "location_details": [
+      {
+        "fulfillment_id": 8,
+        "from_pincode": "560023",
+        "articles": [
+          {
+            "category": {
+              "level": "l3",
+              "id": 155
+            },
+            "manufacturing_time": 2,
+            "manufacturing_time_unit": "days",
+            "promise": {
+              "timestamp": {
+                "min": 1663564548,
+                "max": 1663650948
+              },
+              "formatted": {
+                "min": "19 Sep, Monday",
+                "max": "20 Sep, Tuesday"
+              }
+            },
+            "error": {
+              "type": null,
+              "value": null,
+              "message": null
+            },
+            "is_cod_available": true,
+            "_manufacturing_time_seconds": 172800
+          }
+        ]
+      }
+    ],
+    "request_uuid": "b4adf5508e34f17971817c3581e16310",
+    "stormbreaker_uuid": "4b8084d4-ea74-45af-8ddc-c38e29bf0cfb",
+    "error": {
+      "type": null,
+      "value": null,
+      "message": null
+    },
+    "to_city": "Amritsar",
+    "payment_mode": "prepaid",
+    "is_cod_available": true,
+    "success": true
+  }
+}
+```
+</details>
+
+<details>
+<summary><i>&nbsp; Pincode not found</i></summary>
 
+```json
+{
+  "value": {
+    "source": "FYND-APP",
+    "identifier": "PDP",
+    "journey": "forward",
+    "action": "get_tat",
+    "to_pincode": "99999",
+    "location_details": [
+      {
+        "fulfillment_id": 8,
+        "from_pincode": "560023",
+        "articles": [
+          {
+            "category": {
+              "level": "l3",
+              "id": 155
+            },
+            "manufacturing_time": 2,
+            "manufacturing_time_unit": "days",
+            "promise": null,
+            "error": {
+              "type": "ValueError",
+              "value": "99999",
+              "message": "We are not delivering to 99999"
+            }
+          }
+        ]
+      }
+    ],
+    "request_uuid": "4b99d15fddb2b9fc2d6ab99a1c933010",
+    "stormbreaker_uuid": "6a847909-1d59-43e7-9ae0-15f5de8fc7d7",
+    "error": {
+      "type": "ValueError",
+      "value": "99999",
+      "message": "All of the items in your cart are not deliverable to 99999"
+    },
+    "to_city": "",
+    "payment_mode": "prepaid",
+    "is_cod_available": true,
+    "success": false
+  }
+}
 ```
 </details>
 
+</details>
+
 
 
 
@@ -70,38 +329,34 @@ Success. Check the example shown below or refer `GetTatProductResponse` for more
 ---
 
 
-### getPincodeZones
-Get Pincode Zones
+### getAllCountries
+Get Country List
 
 
 
 ```javascript
 // Promise
-const promise = logistic.getPincodeZones({  body : value });
+const promise = logistic.getAllCountries();
 
 // Async/Await
-const data = await logistic.getPincodeZones({  body : value });
+const data = await logistic.getAllCountries();
 ```
 
 
 
 
 
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [GetPincodeZonesReqBody](#GetPincodeZonesReqBody) | yes | Request body |
-
 
-Get to know the zones of a specefic pincode
+Get all countries
 
 *Returned Response:*
 
 
 
 
-[GetPincodeZonesResponse](#GetPincodeZonesResponse)
+[CountryListResponse](#CountryListResponse)
 
-Success. Check the example shown below or refer `GetTatProductResponse` for more details.
+Get Country List
 
 
 
@@ -125,17 +380,17 @@ Success. Check the example shown below or refer `GetTatProductResponse` for more
 ---
 
 
-### getPincodeCity
-Get city from PIN Code
+### getPincodeZones
+GET zone from the Pincode.
 
 
 
 ```javascript
 // Promise
-const promise = logistic.getPincodeCity({  pincode : value });
+const promise = logistic.getPincodeZones({  body : value });
 
 // Async/Await
-const data = await logistic.getPincodeCity({  pincode : value });
+const data = await logistic.getPincodeZones({  body : value });
 ```
 
 
@@ -143,21 +398,20 @@ const data = await logistic.getPincodeCity({  pincode : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| pincode | string | yes | The PIN Code of the area, e.g. 400059 |  
-
+| --------- | -----  | -------- | ----------- |
+| body | [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest) | yes | Request body |
 
 
-Use this API to retrieve a city by its PIN Code.
+This API returns zone from the Pincode View.
 
 *Returned Response:*
 
 
 
 
-[GetPincodeCityResponse](#GetPincodeCityResponse)
+[GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
 
-Success. Returns a JSON object containing the city name, state and country identified by its PIN Code. Check the example shown below or refer `GetPincodeCityResponse` for more details.
+Response status_code
 
 
 
@@ -186,56 +440,68 @@ Success. Returns a JSON object containing the city name, state and country ident
 
  
  
- #### [GetPincodeCityResponse](#GetPincodeCityResponse)
+ #### [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | request_uuid | string |  yes  |  |
- | stormbreaker_uuid | string |  yes  |  |
- | success | boolean |  yes  |  |
- | data | [[LogisticPincodeData](#LogisticPincodeData)] |  yes  |  |
+ | message | string |  no  |  |
+ | value | string |  no  |  |
+ | type | string |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticPincodeData](#LogisticPincodeData)
+ #### [PincodeParentsResponse](#PincodeParentsResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | meta | [LogisticMeta](#LogisticMeta) |  no  |  |
- | parents | [[LogisticParents](#LogisticParents)] |  no  |  |
- | sub_type | string |  no  |  |
  | name | string |  no  |  |
- | error | [LogisticError](#LogisticError) |  no  |  |
- | uid | string |  no  |  |
+ | sub_type | string |  no  |  |
  | display_name | string |  no  |  |
+ | uid | string |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticMeta](#LogisticMeta)
+ #### [CountryMetaResponse](#CountryMetaResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
+ | isd_code | string |  no  |  |
+ | country_code | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [PincodeMetaResponse](#PincodeMetaResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | internal_zone_id | number |  no  |  |
  | zone | string |  no  |  |
- | deliverables | [any] |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticParents](#LogisticParents)
+ #### [PincodeDataResponse](#PincodeDataResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
+ | parents | [[PincodeParentsResponse](#PincodeParentsResponse)] |  no  |  |
  | sub_type | string |  no  |  |
- | name | string |  no  |  |
  | display_name | string |  no  |  |
+ | meta_code | [CountryMetaResponse](#CountryMetaResponse) |  no  |  |
+ | name | string |  no  |  |
+ | error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  |
+ | meta | [PincodeMetaResponse](#PincodeMetaResponse) |  no  |  |
  | uid | string |  no  |  |
 
 ---
@@ -243,194 +509,254 @@ Success. Returns a JSON object containing the city name, state and country ident
 
  
  
- #### [LogisticError](#LogisticError)
+ #### [PincodeApiResponse](#PincodeApiResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | type | string |  no  |  |
- | value | string |  no  |  |
- | message | string |  no  |  |
+ | error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  |
+ | data | [[PincodeDataResponse](#PincodeDataResponse)] |  no  |  |
+ | success | boolean |  yes  |  |
 
 ---
 
 
  
  
- #### [GetPincodeZonesReqBody](#GetPincodeZonesReqBody)
+ #### [TATCategoryRequest](#TATCategoryRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | country | string |  yes  |  |
- | pincode | string |  yes  |  |
+ | id | number |  no  |  |
+ | level | string |  no  |  |
 
 ---
 
 
  
  
- #### [GetPincodeZonesResponse](#GetPincodeZonesResponse)
+ #### [TATArticlesRequest](#TATArticlesRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | zones | [any] |  yes  |  |
- | serviceability_type | string |  yes  |  |
+ | manufacturing_time | number |  no  |  |
+ | manufacturing_time_unit | string |  no  |  |
+ | category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [TATLocationDetailsRequest](#TATLocationDetailsRequest)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | articles | [[TATArticlesRequest](#TATArticlesRequest)] |  no  |  |
+ | fulfillment_id | number |  no  |  |
+ | from_pincode | string |  no  |  |
 
 ---
 
 
  
  
- #### [GetTatProductReqBody](#GetTatProductReqBody)
+ #### [TATViewRequest](#TATViewRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | location_details | [[LocationDetailsReq](#LocationDetailsReq)] |  yes  |  |
- | to_pincode | string |  yes  |  |
+ | source | string |  no  |  |
  | action | string |  no  |  |
+ | journey | string |  no  |  |
+ | to_pincode | string |  no  |  |
+ | location_details | [[TATLocationDetailsRequest](#TATLocationDetailsRequest)] |  no  |  |
+ | identifier | string |  no  |  |
 
 ---
 
 
  
  
- #### [LocationDetailsReq](#LocationDetailsReq)
+ #### [TATErrorSchemaResponse](#TATErrorSchemaResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | from_pincode | string |  no  |  |
- | articles | [[TatReqProductArticles](#TatReqProductArticles)] |  no  |  |
- | fulfillment_id | number |  no  |  |
+ | message | string |  no  |  |
+ | value | string |  no  |  |
+ | type | string |  no  |  |
 
 ---
 
 
  
  
- #### [TatReqProductArticles](#TatReqProductArticles)
+ #### [TATFormattedResponse](#TATFormattedResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | manufacturing_time | number |  no  |  |
- | manufacturing_time_unit | string |  no  |  |
- | category | [LogisticRequestCategory](#LogisticRequestCategory) |  no  |  |
+ | min | string |  no  |  |
+ | max | string |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticRequestCategory](#LogisticRequestCategory)
+ #### [TATTimestampResponse](#TATTimestampResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | id | number |  no  |  |
- | level | string |  no  |  |
+ | min | number |  no  |  |
+ | max | number |  no  |  |
 
 ---
 
 
  
  
- #### [GetTatProductResponse](#GetTatProductResponse)
+ #### [TATPromiseResponse](#TATPromiseResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | location_details | [[LocationDetails](#LocationDetails)] |  yes  |  |
- | request_uuid | string |  yes  |  |
- | error | string |  yes  |  |
- | to_city | string |  yes  |  |
- | source | string |  yes  |  |
- | to_pincode | string |  yes  |  |
- | action | string |  yes  |  |
- | stormbreaker_uuid | string |  yes  |  |
- | success | boolean |  yes  |  |
- | identifier | string |  yes  |  |
- | journey | string |  yes  |  |
+ | formatted | [TATFormattedResponse](#TATFormattedResponse) |  no  |  |
+ | timestamp | [TATTimestampResponse](#TATTimestampResponse) |  no  |  |
 
 ---
 
 
  
  
- #### [LocationDetails](#LocationDetails)
+ #### [TATArticlesResponse](#TATArticlesResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | from_pincode | string |  no  |  |
- | articles | [[TatProductArticles](#TatProductArticles)] |  no  |  |
+ | is_cod_available | boolean |  no  |  |
+ | error | [TATErrorSchemaResponse](#TATErrorSchemaResponse) |  no  |  |
+ | manufacturing_time_unit | string |  no  |  |
+ | _manufacturing_time_seconds | number |  no  |  |
+ | promise | [TATPromiseResponse](#TATPromiseResponse) |  no  |  |
+ | manufacturing_time | number |  no  |  |
+ | category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [TATLocationDetailsResponse](#TATLocationDetailsResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | articles | [[TATArticlesResponse](#TATArticlesResponse)] |  no  |  |
  | fulfillment_id | number |  no  |  |
+ | from_pincode | string |  no  |  |
 
 ---
 
 
  
  
- #### [TatProductArticles](#TatProductArticles)
+ #### [TATViewResponse](#TATViewResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | error | string |  no  |  |
- | category | [LogisticResponseCategory](#LogisticResponseCategory) |  no  |  |
- | promise | [LogisticPromise](#LogisticPromise) |  no  |  |
+ | to_city | string |  no  |  |
+ | source | string |  no  |  |
+ | stormbreaker_uuid | string |  no  |  |
+ | action | string |  no  |  |
+ | journey | string |  no  |  |
+ | to_pincode | string |  no  |  |
+ | error | [TATErrorSchemaResponse](#TATErrorSchemaResponse) |  no  |  |
+ | location_details | [[TATLocationDetailsResponse](#TATLocationDetailsResponse)] |  no  |  |
+ | is_cod_available | boolean |  no  |  |
+ | identifier | string |  no  |  |
+ | payment_mode | string |  no  |  |
+ | success | boolean |  no  |  |
+ | request_uuid | string |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticResponseCategory](#LogisticResponseCategory)
+ #### [DP](#DP)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | id | number |  no  |  |
- | level | string |  no  |  |
+ | fm_priority | number |  yes  |  |
+ | lm_priority | number |  yes  |  |
+ | rvp_priority | number |  yes  |  |
+ | payment_mode | string |  yes  |  |
+ | operations | [string] |  yes  |  |
+ | area_code | string |  no  |  |
+ | assign_dp_from_sb | boolean |  no  |  |
+ | internal_account_id | string |  no  |  |
+ | external_account_id | string |  no  |  |
+ | transport_mode | string |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticPromise](#LogisticPromise)
+ #### [LogisticsResponse](#LogisticsResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | timestamp | [LogisticTimestamp](#LogisticTimestamp) |  no  |  |
- | formatted | [Formatted](#Formatted) |  no  |  |
+ | dp | [String: [DP](#DP)] |  no  |  |
 
 ---
 
 
  
  
- #### [LogisticTimestamp](#LogisticTimestamp)
+ #### [CountryEntityResponse](#CountryEntityResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | min | number |  no  |  |
- | max | number |  no  |  |
+ | sub_type | string |  no  |  |
+ | display_name | string |  no  |  |
+ | logistics | [LogisticsResponse](#LogisticsResponse) |  no  |  |
+ | is_active | boolean |  no  |  |
+ | name | string |  no  |  |
+ | parent_id | string |  no  |  |
+ | type | string |  no  |  |
+ | meta | [CountryMetaResponse](#CountryMetaResponse) |  no  |  |
+ | uid | string |  no  |  |
 
 ---
 
 
  
  
- #### [Formatted](#Formatted)
+ #### [CountryListResponse](#CountryListResponse)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | min | string |  no  |  |
- | max | string |  no  |  |
+ | results | [[CountryEntityResponse](#CountryEntityResponse)] |  no  |  |
 
 ---
 
 
  
  
- #### [ApefaceApiError](#ApefaceApiError)
+ #### [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest)
 
  | Properties | Type | Nullable | Description |
  | ---------- | ---- | -------- | ----------- |
- | message | string |  no  |  |
+ | country | string |  yes  |  |
+ | pincode | string |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | zones | [string] |  yes  |  |
+ | serviceability_type | string |  yes  |  |
 
 ---