SalesChannelRetailStore
Remove one or more districts from the specified retail store.
The channel ID of the resource.
5Unique identifier of the resource
1Activate id to hyperlink the response data.
A request to add or remove districts from a retail store.
District successfully removed from the retail store.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Server Error
POST /api/v1/channel/{channel_id}/retail_stores/{id}/remove_districts/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"districts": [
1
]
}{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Retrieve detailed information about a specific retail store.
The channel ID of the resource.
5Unique identifier of the resource
1Retail store details
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Server Error
GET /api/v1/channel/{channel_id}/retail_stores/{id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Fully update the details of a specific retail store associated with a sales channel.
The channel ID of the resource.
5Unique identifier of the resource
1Unique identifier for the retail store.
1Human-readable name of the store.
Downtown Flagship StoreID of the township where the store is located.
12ID of the district associated with the store (optional).
3Full address of the store.
500 Market St, San Francisco, CA 94103Phone number for the store.
+1-234-567-890Fax number of the store, if applicable.
+1-234-567-890URL to the store’s image.
https://cdn.example.com/stores/1.jpgLatitude of the store.
41.0202767Longitude of the store.
28.8888964Whether the store is currently active and visible in the system.
trueWhether click-and-collect is available at this store.
trueWhether kapıda is enabled.
falseWhether the store supports fast delivery options.
trueID of the store type, used to categorize store behavior.
2ID of the main store group the store belongs to.
4Display order or priority for UI sorting.
10Indicates if product returns are accepted at this store.
trueList of channel IDs this store is configured for.
[1,2,5]Successfully updated the retail store.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Server Error
PUT /api/v1/channel/{channel_id}/retail_stores/{id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 649
{
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
]
}{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Partially update the details of a specific retail store associated with a sales channel.
The channel ID of the resource.
5Unique identifier of the resource
1Unique identifier for the retail store.
1Human-readable name of the store.
Downtown Flagship StoreID of the township where the store is located.
12ID of the district associated with the store (optional).
3Full address of the store.
500 Market St, San Francisco, CA 94103Phone number for the store.
+1-234-567-890Fax number of the store, if applicable.
+1-234-567-890URL to the store’s image.
https://cdn.example.com/stores/1.jpgLatitude of the store.
41.0202767Longitude of the store.
28.8888964Whether the store is currently active and visible in the system.
trueWhether click-and-collect is available at this store.
trueWhether kapıda is enabled.
falseWhether the store supports fast delivery options.
trueID of the store type, used to categorize store behavior.
2ID of the main store group the store belongs to.
4Display order or priority for UI sorting.
10Indicates if product returns are accepted at this store.
trueList of channel IDs this store is configured for.
[1,2,5]Successfully partially updated the retail store.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Server Error
PATCH /api/v1/channel/{channel_id}/retail_stores/{id} HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 649
{
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
]
}{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Retrieve detailed information about a specific retail store.
The channel ID of the resource.
5Unique identifier of the resource
1Detailed retail store information
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Server Error
GET /api/v1/channel/{channel_id}/retail_stores/{id}/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"township": {
"city": 1,
"pk": 1,
"name": "Esenler",
"is_active": true,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"created_date": "2025-12-01T14:05:38.117Z",
"modified_date": "2025-12-01T14:05:38.117Z"
},
"district": {
"pk": 1,
"name": "Davutpasa",
"is_active": true,
"city": 1,
"township": 1,
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"postcode": "34000",
"zipcode": "34000",
"created_date": "2025-12-01T14:05:38.117Z",
"modified_date": "2025-12-01T14:05:38.117Z"
},
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Adds all retail stores to a group asynchronously.
The channel ID of the resource.
5Unique identifier of the resource
1Filter by click-and-collect availability.
trueFilter by ERP code (contains)
ERPCODE123Filter by exact ERP code (case-insensitive)
ERPCODE123Filter by multiple ERP codes (comma-separated list)
Filter by Township ID
Filter by County ID
Filter by City ID
Filters by name
Filter by kapıda enabled status.
trueFilter by fast delivery availability.
trueFilter by integration mapping object's integration type
Exclude the specified store and all stores related to it.
101Exclude the specified store and all stores for which it is a related store.
101Filter by store group ID.
1Successfully added all retail stores to the group.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Server Error
POST /api/v1/channel/{channel_id}/retail_stores/bulk_add_store_group/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"cache_key": "text"
}Deactivate a specific retail store associated with a sales channel.
The channel ID of the resource.
5Unique identifier of the resource
1Successfully deleted the retail store.
Forbidden
The given resource or object was not found or does not exist.
Server Error
DELETE /api/v1/channel/{channel_id}/retail_stores/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
No content
Add one or more districts to the specified retail store.
The channel ID of the resource.
5Unique identifier of the resource
1Activate id to hyperlink the response data.
A request to add or remove districts from a retail store.
District successfully added to the retail store.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Server Error
POST /api/v1/channel/{channel_id}/retails_stores/{id}/add_districts/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17
{
"districts": [
1
]
}{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Returns a list of all retail stores.
The channel ID of the resource.
5Filter by click-and-collect availability.
trueFilter by ERP code (contains)
ERPCODE123Filter by exact ERP code (case-insensitive)
ERPCODE123Filter by multiple ERP codes (comma-separated list)
Filter by Township ID
Filter by County ID
Filter by City ID
Filters by name
Filter by kapıda enabled status.
trueFilter by fast delivery availability.
trueFilter by integration mapping object's integration type
Exclude the specified store and all stores related to it.
101Exclude the specified store and all stores for which it is a related store.
101Activate id to hyperlink the response data.
A list of retail stores.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Server Error
GET /api/v1/channel/{channel_id}/retail_stores/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": []
}Create a new retail store associated with a specific sales channel.
The channel ID of the resource.
5Unique identifier for the retail store.
1Human-readable name of the store.
Downtown Flagship StoreID of the township where the store is located.
12ID of the district associated with the store (optional).
3Full address of the store.
500 Market St, San Francisco, CA 94103Phone number for the store.
+1-234-567-890Fax number of the store, if applicable.
+1-234-567-890URL to the store’s image.
https://cdn.example.com/stores/1.jpgLatitude of the store.
41.0202767Longitude of the store.
28.8888964Whether the store is currently active and visible in the system.
trueWhether click-and-collect is available at this store.
trueWhether kapıda is enabled.
falseWhether the store supports fast delivery options.
trueID of the store type, used to categorize store behavior.
2ID of the main store group the store belongs to.
4Display order or priority for UI sorting.
10Indicates if product returns are accepted at this store.
trueList of channel IDs this store is configured for.
[1,2,5]Retail store created successfully.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
Server Error
POST /api/v1/channel/{channel_id}/retail_stores/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 649
{
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
]
}{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}Returns a list of all retail stores with detailed information.
The channel ID of the resource.
5Filter by click-and-collect availability.
trueFilter by ERP code (contains)
ERPCODE123Filter by exact ERP code (case-insensitive)
ERPCODE123Filter by multiple ERP codes (comma-separated list)
Filter by Township ID
Filter by County ID
Filter by City ID
Filters by name
Filter by kapıda enabled status.
trueFilter by fast delivery availability.
trueFilter by integration mapping object's integration type
Activate id to hyperlink the response data.
A list of detailed retail stores.
Required field(s) are missing, data is invalid, or the action is not allowed.
Unauthorized Access
Server Error
GET /api/v1/channel/{channel_id}/retail_stores/detailed/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"count": 1,
"next": "text",
"previous": "text",
"results": [
{
"pk": 1,
"name": "Downtown Flagship Store",
"township_id": 12,
"district_id": 3,
"address": "500 Market St, San Francisco, CA 94103",
"phone_number": "+1-234-567-890",
"fax_phone_number": "+1-234-567-890",
"image": "https://cdn.example.com/stores/1.jpg",
"store_hours": [
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"09:00",
"21:00"
],
[
"10:00",
"20:00"
],
[
"12:00",
"18:00"
]
],
"latitude": 41.0202767,
"longitude": 28.8888964,
"is_active": true,
"click_and_collect": true,
"kapida_enabled": false,
"fast_delivery": true,
"store_type_id": 2,
"config": {
"auto_assign": true,
"capacity_limit": 200
},
"group_id": 4,
"sort_order": 10,
"is_return_accepted": true,
"channels": [
1,
2,
5
],
"translations": {
"ANY_ADDITIONAL_PROPERTY": "text"
}
}
]
}Removes all retail stores from a group asynchronously.
The channel ID of the resource.
5Unique identifier of the resource
1Filter by click-and-collect availability.
trueFilter by ERP code (contains)
ERPCODE123Filter by exact ERP code (case-insensitive)
ERPCODE123Filter by multiple ERP codes (comma-separated list)
Filter by Township ID
Filter by County ID
Filter by City ID
Filters by name
Filter by kapıda enabled status.
trueFilter by fast delivery availability.
trueFilter by integration mapping object's integration type
Exclude the specified store and all stores related to it.
101Filter by store group ID.
1Successfully removed all retail stores from the group.
Required field(s) are missing, data is invalid, or the action is not allowed.
Forbidden
The given resource or object was not found or does not exist.
Server Error
POST /api/v1/channel/{channel_id}/retail_stores/bulk_remove_store_group/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*
{
"cache_key": "text"
}Was this helpful?