@gofynd/fdk-client-javascript 1.0.3 → 1.0.4

package/documentation/application/LOGISTIC.md

@@ -1,689 +0,0 @@
-
-
-
-
-
-##### [Back to Application docs](./README.md)
-
-## Logistic Methods
-Logistics Promise Engine APIs allows you to configure zone, pincode, TAT, logistics and many more useful features. 
-
-* [getAllCountries](#getallcountries)
-* [getOptimalLocations](#getoptimallocations)
-* [getPincodeCity](#getpincodecity)
-* [getPincodeZones](#getpincodezones)
-* [getTatProduct](#gettatproduct)
-
-
-
-## Methods with example and description
-
-
-
-
-### 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
-
-
-
-```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"
-          }
-        ],
-        "lat_long": {
-          "type": "Point",
-          "coordinates": [
-            3.8858955,
-            7.2272335
-          ]
-        }
-      }
-    ],
-    "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>
-
-
-
-
-
-
-
-
-
----
-
-
-### 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>
-
-
-
-
-
-
-
-
-
----
-
-
-### getTatProduct
-Get TAT API
-
-
-
-```javascript
-// Promise
-const promise = logistic.getTatProduct({  body : value });
-
-// Async/Await
-const data = await logistic.getTatProduct({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [TATViewRequest](#TATViewRequest) | yes | Request body |
-
-
-Get TAT data
-
-*Returned Response:*
-
-
-
-
-[TATViewResponse](#TATViewResponse)
-
-Get TAT  data
-
-
-
-
-<details>
-<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>
-
-
-
-
-
-
-
-
-
----
-
-
-
-### 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)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || results | [[CountryEntityResponse](#CountryEntityResponse)] |  no  |  |
-
----
-
-#### [CountryMetaResponse](#CountryMetaResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || country_code | string |  no  |  || isd_code | string |  no  |  |
-
----
-
-#### [DP](#DP)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || 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  |  |
-
----
-
-#### [GetZoneFromPincodeViewRequest](#GetZoneFromPincodeViewRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || country | string |  yes  |  || pincode | string |  yes  |  |
-
----
-
-#### [GetZoneFromPincodeViewResponse](#GetZoneFromPincodeViewResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || serviceability_type | string |  yes  |  || zones | [string] |  yes  |  |
-
----
-
-#### [LogisticsResponse](#LogisticsResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || dp | [String: [DP](#DP)] |  no  |  |
-
----
-
-#### [PincodeApiResponse](#PincodeApiResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || data | [[PincodeDataResponse](#PincodeDataResponse)] |  no  |  || error | [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse) |  yes  |  || success | boolean |  yes  |  |
-
----
-
-#### [PincodeDataResponse](#PincodeDataResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || 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  |  |
-
----
-
-#### [PincodeErrorSchemaResponse](#PincodeErrorSchemaResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || message | string |  no  |  || type | string |  no  |  || value | string |  no  |  |
-
----
-
-#### [PincodeLatLongData](#PincodeLatLongData)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || coordinates | [string] |  no  |  || type | string |  no  |  |
-
----
-
-#### [PincodeMetaResponse](#PincodeMetaResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || internal_zone_id | number |  no  |  || zone | string |  no  |  |
-
----
-
-#### [PincodeParentsResponse](#PincodeParentsResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || display_name | string |  no  |  || name | string |  no  |  || sub_type | string |  no  |  || uid | string |  no  |  |
-
----
-
-#### [ReAssignStoreRequest](#ReAssignStoreRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || articles | [string] |  yes  |  || configuration | string |  yes  |  || identifier | string |  yes  |  || ignored_locations | [string] |  yes  |  || to_pincode | string |  yes  |  |
-
----
-
-#### [ReAssignStoreResponse](#ReAssignStoreResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || articles | [string] |  no  |  || error | string |  yes  |  || success | boolean |  yes  |  || to_pincode | string |  yes  |  |
-
----
-
-#### [TATArticlesRequest](#TATArticlesRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || category | [TATCategoryRequest](#TATCategoryRequest) |  no  |  || manufacturing_time | number |  no  |  || manufacturing_time_unit | string |  no  |  |
-
----
-
-#### [TATArticlesResponse](#TATArticlesResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || _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  |  |
-
----
-
-#### [TATCategoryRequest](#TATCategoryRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || id | number |  no  |  || level | string |  no  |  |
-
----
-
-#### [TATErrorSchemaResponse](#TATErrorSchemaResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || message | string |  no  |  || type | string |  no  |  || value | string |  no  |  |
-
----
-
-#### [TATFormattedResponse](#TATFormattedResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || max | string |  no  |  || min | string |  no  |  |
-
----
-
-#### [TATLocationDetailsRequest](#TATLocationDetailsRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || articles | [[TATArticlesRequest](#TATArticlesRequest)] |  no  |  || from_pincode | string |  no  |  || fulfillment_id | number |  no  |  |
-
----
-
-#### [TATLocationDetailsResponse](#TATLocationDetailsResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || articles | [[TATArticlesResponse](#TATArticlesResponse)] |  no  |  || from_pincode | string |  no  |  || fulfillment_id | number |  no  |  |
-
----
-
-#### [TATPromiseResponse](#TATPromiseResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || formatted | [TATFormattedResponse](#TATFormattedResponse) |  no  |  || timestamp | [TATTimestampResponse](#TATTimestampResponse) |  no  |  |
-
----
-
-#### [TATTimestampResponse](#TATTimestampResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || max | number |  no  |  || min | number |  no  |  |
-
----
-
-#### [TATViewRequest](#TATViewRequest)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || action | string |  no  |  || identifier | string |  no  |  || journey | string |  no  |  || location_details | [[TATLocationDetailsRequest](#TATLocationDetailsRequest)] |  no  |  || source | string |  no  |  || to_pincode | string |  no  |  |
-
----
-
-#### [TATViewResponse](#TATViewResponse)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- || 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  |  |
-
----
-
-
-
-