SalesChannelRetailStore

Remove districts from a store

post

Remove one or more districts from the specified retail store.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

hyperbooleanOptional

Activate id to hyperlink the response data.

Body

application/json

A request to add or remove districts from a retail store.

districtsinteger[]Required

Responses

200

District successfully removed from the retail store.

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/channel/{channel_id}/retail_stores/{id}/remove_districts/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/retail_stores/{id}/remove_districts/ HTTP/1.1
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": "[phone]",
  "fax_phone_number": "[phone]",
  "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"
  }
}

Get retail store by ID

get

Retrieve detailed information about a specific retail store.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Retail store details

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/retail_stores/{id}

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/retail_stores/{id} HTTP/1.1
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": "[phone]",
  "fax_phone_number": "[phone]",
  "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 a retail store

put

Fully update the details of a specific retail store associated with a sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

Responses

200

Successfully updated the retail store.

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

put

/api/v1/channel/{channel_id}/retail_stores/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/channel/{channel_id}/retail_stores/{id} HTTP/1.1
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": "[phone]",
  "fax_phone_number": "[phone]",
  "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": "[phone]",
  "fax_phone_number": "[phone]",
  "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 a retail store

patch

Partially update the details of a specific retail store associated with a sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

Responses

200

Successfully partially updated the retail store.

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

patch

/api/v1/channel/{channel_id}/retail_stores/{id}

HTTPcURLJavaScriptPython

PATCH /api/v1/channel/{channel_id}/retail_stores/{id} HTTP/1.1
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": "[phone]",
  "fax_phone_number": "[phone]",
  "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": "[phone]",
  "fax_phone_number": "[phone]",
  "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"
  }
}

Get detailed retail store by ID

get

Retrieve detailed information about a specific retail store.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Detailed retail store information

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/retail_stores/{id}/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/retail_stores/{id}/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "township": {
    "city": 1,
    "pk": 1,
    "name": "Esenler",
    "is_active": true,
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "postcode": "34000",
    "created_date": "2026-03-07T03:08:09.226Z",
    "modified_date": "2026-03-07T03:08:09.226Z"
  },
  "district": {
    "pk": 1,
    "name": "Davutpasa",
    "is_active": true,
    "city": 1,
    "township": 1,
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "postcode": "34000",
    "zipcode": "34000",
    "created_date": "2026-03-07T03:08:09.226Z",
    "modified_date": "2026-03-07T03:08:09.226Z"
  },
  "pk": 1,
  "name": "Downtown Flagship Store",
  "township_id": 12,
  "district_id": 3,
  "address": "500 Market St, San Francisco, CA 94103",
  "phone_number": "[phone]",
  "fax_phone_number": "[phone]",
  "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"
  }
}

Bulk add retail store to store groups

post

Adds all retail stores to a group asynchronously.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

click_and_collectbooleanOptional

Filter by click-and-collect availability.

Example: true

erp_codestringOptional

Filter by ERP code (contains)

Example: ERPCODE123

erp_code_iexactstringOptional

Filter by exact ERP code (case-insensitive)

Example: ERPCODE123

erp_code__instring[]Optional

Filter by multiple ERP codes (comma-separated list)

township_idinteger · min: 1Optional

Filter by Township ID

country_idinteger · min: 1Optional

Filter by County ID

city_idinteger · min: 1Optional

Filter by City ID

namestringOptional

Filter by name.

kapida_enabledbooleanOptional

Filter by kapıda enabled status.

Example: true

fast_deliverybooleanOptional

Filter by fast delivery availability.

Example: true

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

related_retail_store_excludedintegerOptional

Exclude the specified store and all stores related to it.

Example: 101

retail_store_excludedintegerOptional

Exclude the specified store and all stores for which it is a related store.

Example: 101

retail_store_groupintegerOptional

Filter by store group ID.

Example: 1

Responses

200

Successfully added all retail stores to the group.

application/json

cache_keystringOptional

Cache key for the operation.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/channel/{channel_id}/retail_stores/bulk_add_store_group/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/retail_stores/bulk_add_store_group/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "cache_key": "text"
}

Deactivate a retail store

delete

Deactivate a specific retail store associated with a sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Successfully deleted the retail store.

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

delete

/api/v1/channel/{channel_id}/retail_stores/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/channel/{channel_id}/retail_stores/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

No content

Add districts to a store

post

Add one or more districts to the specified retail store.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

hyperbooleanOptional

Activate id to hyperlink the response data.

Body

application/json

A request to add or remove districts from a retail store.

districtsinteger[]Required

Responses

200

District successfully added to the retail store.

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/channel/{channel_id}/retails_stores/{id}/add_districts/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/retails_stores/{id}/add_districts/ HTTP/1.1
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": "[phone]",
  "fax_phone_number": "[phone]",
  "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"
  }
}

List retail stores

get

Returns a list of all retail stores.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

click_and_collectbooleanOptional

Filter by click-and-collect availability.

Example: true

erp_codestringOptional

Filter by ERP code (contains)

Example: ERPCODE123

erp_code_iexactstringOptional

Filter by exact ERP code (case-insensitive)

Example: ERPCODE123

erp_code__instring[]Optional

Filter by multiple ERP codes (comma-separated list)

township_idinteger · min: 1Optional

Filter by Township ID

country_idinteger · min: 1Optional

Filter by County ID

city_idinteger · min: 1Optional

Filter by City ID

namestringOptional

Filter by name.

kapida_enabledbooleanOptional

Filter by kapıda enabled status.

Example: true

fast_deliverybooleanOptional

Filter by fast delivery availability.

Example: true

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

related_retail_store_excludedintegerOptional

Exclude the specified store and all stores related to it.

Example: 101

retail_store_excludedintegerOptional

Exclude the specified store and all stores for which it is a related store.

Example: 101

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses

200

A list of retail stores.

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/retail_stores/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/retail_stores/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 1,
  "next": "text",
  "previous": "text",
  "results": []
}

Create a new retail store

post

Create a new retail store associated with a specific sales channel.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

application/json

pkintegerRead-onlyOptional

Unique identifier for the retail store.

Example: 1

namestringOptional

Human-readable name of the store.

Example: Downtown Flagship Store

township_idintegerOptional

ID of the township where the store is located.

Example: 12

district_idinteger · nullableOptional

ID of the district associated with the store (optional).

Example: 3

addressstringOptional

Full address of the store.

Example: 500 Market St, San Francisco, CA 94103

phone_numberstringOptional

Phone number for the store.

Example: [phone]

fax_phone_numberstring · nullableOptional

Fax number of the store, if applicable.

Example: [phone]

imagestring · uri · nullableOptional

URL to the store’s image.

Example: https://cdn.example.com/stores/1.jpg

latitudenumber · float · nullableOptional

Latitude of the store.

Example: 41.0202767

longitudenumber · float · nullableOptional

Longitude of the store.

Example: 28.8888964

is_activebooleanOptional

Whether the store is currently active and visible in the system.

Example: true

click_and_collectbooleanOptional

Whether click-and-collect is available at this store.

Example: true

kapida_enabledbooleanOptional

Whether kapıda is enabled.

Example: false

fast_deliverybooleanOptional

Whether the store supports fast delivery options.

Example: true

store_type_idinteger · nullableOptional

ID of the store type, used to categorize store behavior.

Example: 2

group_idinteger · nullableOptional

ID of the main store group the store belongs to.

Example: 4

sort_orderinteger · nullableOptional

Display order or priority for UI sorting.

Example: 10

is_return_acceptedboolean · nullableOptional

Indicates if product returns are accepted at this store.

Example: true

channelsinteger[]Optional

List of channel IDs this store is configured for.

Example: [1,2,5]

Responses

201

Retail store created successfully.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

500

Server Error

post

/api/v1/channel/{channel_id}/retail_stores/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/retail_stores/ HTTP/1.1
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": "[phone]",
  "fax_phone_number": "[phone]",
  "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": "[phone]",
  "fax_phone_number": "[phone]",
  "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"
  }
}

List detailed retail stores

get

Returns a list of all retail stores with detailed information.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Query parameters

click_and_collectbooleanOptional

Filter by click-and-collect availability.

Example: true

erp_codestringOptional

Filter by ERP code (contains)

Example: ERPCODE123

erp_code_iexactstringOptional

Filter by exact ERP code (case-insensitive)

Example: ERPCODE123

erp_code__instring[]Optional

Filter by multiple ERP codes (comma-separated list)

township_idinteger · min: 1Optional

Filter by Township ID

country_idinteger · min: 1Optional

Filter by County ID

city_idinteger · min: 1Optional

Filter by City ID

namestringOptional

Filter by name.

kapida_enabledbooleanOptional

Filter by kapıda enabled status.

Example: true

fast_deliverybooleanOptional

Filter by fast delivery availability.

Example: true

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses

200

A list of detailed retail stores.

application/json

countintegerOptional

Total number of items

nextstring · nullableOptional

URL for next page

previousstring · nullableOptional

URL for previous page

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

401

Unauthorized Access

application/json

500

Server Error

get

/api/v1/channel/{channel_id}/retail_stores/detailed/

HTTPcURLJavaScriptPython

GET /api/v1/channel/{channel_id}/retail_stores/detailed/ HTTP/1.1
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": "[phone]",
      "fax_phone_number": "[phone]",
      "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"
      }
    }
  ]
}

Bulk remove retail stores from store group

post

Removes all retail stores from a group asynchronously.

Authorizations

Token

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Query parameters

click_and_collectbooleanOptional

Filter by click-and-collect availability.

Example: true

erp_codestringOptional

Filter by ERP code (contains)

Example: ERPCODE123

erp_code_iexactstringOptional

Filter by exact ERP code (case-insensitive)

Example: ERPCODE123

erp_code__instring[]Optional

Filter by multiple ERP codes (comma-separated list)

township_idinteger · min: 1Optional

Filter by Township ID

country_idinteger · min: 1Optional

Filter by County ID

city_idinteger · min: 1Optional

Filter by City ID

namestringOptional

Filter by name.

kapida_enabledbooleanOptional

Filter by kapıda enabled status.

Example: true

fast_deliverybooleanOptional

Filter by fast delivery availability.

Example: true

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:

related_retail_store_excludedintegerOptional

Exclude the specified store and all stores related to it.

Example: 101

retail_store_groupintegerOptional

Filter by store group ID.

Example: 1

Responses

200

Successfully removed all retail stores from the group.

application/json

cache_keystringOptional

Cache key for the operation.

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

403

Forbidden

404

The given resource or object was not found or does not exist.

application/json

500

Server Error

post

/api/v1/channel/{channel_id}/retail_stores/bulk_remove_store_group/

HTTPcURLJavaScriptPython

POST /api/v1/channel/{channel_id}/retail_stores/bulk_remove_store_group/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "cache_key": "text"
}