@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/documentation/application/LOGISTIC.md

@@ -8,10 +8,11 @@
 ## Logistic Methods
 Logistics Promise Engine APIs allows you to configure zone, pincode, TAT, logistics and many more useful features. 
 
-* [getPincodeCity](#getpincodecity)
-* [getTatProduct](#gettatproduct)
 * [getAllCountries](#getallcountries)
+* [getOptimalLocations](#getoptimallocations)
+* [getPincodeCity](#getpincodecity)
 * [getPincodeZones](#getpincodezones)
+* [getTatProduct](#gettatproduct)
 
 
 
@@ -20,6 +21,112 @@ Logistics Promise Engine APIs allows you to configure zone, pincode, TAT, logist
 
 
 
+### getAllCountries
+Get Country List
+
+
+
+```javascript
+// Promise
+const promise = logistic.getAllCountries();
+
+// Async/Await
+const data = await logistic.getAllCountries();
+```
+
+
+
+
+
+
+Get all countries
+
+*Returned Response:*
+
+
+
+
+[CountryListResponse](#CountryListResponse)
+
+Get Country List
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getOptimalLocations
+GET zone from the Pincode.
+
+
+
+```javascript
+// Promise
+const promise = logistic.getOptimalLocations({  body : value });
+
+// Async/Await
+const data = await logistic.getOptimalLocations({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [ReAssignStoreRequest](#ReAssignStoreRequest) | yes | Request body |
+
+
+This API returns zone from the Pincode View.
+
+*Returned Response:*
+
+
+
+
+[ReAssignStoreResponse](#ReAssignStoreResponse)
+
+Response status_code
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
 ### getPincodeCity
 Get Pincode API
 
@@ -108,7 +215,14 @@ Get pincode data
             "display_name": "Thane",
             "uid": "city:INDIA|MAHARASHTRA|MUMBAI"
           }
-        ]
+        ],
+        "lat_long": {
+          "type": "Point",
+          "coordinates": [
+            3.8858955,
+            7.2272335
+          ]
+        }
       }
     ],
     "request_uuid": "fce9f431215e71c9ee0e86e792ae1dce4",
@@ -164,6 +278,61 @@ Get pincode data
 
 
 
+---
+
+
+### getPincodeZones
+GET zone from the Pincode.
+
+
+
+```javascript
+// Promise
+const promise = logistic.getPincodeZones({  body : value });
+
+// Async/Await
+const data = await logistic.getPincodeZones({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest) | yes | Request body |
+
+
+This API returns zone from the Pincode View.
+
+*Returned Response:*
+
+
+
+
+[GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
+
+Response status_code
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+
+```
+</details>
+
+
+
+
+
+
+
+
+
 ---
 
 
@@ -329,434 +498,189 @@ Get TAT  data
 ---
 
 
-### getAllCountries
-Get Country List
-
-
-
-```javascript
-// Promise
-const promise = logistic.getAllCountries();
-
-// Async/Await
-const data = await logistic.getAllCountries();
-```
-
-
-
-
-
-
-Get all countries
-
-*Returned Response:*
-
-
-
-
-[CountryListResponse](#CountryListResponse)
-
-Get Country List
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
 
+### Schemas
 
 
+#### [CountryEntityResponse](#CountryEntityResponse)
 
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || display_name | string |  no  |  || is_active | boolean |  no  |  || logistics | [LogisticsResponse](#LogisticsResponse) |  no  |  || meta | [CountryMetaResponse](#CountryMetaResponse) |  no  |  || name | string |  no  |  || parent_id | string |  no  |  || sub_type | string |  no  |  || type | string |  no  |  || uid | string |  no  |  |
 
 ---
 
+#### [CountryListResponse](#CountryListResponse)
 
-### getPincodeZones
-GET zone from the Pincode.
-
-
-
-```javascript
-// Promise
-const promise = logistic.getPincodeZones({  body : value });
-
-// Async/Await
-const data = await logistic.getPincodeZones({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest) | yes | Request body |
-
-
-This API returns zone from the Pincode View.
-
-*Returned Response:*
-
-
-
-
-[GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
-
-Response status_code
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || results | [[CountryEntityResponse](#CountryEntityResponse)] |  no  |  |
 
 ---
 
+#### [CountryMetaResponse](#CountryMetaResponse)
 
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- || country_code | string |  no  |  || isd_code | string |  no  |  |
 
-### Schemas
+---
 
- 
- 
- #### [CountryMetaResponse](#CountryMetaResponse)
+#### [DP](#DP)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | isd_code | string |  no  |  |
- | country_code | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || area_code | string |  no  |  || assign_dp_from_sb | boolean |  no  |  || external_account_id | string |  no  |  || fm_priority | number |  yes  |  || internal_account_id | string |  no  |  || lm_priority | number |  yes  |  || operations | [string] |  yes  |  || payment_mode | string |  yes  |  || rvp_priority | number |  yes  |  || transport_mode | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse)
+#### [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | type | string |  no  |  |
- | message | string |  no  |  |
- | value | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || country | string |  yes  |  || pincode | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [PincodeMetaResponse](#PincodeMetaResponse)
+#### [GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | zone | string |  no  |  |
- | internal_zone_id | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || serviceability_type | string |  yes  |  || zones | [string] |  yes  |  |
 
 ---
 
-
- 
- 
- #### [PincodeParentsResponse](#PincodeParentsResponse)
+#### [LogisticsResponse](#LogisticsResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | sub_type | string |  no  |  |
- | display_name | string |  no  |  |
- | uid | string |  no  |  |
- | name | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || dp | [String: [DP](#DP)] |  no  |  |
 
 ---
 
-
- 
- 
- #### [PincodeDataResponse](#PincodeDataResponse)
+#### [PincodeApiResponse](#PincodeApiResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | meta_code | [CountryMetaResponse](#CountryMetaResponse) |  no  |  |
- | sub_type | string |  no  |  |
- | error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  |
- | display_name | string |  no  |  |
- | uid | string |  no  |  |
- | meta | [PincodeMetaResponse](#PincodeMetaResponse) |  no  |  |
- | parents | [[PincodeParentsResponse](#PincodeParentsResponse)] |  no  |  |
- | name | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || data | [[PincodeDataResponse](#PincodeDataResponse)] |  no  |  || error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  || success | boolean |  yes  |  |
 
 ---
 
-
- 
- 
- #### [PincodeApiResponse](#PincodeApiResponse)
+#### [PincodeDataResponse](#PincodeDataResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | data | [[PincodeDataResponse](#PincodeDataResponse)] |  no  |  |
- | error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  |
- | success | boolean |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || display_name | string |  no  |  || error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  || lat_long | [PincodeLatLongData](#PincodeLatLongData) |  no  |  || meta | [PincodeMetaResponse](#PincodeMetaResponse) |  no  |  || meta_code | [CountryMetaResponse](#CountryMetaResponse) |  no  |  || name | string |  no  |  || parents | [[PincodeParentsResponse](#PincodeParentsResponse)] |  no  |  || sub_type | string |  no  |  || uid | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATCategoryRequest](#TATCategoryRequest)
+#### [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | level | string |  no  |  |
- | id | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || message | string |  no  |  || type | string |  no  |  || value | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATArticlesRequest](#TATArticlesRequest)
+#### [PincodeLatLongData](#PincodeLatLongData)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  |
- | manufacturing_time | number |  no  |  |
- | manufacturing_time_unit | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || coordinates | [string] |  no  |  || type | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATLocationDetailsRequest](#TATLocationDetailsRequest)
+#### [PincodeMetaResponse](#PincodeMetaResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | fulfillment_id | number |  no  |  |
- | articles | [[TATArticlesRequest](#TATArticlesRequest)] |  no  |  |
- | from_pincode | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || internal_zone_id | number |  no  |  || zone | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATViewRequest](#TATViewRequest)
+#### [PincodeParentsResponse](#PincodeParentsResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | journey | string |  no  |  |
- | to_pincode | string |  no  |  |
- | action | string |  no  |  |
- | identifier | string |  no  |  |
- | source | string |  no  |  |
- | location_details | [[TATLocationDetailsRequest](#TATLocationDetailsRequest)] |  no  |  |
+ | ---------- | ---- | -------- | ----------- || display_name | string |  no  |  || name | string |  no  |  || sub_type | string |  no  |  || uid | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATErrorSchemaResponse](#TATErrorSchemaResponse)
+#### [ReAssignStoreRequest](#ReAssignStoreRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | type | string |  no  |  |
- | message | string |  no  |  |
- | value | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || articles | [string] |  yes  |  || configuration | string |  yes  |  || identifier | string |  yes  |  || ignored_locations | [string] |  yes  |  || to_pincode | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [TATFormattedResponse](#TATFormattedResponse)
+#### [ReAssignStoreResponse](#ReAssignStoreResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | min | string |  no  |  |
- | max | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || articles | [string] |  no  |  || error | string |  yes  |  || success | boolean |  yes  |  || to_pincode | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [TATTimestampResponse](#TATTimestampResponse)
+#### [TATArticlesRequest](#TATArticlesRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | min | number |  no  |  |
- | max | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  || manufacturing_time | number |  no  |  || manufacturing_time_unit | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATPromiseResponse](#TATPromiseResponse)
+#### [TATArticlesResponse](#TATArticlesResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | formatted | [TATFormattedResponse](#TATFormattedResponse) |  no  |  |
- | timestamp | [TATTimestampResponse](#TATTimestampResponse) |  no  |  |
+ | ---------- | ---- | -------- | ----------- || _manufacturing_time_seconds | number |  no  |  || category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  || error | [TATErrorSchemaResponse](#TATErrorSchemaResponse) |  no  |  || is_cod_available | boolean |  no  |  || manufacturing_time | number |  no  |  || manufacturing_time_unit | string |  no  |  || promise | [TATPromiseResponse](#TATPromiseResponse) |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATArticlesResponse](#TATArticlesResponse)
+#### [TATCategoryRequest](#TATCategoryRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  |
- | error | [TATErrorSchemaResponse](#TATErrorSchemaResponse) |  no  |  |
- | promise | [TATPromiseResponse](#TATPromiseResponse) |  no  |  |
- | manufacturing_time | number |  no  |  |
- | manufacturing_time_unit | string |  no  |  |
- | _manufacturing_time_seconds | number |  no  |  |
- | is_cod_available | boolean |  no  |  |
+ | ---------- | ---- | -------- | ----------- || id | number |  no  |  || level | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATLocationDetailsResponse](#TATLocationDetailsResponse)
+#### [TATErrorSchemaResponse](#TATErrorSchemaResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | fulfillment_id | number |  no  |  |
- | articles | [[TATArticlesResponse](#TATArticlesResponse)] |  no  |  |
- | from_pincode | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || message | string |  no  |  || type | string |  no  |  || value | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [TATViewResponse](#TATViewResponse)
+#### [TATFormattedResponse](#TATFormattedResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | journey | string |  no  |  |
- | to_pincode | string |  no  |  |
- | payment_mode | string |  no  |  |
- | success | boolean |  no  |  |
- | stormbreaker_uuid | string |  no  |  |
- | error | [TATErrorSchemaResponse](#TATErrorSchemaResponse) |  no  |  |
- | action | string |  no  |  |
- | identifier | string |  no  |  |
- | to_city | string |  no  |  |
- | source | string |  no  |  |
- | request_uuid | string |  no  |  |
- | location_details | [[TATLocationDetailsResponse](#TATLocationDetailsResponse)] |  no  |  |
- | is_cod_available | boolean |  no  |  |
+ | ---------- | ---- | -------- | ----------- || max | string |  no  |  || min | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [DP](#DP)
+#### [TATLocationDetailsRequest](#TATLocationDetailsRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | 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  |  |
+ | ---------- | ---- | -------- | ----------- || articles | [[TATArticlesRequest](#TATArticlesRequest)] |  no  |  || from_pincode | string |  no  |  || fulfillment_id | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [LogisticsResponse](#LogisticsResponse)
+#### [TATLocationDetailsResponse](#TATLocationDetailsResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | dp | [String: [DP](#DP)] |  no  |  |
+ | ---------- | ---- | -------- | ----------- || articles | [[TATArticlesResponse](#TATArticlesResponse)] |  no  |  || from_pincode | string |  no  |  || fulfillment_id | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [CountryEntityResponse](#CountryEntityResponse)
+#### [TATPromiseResponse](#TATPromiseResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | parent_id | string |  no  |  |
- | sub_type | string |  no  |  |
- | display_name | string |  no  |  |
- | uid | string |  no  |  |
- | logistics | [LogisticsResponse](#LogisticsResponse) |  no  |  |
- | type | string |  no  |  |
- | meta | [CountryMetaResponse](#CountryMetaResponse) |  no  |  |
- | is_active | boolean |  no  |  |
- | name | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || formatted | [TATFormattedResponse](#TATFormattedResponse) |  no  |  || timestamp | [TATTimestampResponse](#TATTimestampResponse) |  no  |  |
 
 ---
 
-
- 
- 
- #### [CountryListResponse](#CountryListResponse)
+#### [TATTimestampResponse](#TATTimestampResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | results | [[CountryEntityResponse](#CountryEntityResponse)] |  no  |  |
+ | ---------- | ---- | -------- | ----------- || max | number |  no  |  || min | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest)
+#### [TATViewRequest](#TATViewRequest)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | country | string |  yes  |  |
- | pincode | string |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || action | string |  no  |  || identifier | string |  no  |  || journey | string |  no  |  || location_details | [[TATLocationDetailsRequest](#TATLocationDetailsRequest)] |  no  |  || source | string |  no  |  || to_pincode | string |  no  |  |
 
 ---
 
-
- 
- 
- #### [GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
+#### [TATViewResponse](#TATViewResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | zones | [string] |  yes  |  |
- | serviceability_type | string |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || action | string |  no  |  || error | [TATErrorSchemaResponse](#TATErrorSchemaResponse) |  no  |  || identifier | string |  no  |  || is_cod_available | boolean |  no  |  || journey | string |  no  |  || location_details | [[TATLocationDetailsResponse](#TATLocationDetailsResponse)] |  no  |  || payment_mode | string |  no  |  || request_uuid | string |  no  |  || source | string |  no  |  || stormbreaker_uuid | string |  no  |  || success | boolean |  no  |  || to_city | string |  no  |  || to_pincode | string |  no  |  |
 
 ---