Inventory

Stock availability and retail store inventory

Query retail store stock for a product

get

Returns stock availability information across retail stores for a specific product.

Purpose: Enables "Click & Collect" functionality by showing which physical stores have a product in stock.

Response: Returns a list of retail stores with stock information, including:

• Store location details (address, city, township)

• Available stock quantity

• Store contact information

Filtering: Use query parameters to narrow results by geographic area:

• city_id: Show stores in a specific city

• township_id: Show stores in a specific township

• district_id: Show stores in a specific district

Rate Limiting: This endpoint is rate-limited to prevent abuse. Excessive requests may be throttled.

Path parameters

product_idintegerRequired

Unique identifier of the product to check stock for.

Example: 12345

Query parameters

city_idintegerOptional

Filter stores by city.

Example: 34

township_idintegerOptional

Filter stores by township (ilçe).

Example: 450

district_idintegerOptional

Filter stores by district (mahalle).

Example: 5670

Responses

200

Store stock information retrieved successfully

application/json

Retail store with stock availability information.

pkintegerOptional

Store identifier

Example: 101

namestringOptional

Store name

Example: Downtown Mall Branch

erp_codestringOptional

Store code in the ERP system.

Used for inventory synchronization.

Example: STR-DWN-001

phone_numberstringOptional

Store contact phone number

Example: [phone]

addressstringOptional

Full street address

Example: 123 Main Street, Floor 2

latitudenumber · floatOptional

Geographic latitude coordinate

Example: 41.0082

longitudenumber · floatOptional

Geographic longitude coordinate

Example: 28.9784

stockintegerOptional

Available stock quantity at this store.

Example: 5

is_availablebooleanOptional

Indicates if the product is available for collection at this store.

Example: true

404

Product not found

429

Rate limit exceeded

get

/retail_store_stock/{product_id}/

HTTPcURLJavaScriptPython

GET /retail_store_stock/{product_id}/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

[
  {
    "pk": 101,
    "name": "Downtown Mall Branch",
    "erp_code": "STR-DWN-001",
    "phone_number": "[phone]",
    "address": "123 Main Street, Floor 2",
    "township": {
      "pk": 450,
      "name": "Kadıköy",
      "city": {
        "pk": 34,
        "name": "İstanbul",
        "country": {
          "pk": 1,
          "name": "Türkiye",
          "code": "TR"
        }
      }
    },
    "latitude": 41.0082,
    "longitude": 28.9784,
    "stock": 5,
    "is_available": true
  }
]

Query stock availability for basket items

get

Returns retail store stock availability for all items in the user's basket.

Purpose: Enables "Click & Collect" checkout by finding stores that have all basket items in stock.

Authentication: Requires either:

• Authenticated session (logged-in user)

• Valid email identifier

Response: Returns stores that can fulfill the entire basket, including:

• Store details with location information

• Per-product availability status

• Collection tag/identifier

Filtering: Same geographic filters as single-product stock query:

• city_id, township_id, district_id

Query parameters

city_idintegerOptional

Filter stores by city.

Example: 34

township_idintegerOptional

Filter stores by township (ilçe).

Example: 450

district_idintegerOptional

Filter stores by district (mahalle).

Example: 5670

Responses

200

Basket stock availability retrieved successfully

application/json

Store availability result for basket items.

tagstringOptional

Collection identifier or tag for this fulfillment option.

Example: CC-2024-001

401

Authentication required.

User must be logged in or provide valid email identification.

429

Rate limit exceeded

get

/query-basket-stock/

HTTPcURLJavaScriptPython

GET /query-basket-stock/ HTTP/1.1
Host: sandbox.akinon.com
Accept: */*

[
  {
    "tag": "CC-2024-001",
    "products": [
      {
        "product_id": 12345,
        "quantity": 2
      }
    ],
    "retail_store": {
      "pk": 101,
      "name": "Downtown Mall Branch",
      "erp_code": "STR-DWN-001",
      "phone_number": "[phone]",
      "address": "123 Main Street, Floor 2",
      "township": {
        "pk": 450,
        "name": "Kadıköy",
        "city": {
          "pk": 34,
          "name": "İstanbul",
          "country": {
            "pk": 1,
            "name": "Türkiye",
            "code": "TR"
          }
        }
      },
      "latitude": 41.0082,
      "longitude": 28.9784,
      "stock": 5,
      "is_available": true
    }
  }
]