Stores

Retail stores and pickup locations (public)

List Pickup Locations

get

Find cargo pickup points (e.g., PTT, cargo offices).

Related Settings (Omnitron → Sales Channels → Dynamic Settings):

• PICKUP_LOCATION_PROVIDER (Dictionary): Configure external cargo/pickup location service. Structure:

  {
    "klass": "omnishop.address.pickup_locations.provider.PickupLocationProvider",
    "conf": {
      "base_url": "https://api.example.com",
      "username": "api_user",
      "password": "api_pass"
    }
  }

  Options:

  • PickupLocationProvider - Default provider

  • ExtensionPickupLocationProvider - Custom extension provider

Query parameters

countrystring · min: 2 · max: 2Required

Country code (e.g., TR, US)

cityintegerOptional

Filter by city ID

townshipintegerOptional

Filter by township ID

districtintegerOptional

Filter by district ID

postcodestring · min: 2 · max: 6Required

Postal code (2-6 characters)

Header parameters

Accept-Languagestring · enumOptional

Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr

Default: trExample: trPossible values:

Responses

200

List of pickup locations.

Response varies by provider:

• PickupLocationProvider: Returns PickupLocation schema
• ExtensionPickupLocationProvider: Returns ExtensionPickupLocation schema

application/json

or

400

Invalid parameters (missing required fields, invalid postcode length)

application/json

get/address/pickup-locations/

GET /address/pickup-locations/?country=text&postcode=text HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

[
  {
    "id": "text",
    "name": "text",
    "type": "text",
    "supply_chain_company": {
      "name": "text"
    },
    "country": "text",
    "city": "text",
    "township": "text",
    "district": "text",
    "address_text": "text",
    "working_hours": [
      {
        "day_of_week": "text",
        "hour_ranges": [
          {
            "start": "00:00:00",
            "end": "00:00:00",
            "service_cost": 1
          }
        ]
      }
    ],
    "currency": "text",
    "contact": {
      "related_staff_name": "text",
      "phone_number": "text",
      "email": "text"
    },
    "note": "text"
  }
]

List Retail Stores

get

Find retail stores for click-and-collect orders.

Query parameters

cityintegerOptional

Filter by city ID

townshipintegerOptional

Filter by township ID

pageinteger · min: 1Optional

Page number (starts from 1)

Default: 1Example: 1

page_sizeinteger · min: 1Optional

Number of records per page

Default: 10Example: 10

Header parameters

Accept-Languagestring · enumOptional

Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr

Default: trExample: trPossible values:

Responses

200

List of stores

application/json

countintegerOptional

nextstring · uri · nullableOptional

previousstring · uri · nullableOptional

get/address/retail_store/

GET /address/retail_store/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

200

List of stores

{
  "count": 1,
  "next": "https://example.com",
  "previous": "https://example.com",
  "results": [
    {
      "pk": 1,
      "name": "text",
      "township": 1,
      "district": 1,
      "address": "text",
      "phone_number": "text",
      "fax_phone_number": "text",
      "image": "text",
      "image_path": "text",
      "erp_code": "text",
      "store_hours": [
        [
          "00:00:00"
        ]
      ],
      "latitude": 1,
      "longitude": 1,
      "is_active": true,
      "click_and_collect": true,
      "store_type": 1,
      "kapida_enabled": true,
      "fast_delivery": true,
      "config": {},
      "group": 1,
      "sort_order": 1,
      "translations": {},
      "related_retail_stores": [
        1
      ],
      "created_date": "2026-01-01T00:00:00.000Z",
      "modified_date": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Get Store Details

get

View details of a specific retail store.

Path parameters

pkintegerRequired

Header parameters

Accept-Languagestring · enumOptional

Language preference (for multilingual content). Supported languages: tr, en, ar, ru, de, fr

Default: trExample: trPossible values:

Responses

200

Store details

application/json

pkintegerOptional

namestringOptional

townshipintegerOptional

districtinteger · nullableOptional

addressstringOptional

phone_numberstringOptional

fax_phone_numberstring · nullableOptional

imagestring · nullableOptional

Image URL

image_pathstring · nullableOptional

erp_codestring · nullableOptional

latitudenumber · float · nullableOptional

longitudenumber · float · nullableOptional

is_activebooleanOptional

click_and_collectbooleanOptional

Available for pickup orders?

store_typeinteger · nullableOptional

kapida_enabledbooleanOptional

fast_deliverybooleanOptional

configobjectOptional

groupinteger · nullableOptional

sort_orderintegerOptional

translationsobjectOptional

related_retail_storesinteger[]Optional

created_datestring · date-timeOptional

modified_datestring · date-timeOptional

404

Store not found

application/json

get/address/retail_store/{pk}/

GET /address/retail_store/{pk}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

{
  "pk": 1,
  "name": "text",
  "township": 1,
  "district": 1,
  "address": "text",
  "phone_number": "text",
  "fax_phone_number": "text",
  "image": "text",
  "image_path": "text",
  "erp_code": "text",
  "store_hours": [
    [
      "00:00:00"
    ]
  ],
  "latitude": 1,
  "longitude": 1,
  "is_active": true,
  "click_and_collect": true,
  "store_type": 1,
  "kapida_enabled": true,
  "fast_delivery": true,
  "config": {},
  "group": 1,
  "sort_order": 1,
  "translations": {},
  "related_retail_stores": [
    1
  ],
  "created_date": "2026-01-01T00:00:00.000Z",
  "modified_date": "2026-01-01T00:00:00.000Z"
}