@gofynd/fdk-client-javascript 0.1.35

package/documentation/platform/COMPANYPROFILE.md

@@ -0,0 +1,2141 @@
+
+
+
+
+##### [Back to Platform docs](./README.md)
+
+## CompanyProfile Methods
+
+* [cbsOnboardGet](#cbsonboardget)
+* [updateCompany](#updatecompany)
+* [getCompanyMetrics](#getcompanymetrics)
+* [getBrand](#getbrand)
+* [editBrand](#editbrand)
+* [createBrand](#createbrand)
+* [getBrands](#getbrands)
+* [createCompanyBrandMapping](#createcompanybrandmapping)
+* [getLocations](#getlocations)
+* [createLocation](#createlocation)
+* [getLocationDetail](#getlocationdetail)
+* [updateLocation](#updatelocation)
+* [createLocationBulk](#createlocationbulk)
+* [getOptimalLocations](#getoptimallocations)
+
+
+
+## Methods with example and description
+
+
+### cbsOnboardGet
+Get company profile
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.cbsOnboardGet();
+
+// Async/Await
+const data = await client.companyProfile.cbsOnboardGet();
+```
+
+
+
+
+
+
+This API allows to view the company profile of the seller account.
+
+*Returned Response:*
+
+
+
+
+[GetCompanyProfileSerializerResponse](#GetCompanyProfileSerializerResponse)
+
+Company profile object. See example below or refer `GetCompanyProfileSerializerResponse` for details
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "documents": [
+    {
+      "verified": true,
+      "legal_name": "SHOPSENSE RETAIL TECHNOLOGIES PRIVATE LIMITED",
+      "value": "AALCA0442L",
+      "type": "pan"
+    }
+  ],
+  "created_by": {
+    "user_id": "123",
+    "username": "917827311650_22960"
+  },
+  "business_info": "I sell",
+  "franchise_enabled": true,
+  "company_type": "mbo",
+  "warnings": {},
+  "business_details": {
+    "website": {
+      "url": "https://www.google.com"
+    }
+  },
+  "addresses": [
+    {
+      "country": "India",
+      "longitude": 72.8231511,
+      "state": "Maharashtra",
+      "address1": "A/204, Sai Vandan, Tulinj Road. Nallasopara East, ",
+      "country_code": "IN",
+      "latitude": 19.4232024,
+      "pincode": 401209,
+      "address_type": "office",
+      "city": "Mumbai"
+    },
+    {
+      "country": "India",
+      "longitude": 72.8231511,
+      "state": "Maharashtra",
+      "address1": "A/204, Sai Vandan, Tulinj Road. Nallasopara East, ",
+      "country_code": "IN",
+      "latitude": 19.4232024,
+      "pincode": 401209,
+      "address_type": "registered",
+      "city": "Mumbai"
+    }
+  ],
+  "modified_by": {
+    "user_id": "123",
+    "username": "917827311650_22960"
+  },
+  "notification_emails": [
+    "gaurangpatel@gofynd.com"
+  ],
+  "business_type": "huf",
+  "name": "Cache Company",
+  "stage": "verified",
+  "uid": 1,
+  "business_country_info": {
+    "country": "India",
+    "country_code": "IN"
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### updateCompany
+Edit company profile
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.updateCompany({  body : value });
+
+// Async/Await
+const data = await client.companyProfile.updateCompany({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [UpdateCompany](#UpdateCompany) | yes | Request body |
+
+
+This API allows to edit the company profile of the seller account.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success message
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "uid": 1,
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getCompanyMetrics
+Get company metrics
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.getCompanyMetrics();
+
+// Async/Await
+const data = await client.companyProfile.getCompanyMetrics();
+```
+
+
+
+
+
+
+This API allows to view the company metrics, i.e. the status of its brand and stores. Also its allows to view the number of products, company documents & store documents which are verified and unverified.
+
+*Returned Response:*
+
+
+
+
+[MetricsSerializer](#MetricsSerializer)
+
+Metrics response object. See example below or refer `MetricsSerializer` for details
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "uid": 1,
+  "stage": "complete",
+  "store": {
+    "verified": 1,
+    "pending": 1
+  },
+  "brand": {
+    "verified": 1,
+    "pending": 1
+  },
+  "product": {
+    "verified": 0,
+    "pending": 0
+  },
+  "company_documents": {
+    "verified": 1,
+    "pending": 0
+  },
+  "store_documents": {
+    "verified": 0,
+    "pending": 2
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getBrand
+Get a single brand.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.getBrand({  brandId : value });
+
+// Async/Await
+const data = await client.companyProfile.getBrand({  brandId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| brandId | string | yes | Id of the brand to be viewed. |  
+
+
+
+This API helps to get data associated to a particular brand.
+
+*Returned Response:*
+
+
+
+
+[GetBrandResponseSerializer](#GetBrandResponseSerializer)
+
+Brand object. See example below or refer `GetBrandResponseSerializer` for details
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "stage": "verified",
+  "_custom_json": {},
+  "uid": 1,
+  "logo": "http://cdn4.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg",
+  "warnings": {},
+  "_locale_language": {},
+  "name": "edited brand",
+  "slug_key": "brand-2",
+  "banner": {
+    "portrait": "http://cdn4.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg",
+    "landscape": "http://cdn4.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg"
+  },
+  "created_by": {
+    "username": "silverbolt",
+    "user_id": "0"
+  },
+  "modified_by": {
+    "username": "917827311650_22960",
+    "user_id": "123"
+  },
+  "verified_by": {
+    "username": "917827311650_22960",
+    "user_id": "123"
+  },
+  "synonyms": [
+    "xyz"
+  ]
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### editBrand
+Edit a brand.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.editBrand({  brandId : value,
+ body : value });
+
+// Async/Await
+const data = await client.companyProfile.editBrand({  brandId : value,
+ body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| brandId | string | yes | Id of the brand to be viewed. |  
+| body | [CreateUpdateBrandRequestSerializer](#CreateUpdateBrandRequestSerializer) | yes | Request body |
+
+
+This API allows to edit meta of a brand.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "uid": 1,
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### createBrand
+Create a Brand.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.createBrand({  body : value });
+
+// Async/Await
+const data = await client.companyProfile.createBrand({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [CreateUpdateBrandRequestSerializer](#CreateUpdateBrandRequestSerializer) | yes | Request body |
+
+
+This API allows to create a brand associated to a company.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "uid": 1,
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getBrands
+Get brands associated to a company
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.getBrands({  pageNo : value,
+ pageSize : value,
+ q : value });
+
+// Async/Await
+const data = await client.companyProfile.getBrands({  pageNo : value,
+ pageSize : value,
+ q : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |  
+| pageNo | number | no | The page number to navigate through the given set of results |    
+| pageSize | number | no | Number of items to retrieve in each page. Default is 10. |    
+| q | string | no | Search term for name. |  
+
+
+
+This API helps to get view brands associated to a particular company.
+
+*Returned Response:*
+
+
+
+
+[CompanyBrandListSerializer](#CompanyBrandListSerializer)
+
+Brand object. See example below or refer `CompanyBrandListSerializer` for details
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "items": [
+    {
+      "brand": {
+        "stage": "complete",
+        "uid": 2,
+        "banner": {
+          "portrait": "http://cdn4.gofynd.com/media/banner_portrait/brand/original/7021_16fc50205c40477daf419b64ec64c64c.jpg",
+          "landscape": "http://cdn4.gofynd.com/media/banner/brand/original/7020_f9e91f7d501c4f2985c09bd196ed304d.jpg"
+        },
+        "modified_by": {
+          "user_id": "123",
+          "username": "917827311650_22960"
+        },
+        "slug_key": "test-post",
+        "synonyms": [
+          "xyz"
+        ],
+        "created_on": "2021-02-25T15:21:57.666000+00:00",
+        "created_by": {
+          "user_id": "123",
+          "username": "917827311650_22960"
+        },
+        "modified_on": "2021-02-25T15:21:57.666000+00:00",
+        "name": "test_post",
+        "logo": "http://cdn4.gofynd.com/media/logo/brand/original/4597_40d1ce44d61940d4829a3c54951bd9ee.jpg"
+      },
+      "stage": "complete",
+      "uid": 2,
+      "modified_by": {
+        "user_id": "123",
+        "username": "917827311650_22960"
+      },
+      "company": {
+        "business_type": "huf",
+        "stage": "complete",
+        "uid": 1,
+        "addresses": [
+          {
+            "city": "Mumbai Suburban",
+            "latitude": 19.058461,
+            "longitude": 72.871395,
+            "address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
+            "country_code": "IN",
+            "state": "Maharashtra",
+            "country": "India",
+            "pincode": 400070,
+            "address_type": "office"
+          },
+          {
+            "city": "Mumbai Suburban",
+            "latitude": 19.058461,
+            "longitude": 72.871395,
+            "address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
+            "country_code": "IN",
+            "state": "Maharashtra",
+            "country": "India",
+            "pincode": 400070,
+            "address_type": "registered"
+          }
+        ],
+        "modified_by": {
+          "user_id": "-1",
+          "username": "silverbolt"
+        },
+        "company_type": "mbo",
+        "created_on": "2021-02-25T15:21:51.526000+00:00",
+        "created_by": {
+          "user_id": "123",
+          "username": "917827311650_22960"
+        },
+        "modified_on": "2021-02-25T17:44:55.722000+00:00",
+        "name": "Cache Company"
+      },
+      "created_by": {
+        "user_id": "123",
+        "username": "917827311650_22960"
+      }
+    }
+  ],
+  "page": {
+    "current": 1,
+    "size": 1,
+    "has_previous": false,
+    "has_next": false,
+    "item_count": 1
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### createCompanyBrandMapping
+Create a company brand mapping.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.createCompanyBrandMapping({  body : value });
+
+// Async/Await
+const data = await client.companyProfile.createCompanyBrandMapping({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [CompanyBrandPostRequestSerializer](#CompanyBrandPostRequestSerializer) | yes | Request body |
+
+
+This API allows to create a company brand mapping, for a already existing brand in the system.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getLocations
+Get list of locations
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.getLocations({  storeType : value,
+ q : value,
+ stage : value,
+ pageNo : value,
+ pageSize : value,
+ locationIds : value });
+
+// Async/Await
+const data = await client.companyProfile.getLocations({  storeType : value,
+ q : value,
+ stage : value,
+ pageNo : value,
+ pageSize : value,
+ locationIds : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |  
+| storeType | string | no | Helps to sort the location list on the basis of location type. |    
+| q | string | no | Query that is to be searched. |    
+| stage | string | no | to filter companies on basis of verified or unverified companies. |    
+| pageNo | number | no | The page number to navigate through the given set of results |    
+| pageSize | number | no | Number of items to retrieve in each page. Default is 10. |    
+| locationIds | Array<number> | no | Helps to filter stores on the basis of uids. |  
+
+
+
+This API allows to view all the locations associated to a company.
+
+*Returned Response:*
+
+
+
+
+[LocationListSerializer](#LocationListSerializer)
+
+Company profile object. See example below or refer `LocationListSerializer` for details
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "items": [
+    {
+      "company": {
+        "business_type": "huf",
+        "stage": "complete",
+        "uid": 1,
+        "addresses": [
+          {
+            "city": "Mumbai Suburban",
+            "latitude": 19.058461,
+            "longitude": 72.871395,
+            "address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
+            "country_code": "IN",
+            "state": "Maharashtra",
+            "country": "India",
+            "pincode": 400070,
+            "address_type": "office"
+          },
+          {
+            "city": "Mumbai Suburban",
+            "latitude": 19.058461,
+            "longitude": 72.871395,
+            "address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
+            "country_code": "IN",
+            "state": "Maharashtra",
+            "country": "India",
+            "pincode": 400070,
+            "address_type": "registered"
+          }
+        ],
+        "modified_by": {
+          "user_id": "-1",
+          "username": "silverbolt"
+        },
+        "company_type": "mbo",
+        "created_on": "2021-02-25T15:21:51.526000+00:00",
+        "created_by": {
+          "user_id": "123",
+          "username": "917827311650_22960"
+        },
+        "modified_on": "2021-02-25T17:44:55.722000+00:00",
+        "name": "Cache Company"
+      },
+      "address": {
+        "city": "MUMBAI",
+        "latitude": 19.4232024,
+        "longitude": 72.8231511,
+        "address1": "A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD",
+        "state": "MAHARASHTRA",
+        "country": "INDIA",
+        "pincode": 401209
+      },
+      "timing": [
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "monday"
+        },
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "tuesday"
+        },
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "wednesday"
+        },
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "thursday"
+        },
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "friday"
+        },
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "saturday"
+        },
+        {
+          "closing": {
+            "minute": 0,
+            "hour": 22
+          },
+          "opening": {
+            "minute": 0,
+            "hour": 11
+          },
+          "open": true,
+          "weekday": "sunday"
+        }
+      ],
+      "documents": [],
+      "display_name": "new store",
+      "manager": {
+        "name": "Yrf",
+        "mobile_no": {
+          "country_code": 91,
+          "number": "83456774567"
+        },
+        "email": "gbp@jkl.com"
+      },
+      "code": "code2",
+      "product_return_config": {
+        "on_same_store": true
+      },
+      "created_on": "2021-02-25T15:22:04.913000+00:00",
+      "created_by": {
+        "user_id": "123",
+        "username": "917827311650_22960"
+      },
+      "name": "location2",
+      "gst_credentials": {
+        "e_invoice": {
+          "enabled": false
+        }
+      },
+      "store_type": "high_street",
+      "contact_numbers": [
+        {
+          "country_code": 91,
+          "number": "7208229698"
+        }
+      ],
+      "stage": "complete",
+      "uid": 2,
+      "notification_emails": []
+    }
+  ],
+  "page": {
+    "current": 1,
+    "size": 1,
+    "has_previous": false,
+    "has_next": false,
+    "item_count": 1
+  }
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### createLocation
+Create a location associated to a company.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.createLocation({  body : value });
+
+// Async/Await
+const data = await client.companyProfile.createLocation({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [LocationSerializer](#LocationSerializer) | yes | Request body |
+
+
+This API allows to edit a location associated to a company.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "uid": 1,
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getLocationDetail
+Get details of a specific location.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.getLocationDetail({  locationId : value });
+
+// Async/Await
+const data = await client.companyProfile.getLocationDetail({  locationId : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| locationId | string | yes | Id of the location which you want to view. |  
+
+
+
+This API helps to get data associated to a specific location.
+
+*Returned Response:*
+
+
+
+
+[GetLocationSerializer](#GetLocationSerializer)
+
+Brand object. See example below or refer `GetLocationSerializer` for details
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "verified_on": "2021-02-25T15:22:07.140000+00:00",
+  "company": {
+    "business_type": "huf",
+    "stage": "complete",
+    "uid": 1,
+    "addresses": [
+      {
+        "city": "Mumbai Suburban",
+        "latitude": 19.058461,
+        "longitude": 72.871395,
+        "address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
+        "country_code": "IN",
+        "state": "Maharashtra",
+        "country": "India",
+        "pincode": 400070,
+        "address_type": "office"
+      },
+      {
+        "city": "Mumbai Suburban",
+        "latitude": 19.058461,
+        "longitude": 72.871395,
+        "address1": "Chunabhatti Phatak, Maharashtra Nagar, Maharashtra Nagar, ",
+        "country_code": "IN",
+        "state": "Maharashtra",
+        "country": "India",
+        "pincode": 400070,
+        "address_type": "registered"
+      }
+    ],
+    "modified_by": {
+      "user_id": "-1",
+      "username": "silverbolt"
+    },
+    "company_type": "mbo",
+    "created_by": {
+      "user_id": "123",
+      "username": "917827311650_22960"
+    },
+    "name": "Cache Company"
+  },
+  "address": {
+    "city": "MUMBAI",
+    "landmark": "",
+    "latitude": 19.4232024,
+    "longitude": 72.8231511,
+    "address2": "",
+    "address1": "A/204, SAI VANDAN, NARAYAN NAGAR, TULINJ ROAD",
+    "state": "MAHARASHTRA",
+    "country": "INDIA",
+    "pincode": 401209
+  },
+  "timing": [
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "monday"
+    },
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "tuesday"
+    },
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "wednesday"
+    },
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "thursday"
+    },
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "friday"
+    },
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "saturday"
+    },
+    {
+      "closing": {
+        "minute": 0,
+        "hour": 22
+      },
+      "opening": {
+        "minute": 0,
+        "hour": 11
+      },
+      "open": true,
+      "weekday": "sunday"
+    }
+  ],
+  "documents": [],
+  "warnings": {},
+  "display_name": "new store",
+  "manager": {
+    "name": "Yrf",
+    "mobile_no": {
+      "country_code": 91,
+      "number": "83456774567"
+    },
+    "email": "gbp@jkl.com"
+  },
+  "code": "store1",
+  "product_return_config": {
+    "on_same_store": true
+  },
+  "modified_by": {
+    "user_id": "-1",
+    "username": "silverbolt"
+  },
+  "created_by": {
+    "user_id": "123",
+    "username": "917827311650_22960"
+  },
+  "name": "edited_store",
+  "gst_credentials": {
+    "e_invoice": {
+      "enabled": false
+    }
+  },
+  "verified_by": {
+    "user_id": "-1",
+    "username": "silverbolt"
+  },
+  "store_type": "high_street",
+  "contact_numbers": [
+    {
+      "country_code": 91,
+      "number": "7208229698"
+    }
+  ],
+  "stage": "verified",
+  "uid": 1,
+  "notification_emails": []
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### updateLocation
+Edit a location asscoiated to a company.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.updateLocation({  locationId : value,
+ body : value });
+
+// Async/Await
+const data = await client.companyProfile.updateLocation({  locationId : value,
+ body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- | 
+| locationId | string | yes | Id of the location which you want to edit. |  
+| body | [LocationSerializer](#LocationSerializer) | yes | Request body |
+
+
+This API allows to edit a location associated to a company.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "uid": 1,
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### createLocationBulk
+Create a location asscoiated to a company in bulk.
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.createLocationBulk({  body : value });
+
+// Async/Await
+const data = await client.companyProfile.createLocationBulk({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [BulkLocationSerializer](#BulkLocationSerializer) | yes | Request body |
+
+
+This API allows to create a location associated to a company.
+
+*Returned Response:*
+
+
+
+
+[ProfileSuccessResponse](#ProfileSuccessResponse)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "message": "10 stores inserted",
+  "success": true
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+### getOptimalLocations
+Location Reassignment
+
+
+
+```javascript
+// Promise
+const promise = client.companyProfile.getOptimalLocations({  body : value });
+
+// Async/Await
+const data = await client.companyProfile.getOptimalLocations({  body : value });
+```
+
+
+
+
+
+| Argument  |  Type  | Required | Description |
+| --------- | -----  | -------- | ----------- |
+| body | [AssignStoreRequestValidator](#AssignStoreRequestValidator) | yes | Request body |
+
+
+
+
+*Returned Response:*
+
+
+
+
+[AssignStoreResponseSerializer](#AssignStoreResponseSerializer)
+
+Returns a success response
+
+
+
+
+<details>
+<summary><i>&nbsp; Example:</i></summary>
+
+```json
+{
+  "items": [
+    {
+      "meta": {},
+      "store_id": 11550,
+      "size": "OS",
+      "_id": "61161830f1061e7c7f81d8ed",
+      "store_pincode": 201303,
+      "company_id": 783,
+      "s_city": "NOIDA",
+      "quantity": 1,
+      "price_effective": 995,
+      "status": true,
+      "price_marked": 995,
+      "uid": "11550_000000410234883001",
+      "article_assignment": {
+        "strategy": "app-config",
+        "level": "multi-company"
+      },
+      "item_id": 75252658,
+      "strategy_wise_listing": [],
+      "index": 0
+    }
+  ]
+}
+```
+</details>
+
+
+
+
+
+
+
+
+
+---
+
+
+
+### Schemas
+
+ 
+ 
+ #### [GetAddressSerializer](#GetAddressSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | address1 | string |  no  |  |
+ | longitude | number |  no  |  |
+ | state | string |  no  |  |
+ | latitude | number |  no  |  |
+ | country | string |  no  |  |
+ | address_type | string |  no  |  |
+ | city | string |  no  |  |
+ | country_code | string |  no  |  |
+ | landmark | string |  no  |  |
+ | pincode | number |  no  |  |
+ | address2 | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BusinessCountryInfo](#BusinessCountryInfo)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | country_code | string |  no  |  |
+ | country | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [UserSerializer](#UserSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | user_id | string |  no  |  |
+ | username | string |  no  |  |
+ | contact | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanyTaxesSerializer](#CompanyTaxesSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | rate | number |  no  |  |
+ | effective_date | string |  no  |  |
+ | enable | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Website](#Website)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | url | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BusinessDetails](#BusinessDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | website | [Website](#Website) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [SellerPhoneNumber](#SellerPhoneNumber)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | country_code | number |  yes  |  |
+ | number | string |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [ContactDetails](#ContactDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | phone | [[SellerPhoneNumber](#SellerPhoneNumber)] |  no  |  |
+ | emails | [string] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Document](#Document)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | type | string |  yes  |  |
+ | url | string |  no  |  |
+ | verified | boolean |  no  |  |
+ | value | string |  yes  |  |
+ | legal_name | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [GetCompanyProfileSerializerResponse](#GetCompanyProfileSerializerResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  yes  |  |
+ | business_type | string |  yes  |  |
+ | franchise_enabled | boolean |  no  |  |
+ | warnings | string |  no  |  |
+ | mode | string |  no  |  |
+ | addresses | [[GetAddressSerializer](#GetAddressSerializer)] |  no  |  |
+ | name | string |  no  |  |
+ | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) |  no  |  |
+ | stage | string |  no  |  |
+ | created_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | taxes | [[CompanyTaxesSerializer](#CompanyTaxesSerializer)] |  no  |  |
+ | business_details | [BusinessDetails](#BusinessDetails) |  no  |  |
+ | business_info | string |  no  |  |
+ | verified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | modified_on | string |  no  |  |
+ | company_type | string |  yes  |  |
+ | contact_details | [ContactDetails](#ContactDetails) |  no  |  |
+ | created_on | string |  no  |  |
+ | documents | [[Document](#Document)] |  no  |  |
+ | notification_emails | [string] |  no  |  |
+ | _custom_json | string |  no  |  |
+ | modified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | verified_on | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ErrorResponse](#ErrorResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | message | string |  no  |  |
+ | meta | string |  no  |  |
+ | status | number |  no  |  |
+ | code | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanyTaxesSerializer1](#CompanyTaxesSerializer1)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | rate | number |  no  |  |
+ | effective_date | string |  no  |  |
+ | enable | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | address1 | string |  yes  |  |
+ | longitude | number |  yes  |  |
+ | state | string |  yes  |  |
+ | latitude | number |  yes  |  |
+ | country | string |  yes  |  |
+ | country_code | string |  no  |  |
+ | city | string |  yes  |  |
+ | address_type | string |  yes  |  |
+ | landmark | string |  no  |  |
+ | pincode | number |  yes  |  |
+ | address2 | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [UpdateCompany](#UpdateCompany)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | name | string |  no  |  |
+ | business_info | string |  no  |  |
+ | business_type | string |  no  |  |
+ | franchise_enabled | boolean |  no  |  |
+ | documents | [[Document](#Document)] |  no  |  |
+ | notification_emails | [string] |  no  |  |
+ | _custom_json | string |  no  |  |
+ | taxes | [[CompanyTaxesSerializer1](#CompanyTaxesSerializer1)] |  no  |  |
+ | warnings | string |  no  |  |
+ | business_details | [BusinessDetails](#BusinessDetails) |  no  |  |
+ | company_type | string |  no  |  |
+ | contact_details | [ContactDetails](#ContactDetails) |  no  |  |
+ | reject_reason | string |  no  |  |
+ | addresses | [[CreateUpdateAddressSerializer](#CreateUpdateAddressSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProfileSuccessResponse](#ProfileSuccessResponse)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | success | boolean |  no  |  |
+ | uid | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [DocumentsObj](#DocumentsObj)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | verified | number |  no  |  |
+ | pending | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [MetricsSerializer](#MetricsSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | stage | string |  no  |  |
+ | store_documents | [DocumentsObj](#DocumentsObj) |  no  |  |
+ | brand | [DocumentsObj](#DocumentsObj) |  no  |  |
+ | company_documents | [DocumentsObj](#DocumentsObj) |  no  |  |
+ | store | [DocumentsObj](#DocumentsObj) |  no  |  |
+ | product | [DocumentsObj](#DocumentsObj) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [BrandBannerSerializer](#BrandBannerSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | landscape | string |  no  |  |
+ | portrait | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [GetBrandResponseSerializer](#GetBrandResponseSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | warnings | string |  no  |  |
+ | mode | string |  no  |  |
+ | reject_reason | string |  no  |  |
+ | name | string |  yes  |  |
+ | stage | string |  no  |  |
+ | created_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | synonyms | [string] |  no  |  |
+ | verified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | modified_on | string |  no  |  |
+ | description | string |  no  |  |
+ | _locale_language | string |  no  |  |
+ | slug_key | string |  no  |  |
+ | logo | string |  no  |  |
+ | banner | [BrandBannerSerializer](#BrandBannerSerializer) |  no  |  |
+ | created_on | string |  no  |  |
+ | _custom_json | string |  no  |  |
+ | modified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | verified_on | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CreateUpdateBrandRequestSerializer](#CreateUpdateBrandRequestSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | name | string |  yes  |  |
+ | company_id | number |  no  |  |
+ | synonyms | [string] |  no  |  |
+ | _custom_json | string |  no  |  |
+ | description | string |  no  |  |
+ | _locale_language | string |  no  |  |
+ | brand_tier | string |  no  |  |
+ | logo | string |  yes  |  |
+ | banner | [BrandBannerSerializer](#BrandBannerSerializer) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [Page](#Page)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | size | number |  no  |  |
+ | next_id | string |  no  |  |
+ | has_previous | boolean |  no  |  |
+ | current | number |  no  |  |
+ | type | string |  yes  |  |
+ | has_next | boolean |  no  |  |
+ | item_total | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanySocialAccounts](#CompanySocialAccounts)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | url | string |  yes  |  |
+ | name | string |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanyDetails](#CompanyDetails)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | socials | [[CompanySocialAccounts](#CompanySocialAccounts)] |  no  |  |
+ | website_url | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanySerializer](#CompanySerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | name | string |  no  |  |
+ | verified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | business_type | string |  yes  |  |
+ | created_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | stage | string |  no  |  |
+ | business_country_info | [BusinessCountryInfo](#BusinessCountryInfo) |  no  |  |
+ | modified_on | string |  no  |  |
+ | details | [CompanyDetails](#CompanyDetails) |  no  |  |
+ | notification_emails | [string] |  no  |  |
+ | _custom_json | string |  no  |  |
+ | created_on | string |  no  |  |
+ | market_channels | [string] |  no  |  |
+ | modified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | company_type | string |  yes  |  |
+ | reject_reason | string |  no  |  |
+ | verified_on | string |  no  |  |
+ | addresses | [[GetAddressSerializer](#GetAddressSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanyBrandSerializer](#CompanyBrandSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | stage | string |  no  |  |
+ | verified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | company | [CompanySerializer](#CompanySerializer) |  no  |  |
+ | created_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | modified_on | string |  no  |  |
+ | warnings | string |  no  |  |
+ | created_on | string |  no  |  |
+ | brand | [GetBrandResponseSerializer](#GetBrandResponseSerializer) |  no  |  |
+ | modified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | reject_reason | string |  no  |  |
+ | verified_on | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanyBrandListSerializer](#CompanyBrandListSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | page | [Page](#Page) |  no  |  |
+ | items | [[CompanyBrandSerializer](#CompanyBrandSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [CompanyBrandPostRequestSerializer](#CompanyBrandPostRequestSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | company | number |  yes  |  |
+ | brands | [number] |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [GetCompanySerializer](#GetCompanySerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | name | string |  no  |  |
+ | verified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | business_type | string |  no  |  |
+ | created_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | stage | string |  no  |  |
+ | modified_on | string |  no  |  |
+ | created_on | string |  no  |  |
+ | modified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | company_type | string |  no  |  |
+ | reject_reason | string |  no  |  |
+ | verified_on | string |  no  |  |
+ | addresses | [[GetAddressSerializer](#GetAddressSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [InvoiceCredSerializer](#InvoiceCredSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | password | string |  no  |  |
+ | username | string |  no  |  |
+ | enabled | boolean |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [InvoiceDetailsSerializer](#InvoiceDetailsSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | e_waybill | [InvoiceCredSerializer](#InvoiceCredSerializer) |  no  |  |
+ | e_invoice | [InvoiceCredSerializer](#InvoiceCredSerializer) |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [ProductReturnConfigSerializer](#ProductReturnConfigSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | on_same_store | boolean |  no  |  |
+ | store_uid | number |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [LocationManagerSerializer](#LocationManagerSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | name | string |  no  |  |
+ | mobile_no | [SellerPhoneNumber](#SellerPhoneNumber) |  yes  |  |
+ | email | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [LocationTimingSerializer](#LocationTimingSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | minute | number |  yes  |  |
+ | hour | number |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [LocationDayWiseSerializer](#LocationDayWiseSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | closing | [LocationTimingSerializer](#LocationTimingSerializer) |  no  |  |
+ | weekday | string |  yes  |  |
+ | opening | [LocationTimingSerializer](#LocationTimingSerializer) |  no  |  |
+ | open | boolean |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [GetLocationSerializer](#GetLocationSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | address | [GetAddressSerializer](#GetAddressSerializer) |  yes  |  |
+ | warnings | string |  no  |  |
+ | name | string |  yes  |  |
+ | stage | string |  no  |  |
+ | company | [GetCompanySerializer](#GetCompanySerializer) |  no  |  |
+ | created_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | store_type | string |  no  |  |
+ | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] |  no  |  |
+ | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) |  no  |  |
+ | code | string |  yes  |  |
+ | verified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) |  no  |  |
+ | modified_on | string |  no  |  |
+ | manager | [LocationManagerSerializer](#LocationManagerSerializer) |  no  |  |
+ | display_name | string |  yes  |  |
+ | created_on | string |  no  |  |
+ | documents | [[Document](#Document)] |  no  |  |
+ | notification_emails | [string] |  no  |  |
+ | _custom_json | string |  no  |  |
+ | modified_by | [UserSerializer](#UserSerializer) |  no  |  |
+ | phone_number | string |  yes  |  |
+ | verified_on | string |  no  |  |
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [LocationListSerializer](#LocationListSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | page | [Page](#Page) |  no  |  |
+ | items | [[GetLocationSerializer](#GetLocationSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [LocationSerializer](#LocationSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | uid | number |  no  |  |
+ | name | string |  yes  |  |
+ | company | number |  yes  |  |
+ | stage | string |  no  |  |
+ | documents | [[Document](#Document)] |  no  |  |
+ | address | [GetAddressSerializer](#GetAddressSerializer) |  yes  |  |
+ | notification_emails | [string] |  no  |  |
+ | store_type | string |  no  |  |
+ | _custom_json | string |  no  |  |
+ | product_return_config | [ProductReturnConfigSerializer](#ProductReturnConfigSerializer) |  no  |  |
+ | contact_numbers | [[SellerPhoneNumber](#SellerPhoneNumber)] |  no  |  |
+ | warnings | string |  no  |  |
+ | manager | [LocationManagerSerializer](#LocationManagerSerializer) |  no  |  |
+ | timing | [[LocationDayWiseSerializer](#LocationDayWiseSerializer)] |  no  |  |
+ | display_name | string |  yes  |  |
+ | gst_credentials | [InvoiceDetailsSerializer](#InvoiceDetailsSerializer) |  no  |  |
+ | code | string |  yes  |  |
+
+---
+
+
+ 
+ 
+ #### [BulkLocationSerializer](#BulkLocationSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | data | [[LocationSerializer](#LocationSerializer)] |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [_ArticleQuery](#_ArticleQuery)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | ignored_stores | [number] |  no  |  |
+ | item_id | number |  no  |  |
+ | size | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [_ArticleAssignment](#_ArticleAssignment)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | level | string |  no  |  |
+ | strategy | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [_AssignStoreArticle](#_AssignStoreArticle)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | query | [_ArticleQuery](#_ArticleQuery) |  no  |  |
+ | article_assignment | [_ArticleAssignment](#_ArticleAssignment) |  no  |  |
+ | quantity | number |  no  |  |
+ | meta | string |  no  |  |
+ | group_id | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [AssignStoreRequestValidator](#AssignStoreRequestValidator)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | store_ids | [number] |  no  |  |
+ | company_id | number |  no  |  |
+ | channel_identifier | string |  no  |  |
+ | app_id | string |  no  |  |
+ | articles | [[_AssignStoreArticle](#_AssignStoreArticle)] |  no  |  |
+ | channel_type | string |  no  |  |
+ | pincode | string |  no  |  |
+
+---
+
+
+ 
+ 
+ #### [AssignStoreResponseSerializer](#AssignStoreResponseSerializer)
+
+ | Properties | Type | Nullable | Description |
+ | ---------- | ---- | -------- | ----------- |
+ | price_marked | number |  no  |  |
+ | uid | string |  no  |  |
+ | article_assignment | [_ArticleAssignment](#_ArticleAssignment) |  no  |  |
+ | size | string |  no  |  |
+ | company_id | number |  no  |  |
+ | _id | string |  no  |  |
+ | store_pincode | string |  no  |  |
+ | preice_effective | number |  no  |  |
+ | quantity | number |  no  |  |
+ | meta | string |  no  |  |
+ | item_id | number |  no  |  |
+ | s_city | string |  no  |  |
+ | store_id | number |  no  |  |
+ | status | boolean |  no  |  |
+ | index | number |  no  |  |
+
+---
+
+
+
+