LogoLogo
  • Welcome to Akinon Documentation
  • Products
    • ACC
    • Omnitron
    • Commerce
    • Order Management System (OMS)
    • Instore
    • Integrator
    • Marketplace Dashboard (MPD)
    • Project Zero (PZ)
    • Seller Center
    • Akifast
    • App Maker
  • API Reference
    • Welcome to Akinon API Reference
  • Omnitron
    • Getting Started
    • Integration
      • Product
        • Product
        • Pre-Product
        • Attribute
        • Attribute Value
        • Attribute Set
        • Product Image
      • Price
        • Price List
        • Product Price
        • Currency Unit Table
      • Stock
        • Stock List
        • Product Stock
      • Order
        • Get Orders
        • Search Order
        • Get Order Detail by Order Number
        • Get Order Item Detail
        • Orders ID Detail Integration
        • Orders Waiting to Send to ERP
        • Update Order and Order Item
        • Stock Reservation Release
        • Order Cancellation
        • Cancellation & Refund Pending Orders
        • Order Discount Items
        • Order Status Codes & Cancellation Statuses
      • Migration
        • Getting Started
        • User Migration
        • Address Migration
        • Old Order Migration
        • Old Order Item Migration
        • View Migration Progress
        • Currency Options
    • PIM
      • Attributes & Sets
      • Mapping
      • Localization
      • Media
    • Catalogue
      • Introduction
      • Price List
      • Stock List
      • Catalogue Item
      • Category Trees
      • Product Collection
      • Product Sorting
    • Channels
      • Introduction
      • Payments
      • Customers
    • Order
      • Getting Started
      • Fulfillment
      • Cancellations & Refunds
    • Retail Stores
      • Retail Stores
    • User Management
      • Roles & Permissions
      • Add & Remove
    • Whippy Ware
      • Introduction
      • Stock
      • Stock Lists
      • Stock List Rules
      • Stock Providers
      • Stock Locations
  • Omnitron OpenAPIs
    • Without Server
      • Customers
      • Reporting
      • Deleted Items
      • Pos
      • AttributeValues
      • Attribute Values
      • Providers
      • LDAPProviders
      • Healthcheck
      • LoyaltyTransactions
      • Policies
      • Exports
      • Dashboard
      • AuthTOTP
      • Price Lists
      • ProductPrices
      • Districts
      • Cities
      • Countries
      • Townships
      • PrometheusMetrics
      • Language
      • Content Types
      • Mappings
      • Applications
      • ApplicationPermissions
      • Error Reports
      • MailTemplates
      • UploadLogo
      • SalesChannelMarketPlaceAttributeSetConfig
      • SalesChannelCancellationRequestImage
      • SalesChannelCities
      • SalesChannelCancellationReasons
      • SalesChannelCargoCompany
      • SalesChannelProductImage
      • SalesChannelAttributeConfig
      • SalesChannelAttributeValueConfig
      • SalesChannelTownships
      • SalesChannelCustomers
      • SalesChannelFailedIntegrations
      • SalesChannelGetStockList
      • SalesChannelRetailStore
      • IntegrationActions
      • SalesChannelOrderShippingInfo
      • SalesChannelBatchRequests
      • SalesChannelAddresses
      • SalesChannelMarketPlaceAttributeSet
      • SalesChannelErrorReports
      • SalesChannelCategoryNodes
      • SalesChannelDistricts
      • SalesChannelProductStock
      • SalesChannelExtraProductStock
      • SalesChannelOrders
      • SalesChannelCancellationPlans
      • SalesChannelExtraProductPrices
      • SalesChannelProduct
      • SalesChannelAttributeSchemas
      • SalesChannelProductCategories
      • SalesChannelCancellationRequests
      • SalesChannelMarketPlaceAttributeValue
      • SalesChannelMappedProduct
      • SalesChannelMarketPlaceAttribute
      • SalesChannelOrderItem
      • SalesChannelProductPrice
      • SalesChannelCreateOrder
      • GetPriceList
      • SalesChannelCountries
      • SalesChannelGetPriceList
      • SalesChannelCategoryTree
    • With Server
      • Customers
      • Reporting
      • Deleted Items
      • Pos
      • AttributeValues
      • Attribute Values
      • Providers
      • LDAPProviders
      • Healthcheck
      • LoyaltyTransactions
      • Policies
      • Exports
      • Dashboard
      • AuthTOTP
      • Price Lists
      • ProductPrices
      • Districts
      • Cities
      • Countries
      • Townships
      • PrometheusMetrics
      • Language
      • Mappings
      • Content Types
      • Applications
      • ApplicationPermissions
      • Error Reports
      • MailTemplates
      • UploadLogo
      • SalesChannelMarketPlaceAttributeSetConfig
      • SalesChannelCancellationRequestImage
      • SalesChannelCities
      • SalesChannelCancellationReasons
      • SalesChannelCargoCompany
      • SalesChannelProductImage
      • SalesChannelAttributeConfig
      • SalesChannelAttributeValueConfig
      • SalesChannelTownships
      • SalesChannelCustomers
      • SalesChannelFailedIntegrations
      • SalesChannelGetStockList
      • IntegrationActions
      • SalesChannelRetailStore
      • SalesChannelOrderShippingInfo
      • SalesChannelBatchRequests
      • SalesChannelAddresses
      • SalesChannelMarketPlaceAttributeSet
      • SalesChannelErrorReports
      • SalesChannelDistricts
      • SalesChannelCategoryNodes
      • SalesChannelProductStock
      • SalesChannelExtraProductStock
      • SalesChannelCountries
      • SalesChannelOrders
      • SalesChannelProduct
      • SalesChannelCancellationPlans
      • SalesChannelExtraProductPrices
      • SalesChannelProductCategories
      • SalesChannelAttributeSchemas
      • SalesChannelCancellationRequests
      • SalesChannelMarketPlaceAttributeValue
      • SalesChannelMappedProduct
      • SalesChannelMarketPlaceAttribute
      • SalesChannelOrderItem
      • SalesChannelProductPrice
      • SalesChannelCreateOrder
      • GetPriceList
      • SalesChannelGetPriceList
      • SalesChannelCategoryTree
  • Commerce
    • Users
      • Getting Started
      • User Management & Authentication
      • Password & OTP Operations
      • User Profile & Segment Management
      • User Payment & Card Management
      • User Orders & Cancellations
      • Anonymous User Orders & Cancellations
      • User Support & Conversation
      • Captcha Validation
      • Currency & Akifast Operations
    • Checkout
      • Payment Related
      • Payment Strategy Related
      • Shipping Related
      • Independent Pages
    • Product
    • User Collections
    • Basket
    • Discount
    • Autocomplete
    • Breadcrumb
    • Pretty URLs
    • Menu
    • Widgets
    • Loyalty Accounts
    • Address Migration
    • Index Configuration
    • Favourite Products
    • User Address
    • Data Warehouse
    • Introduction
      • Filtering Parameters
    • Data Warehouse
    • Default
  • OMS
    • Package Services
    • Package Item Services
    • Package Denial Reason Services
    • Order Services
    • Order Item Services
    • Transfer Order Services
    • Transfer Item Services
    • Channel Services
    • Cancellation Plan Services
    • Cancellation Reason Services
    • Address Setup Services
    • City Services
    • District Services
    • Township Services
    • Stock Location Address Services
    • Webhook Setup Services
    • Webhook Event Services
    • Omnitron Order Webhooks
    • Undelivered Webhook Event Services
    • Inventory Discrepancy Services
    • OMS Setup Services
    • UI Settings Services
    • OMS Audit Events Service
    • Customer Address Services
    • Application Settings Services
    • Content Type Services
    • Customer Services
    • Channel Setup Services
    • Demo Data Service
    • Order Execution Plan Services
    • Invoice Services
    • Localization Services
    • Action Log Services
    • Order Log Services
    • Celery Metrics Service
    • Stock Location Services
    • Stock Location Address Services
    • Stock Location Sender Address Services
    • Stock Location Sender Address Setup Services
    • Cargo Company Condition Services
    • Permission Group Services
  • OMS OpenAPIs
    • Package Services
      • Default
    • Transfer Order Services
      • Default
  • Instore
    • Password Reset Services
  • Integrator
    • Projects
    • Flows
    • Logs
  • Seller Center
    • Languages
    • Categories
    • Introduction
    • Products
    • Packages
    • Orders
    • Claims
    • Shipping Methods
  • Akifast
    • Authentication
  • B2B
    • Quotation
    • Basket
    • Division
    • User
    • Staff User
    • Groups
    • Notification
    • Notification Template
  • Flows
    • Shipment Flows
    • Payment Flows
    • SMS Flows
    • Basket Offer Flows
Powered by GitBook

© 2025 Akinon. All rights reserved.

On this page

Was this helpful?

  1. Omnitron OpenAPIs
  2. Without Server

SalesChannelAddresses

PreviousSalesChannelBatchRequestsNextSalesChannelMarketPlaceAttributeSet

Was this helpful?

Delete Sales Channel Address

delete

Delete Sales Channel Address for a specific channel.

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
204
Sales Channel Address deleted successfully
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
delete
DELETE /api/v1/channel/{channel_id}/addresses/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*

No content

Retrieve Sales Channel Cities with details

get

Retrieve a specific Sales Channel Cities by ID with details

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200
Sales Channel Address retrieved successfully with details
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
get
GET /api/v1/channel/{channel_id}/addresses/{id}/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "pk": 1,
  "email": "name@gmail.com",
  "phone_number": "text",
  "first_name": "text",
  "last_name": "text",
  "country": {
    "id": 1,
    "name": "Türkiye",
    "code": "TR",
    "is_active": true,
    "created_date": "2021-07-07T14:00:00Z",
    "modified_date": "2021-07-07T14:00:00Z",
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  },
  "city": {
    "id": 1,
    "name": "Istanbul",
    "created_date": "2025-05-22T10:32:34.081Z",
    "modified_date": "2025-05-22T10:32:34.081Z",
    "is_active": true,
    "country": 1,
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "priority": 1,
    "postcode": "34000"
  },
  "line": "text",
  "title": "text",
  "township": {
    "pk": 1,
    "name": "Esenler",
    "is_active": true,
    "city": 1,
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "postcode": "34000",
    "created_date": "2025-05-22T10:32:34.081Z",
    "modified_date": "2025-05-22T10:32:34.081Z"
  },
  "district": {
    "pk": 1,
    "name": "Davutpasa",
    "is_active": true,
    "city": 1,
    "township": 1,
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "postcode": "34000",
    "zipcode": "34000",
    "created_date": "2025-05-22T10:32:34.081Z",
    "modified_date": "2025-05-22T10:32:34.081Z"
  },
  "postcode": "text",
  "notes": "text",
  "company_name": "text",
  "tax_office": "text",
  "tax_no": "text",
  "e_bill_taxpayer": true,
  "hash_data": "text",
  "address_type": "customer",
  "retail_store": {
    "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,
    "related_retail_stores": [
      102,
      103
    ],
    "sort_order": 10,
    "is_return_accepted": true,
    "channels": [
      1,
      2,
      5
    ],
    "mapping": [
      {
        "created_date": "2025-05-22T10:32:34.081Z",
        "modified_date": "2025-05-22T10:32:34.081Z"
      }
    ],
    "translations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_date": "2025-05-22T10:32:34.081Z",
    "modified_date": "2025-05-22T10:32:34.081Z",
    "integration": [
      {
        "channel": {
          "id": 1,
          "name": "Commerce Channel",
          "catalog": 1,
          "channel_type": "web",
          "conf": {
            "ANY_ADDITIONAL_PROPERTY": "text"
          },
          "category_tree": "text",
          "is_active": true,
          "schema": {},
          "created_date": "2024-11-20T11:22:23.702774Z",
          "modified_date": "2024-11-20T11:22:23.702774Z"
        },
        "content_type": {
          "id": 1,
          "app_label": "text",
          "model": "text"
        },
        "object_id": 1,
        "remote_id": "text",
        "version_date": "2025-05-22T10:32:34.081Z",
        "state": {},
        "local_batch_id": "text",
        "status": "processing",
        "content_object": {}
      }
    ]
  },
  "remote_id": "text",
  "identity_number": "text",
  "extra_field": {},
  "customer": {
    "pk": 123,
    "email": "example@domain.com",
    "first_name": "John",
    "last_name": "Doe",
    "phone_number": "+123456789",
    "is_active": true,
    "channel_code": "CH123",
    "erp_code": "ERP456",
    "attributes": {
      "logged_ip": "127.0.0.1",
      "register_client_type": "default"
    },
    "attribute_kwargs": {},
    "localized_attributes": {},
    "localized_attribute_kwargs": {},
    "extra_field": {
      "key1": "value1",
      "key2": 100
    },
    "email_allowed": true,
    "sms_allowed": false,
    "call_allowed": true,
    "date_joined": "2023-01-15T10:30:00Z",
    "gender": "female",
    "user_type": "guest",
    "date_of_birth": "1985-08-25",
    "channel": 5
  },
  "is_active": true,
  "modified_date": "2025-05-22T10:32:34.081Z"
}

List Sales Channel Addresses

get

List Sales Channel Addresses

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

emailstring · emailOptional

Email address of the customer

Example: test@akinon.com
phone_numberstringOptional

Phone number of the customer

Example: +123456789
first_namestringOptional

First name of the customer

Example: John
last_namestringOptional

Last name of the customer

Example: Doe
customer_idintegerOptional

Filter by customer ID.

Example: 123
country_idinteger · min: 1Optional

Filter by County ID

township_idinteger · min: 1Optional

Filter by Township ID

city_idinteger · min: 1Optional

Filter by City ID

district_idinteger · min: 1Optional

Filter by District ID

is_activebooleanOptional

Filter by active status (True or False)

postcodestringOptional

Filter by Postcode

line__exactstringOptional

Filters by exact line

line__iexactstringOptional

Filters case insensitive by exact line

line__containsstringOptional

Filter by line containing the given string

line__icontainsstringOptional

Filter by line case-insensitive containing the given string

title__exactstringOptional

Filters by exact title

title__iexactstringOptional

Filters case insensitive by exact title

title__containsstringOptional

Filter by title containing the given string

title__icontainsstringOptional

Filter by title case-insensitive containing the given string

notes__exactstringOptional

Filters by exact notes

notes__iexactstringOptional

Filters case insensitive by exact notes

notes__containsstringOptional

Filter by notes containing the given string

notes__icontainsstringOptional

Filter by notes case-insensitive containing the given string

company_name__exactstringOptional

Filters by exact company_name

company_name__iexactstringOptional

Filters case insensitive by exact company_name

company_name__containsstringOptional

Filter by company_name containing the given string

company_name__icontainsstringOptional

Filter by company_name case-insensitive containing the given string

tax_office__exactstringOptional

Filters by exact tax_office

tax_office__iexactstringOptional

Filters case insensitive by exact tax_office

tax_office__containsstringOptional

Filter by tax_office containing the given string

tax_office__icontainsstringOptional

Filter by tax_office case-insensitive containing the given string

tax_no__exactstringOptional

Filters by exact tax_no

tax_no__iexactstringOptional

Filters case insensitive by exact tax_no

tax_no__containsstringOptional

Filter by tax_no containing the given string

tax_no__icontainsstringOptional

Filter by tax_no case-insensitive containing the given string

hash_data__exactstringOptional

Filters by exact hash_data

hash_data__iexactstringOptional

Filters case insensitive by exact hash_data

hash_data__containsstringOptional

Filter by hash_data containing the given string

hash_data__icontainsstringOptional

Filter by hash_data case-insensitive containing the given string

e_bill_taxpayerbooleanOptional

Filter by e_bill_taxpayer

city__priorityintegerOptional

Filter by city's priority

Example: 1
city__country_idinteger · min: 1Optional

Filter by City's County ID

city__postcodestringOptional

Filter by City's Postcode

district__city_idinteger · min: 1Optional

Filter by District's City ID

district__township_idinteger · min: 1Optional

Filter by District's Township ID

district__postcodestringOptional

Filter by District's Postcode

township__priorityintegerOptional

Filter by township's priority

Example: 1
township__city_idinteger · min: 1Optional

Filter by Township's City ID

township__postcodestringOptional

Filter by Township's Postcode

retail_store_idinteger · min: 1Optional

Filter by Retail Store ID

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:
mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
200
OK
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
get
GET /api/v1/channel/{channel_id}/addresses/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2025-05-22T10:32:34.081Z",
      "modified_date": "2025-05-22T10:32:34.081Z"
    }
  ]
}

List Sales Channel Addresses with details

get

List Sales Channel Addresses with details

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Query parameters
pageinteger · min: 1Optional

Specifies the page number of the current dataset

Default: 1
limitinteger · min: 1Optional

Indicates the number of rows on the current page.

Default: 10
pk__ininteger[]Optional

Filter by multiple primary key values (comma-separated list of integers)

emailstring · emailOptional

Email address of the customer

Example: test@akinon.com
phone_numberstringOptional

Phone number of the customer

Example: +123456789
first_namestringOptional

First name of the customer

Example: John
last_namestringOptional

Last name of the customer

Example: Doe
customer_idintegerOptional

Filter by customer ID.

Example: 123
country_idinteger · min: 1Optional

Filter by County ID

township_idinteger · min: 1Optional

Filter by Township ID

city_idinteger · min: 1Optional

Filter by City ID

district_idinteger · min: 1Optional

Filter by District ID

is_activebooleanOptional

Filter by active status (True or False)

postcodestringOptional

Filter by Postcode

line__exactstringOptional

Filters by exact line

line__iexactstringOptional

Filters case insensitive by exact line

line__containsstringOptional

Filter by line containing the given string

line__icontainsstringOptional

Filter by line case-insensitive containing the given string

title__exactstringOptional

Filters by exact title

title__iexactstringOptional

Filters case insensitive by exact title

title__containsstringOptional

Filter by title containing the given string

title__icontainsstringOptional

Filter by title case-insensitive containing the given string

notes__exactstringOptional

Filters by exact notes

notes__iexactstringOptional

Filters case insensitive by exact notes

notes__containsstringOptional

Filter by notes containing the given string

notes__icontainsstringOptional

Filter by notes case-insensitive containing the given string

company_name__exactstringOptional

Filters by exact company_name

company_name__iexactstringOptional

Filters case insensitive by exact company_name

company_name__containsstringOptional

Filter by company_name containing the given string

company_name__icontainsstringOptional

Filter by company_name case-insensitive containing the given string

tax_office__exactstringOptional

Filters by exact tax_office

tax_office__iexactstringOptional

Filters case insensitive by exact tax_office

tax_office__containsstringOptional

Filter by tax_office containing the given string

tax_office__icontainsstringOptional

Filter by tax_office case-insensitive containing the given string

tax_no__exactstringOptional

Filters by exact tax_no

tax_no__iexactstringOptional

Filters case insensitive by exact tax_no

tax_no__containsstringOptional

Filter by tax_no containing the given string

tax_no__icontainsstringOptional

Filter by tax_no case-insensitive containing the given string

hash_data__exactstringOptional

Filters by exact hash_data

hash_data__iexactstringOptional

Filters case insensitive by exact hash_data

hash_data__containsstringOptional

Filter by hash_data containing the given string

hash_data__icontainsstringOptional

Filter by hash_data case-insensitive containing the given string

e_bill_taxpayerbooleanOptional

Filter by e_bill_taxpayer

city__priorityintegerOptional

Filter by city's priority

Example: 1
city__country_idinteger · min: 1Optional

Filter by City's County ID

city__postcodestringOptional

Filter by City's Postcode

district__city_idinteger · min: 1Optional

Filter by District's City ID

district__township_idinteger · min: 1Optional

Filter by District's Township ID

district__postcodestringOptional

Filter by District's Postcode

township__priorityintegerOptional

Filter by township's priority

Example: 1
township__city_idinteger · min: 1Optional

Filter by Township's City ID

township__postcodestringOptional

Filter by Township's Postcode

retail_store_idinteger · min: 1Optional

Filter by Retail Store ID

mapping__integration_typestring · enumOptional

Filter by integration mapping object's integration type

Possible values:
mapping__code__exactstringOptional

Filter by integration mapping object's code

hyperbooleanOptional

Activate id to hyperlink the response data.

Responses
200
OK
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
get
GET /api/v1/channel/{channel_id}/addresses/detailed/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "email": "name@gmail.com",
      "phone_number": "text",
      "first_name": "text",
      "last_name": "text",
      "country": {
        "id": 1,
        "name": "Türkiye",
        "code": "TR",
        "is_active": true,
        "created_date": "2021-07-07T14:00:00Z",
        "modified_date": "2021-07-07T14:00:00Z",
        "translations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      },
      "city": {
        "id": 1,
        "name": "Istanbul",
        "created_date": "2025-05-22T10:32:34.081Z",
        "modified_date": "2025-05-22T10:32:34.081Z",
        "is_active": true,
        "country": 1,
        "translations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "priority": 1,
        "postcode": "34000"
      },
      "line": "text",
      "title": "text",
      "township": {
        "pk": 1,
        "name": "Esenler",
        "is_active": true,
        "city": 1,
        "translations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "postcode": "34000",
        "created_date": "2025-05-22T10:32:34.081Z",
        "modified_date": "2025-05-22T10:32:34.081Z"
      },
      "district": {
        "pk": 1,
        "name": "Davutpasa",
        "is_active": true,
        "city": 1,
        "township": 1,
        "translations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "postcode": "34000",
        "zipcode": "34000",
        "created_date": "2025-05-22T10:32:34.081Z",
        "modified_date": "2025-05-22T10:32:34.081Z"
      },
      "postcode": "text",
      "notes": "text",
      "company_name": "text",
      "tax_office": "text",
      "tax_no": "text",
      "e_bill_taxpayer": true,
      "hash_data": "text",
      "address_type": "customer",
      "retail_store": {
        "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,
        "related_retail_stores": [
          102,
          103
        ],
        "sort_order": 10,
        "is_return_accepted": true,
        "channels": [
          1,
          2,
          5
        ],
        "mapping": [
          {
            "created_date": "2025-05-22T10:32:34.081Z",
            "modified_date": "2025-05-22T10:32:34.081Z"
          }
        ],
        "translations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "created_date": "2025-05-22T10:32:34.081Z",
        "modified_date": "2025-05-22T10:32:34.081Z",
        "integration": [
          {
            "channel": {
              "id": 1,
              "name": "Commerce Channel",
              "catalog": 1,
              "channel_type": "web",
              "conf": {
                "ANY_ADDITIONAL_PROPERTY": "text"
              },
              "category_tree": "text",
              "is_active": true,
              "schema": {},
              "created_date": "2024-11-20T11:22:23.702774Z",
              "modified_date": "2024-11-20T11:22:23.702774Z"
            },
            "content_type": {
              "id": 1,
              "app_label": "text",
              "model": "text"
            },
            "object_id": 1,
            "remote_id": "text",
            "version_date": "2025-05-22T10:32:34.081Z",
            "state": {},
            "local_batch_id": "text",
            "status": "processing",
            "content_object": {}
          }
        ]
      },
      "remote_id": "text",
      "identity_number": "text",
      "extra_field": {},
      "customer": {
        "pk": 123,
        "email": "example@domain.com",
        "first_name": "John",
        "last_name": "Doe",
        "phone_number": "+123456789",
        "is_active": true,
        "channel_code": "CH123",
        "erp_code": "ERP456",
        "attributes": {
          "logged_ip": "127.0.0.1",
          "register_client_type": "default"
        },
        "attribute_kwargs": {},
        "localized_attributes": {},
        "localized_attribute_kwargs": {},
        "extra_field": {
          "key1": "value1",
          "key2": 100
        },
        "email_allowed": true,
        "sms_allowed": false,
        "call_allowed": true,
        "date_joined": "2023-01-15T10:30:00Z",
        "gender": "female",
        "user_type": "guest",
        "date_of_birth": "1985-08-25",
        "channel": 5
      },
      "is_active": true,
      "modified_date": "2025-05-22T10:32:34.081Z"
    }
  ]
}
  • GETRetrieve Sales Channel Address
  • PUTUpdate Sales Channel Address
  • DELETEDelete Sales Channel Address
  • PATCHPartial Update Sales Channel Address
  • GETRetrieve Sales Channel Cities with details
  • GETList Sales Channel Addresses
  • POSTCreate Sales Channel Address
  • GETList Sales Channel Addresses with details

Retrieve Sales Channel Address

get

Retrieve a specific Sales Channel Address by ID

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Responses
200
Sales Channel Address retrieved successfully
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
get
GET /api/v1/channel/{channel_id}/addresses/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Accept: */*
{
  "pk": 1,
  "email": "name@gmail.com",
  "phone_number": "text",
  "first_name": "text",
  "last_name": "text",
  "country": 1,
  "city": 1,
  "line": "text",
  "title": "text",
  "township": 1,
  "district": 1,
  "postcode": "text",
  "notes": "text",
  "company_name": "text",
  "tax_office": "text",
  "tax_no": "text",
  "e_bill_taxpayer": true,
  "hash_data": "text",
  "address_type": "customer",
  "retail_store": 1,
  "remote_id": "text",
  "identity_number": "text",
  "extra_field": {},
  "customer": 1,
  "is_active": true,
  "created_date": "2025-05-22T10:32:34.081Z",
  "modified_date": "2025-05-22T10:32:34.081Z"
}

Update Sales Channel Address

put

Update a specific Sales Channel Address by ID

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body
pkintegerOptional

Primary key of the address

emailstring · emailOptional

Email address of the contact person

phone_numberstringRequired

Phone number of the contact person

first_namestringOptional

First name of the contact person

last_namestringOptional

Last name of the contact person

countryintegerOptional

Related country ID

cityintegerOptional

Related city ID

linestringOptional

Street address line

titlestringOptional

Title of the contact person

townshipintegerOptional

Related township ID

districtintegerOptional

Related district ID

postcodestringOptional

Postal code

notesstringOptional

Additional notes about the address

company_namestringOptional

Company name associated with the address

tax_officestringOptional

Tax office name

tax_nostringOptional

Tax number

e_bill_taxpayerbooleanOptional

Indicates if the address is an e-bill taxpayer

hash_datastringRead-onlyOptional

Hash data for the address

address_typestring · enumOptional

Type of address

Example: customerPossible values:
retail_storeintegerOptional

Related retail store ID

remote_idstringOptional

Remote ID for the address

identity_numberstring | nullableOptional

Identity number of the contact person

extra_fieldobjectOptional

Extra field for additional data

customerintegerOptional

Related customer ID

is_activebooleanOptional

Indicates if the address is active

Responses
200
Sales Channel Address updated
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
put
PUT /api/v1/channel/{channel_id}/addresses/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "pk": 1,
  "email": "name@gmail.com",
  "phone_number": "text",
  "first_name": "text",
  "last_name": "text",
  "country": 1,
  "city": 1,
  "line": "text",
  "title": "text",
  "township": 1,
  "district": 1,
  "postcode": "text",
  "notes": "text",
  "company_name": "text",
  "tax_office": "text",
  "tax_no": "text",
  "e_bill_taxpayer": true,
  "address_type": "customer",
  "retail_store": 1,
  "remote_id": "text",
  "identity_number": "text",
  "extra_field": {},
  "customer": 1,
  "is_active": true,
  "modified_date": "2025-05-22T10:32:34.081Z"
}

No content

Partial Update Sales Channel Address

patch

Partial update a specific Sales Channel Address by ID

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
idintegerRequired

Unique identifier of the resource

Example: 1
Body
pkintegerOptional

Primary key of the address

emailstring · emailOptional

Email address of the contact person

phone_numberstringRequired

Phone number of the contact person

first_namestringOptional

First name of the contact person

last_namestringOptional

Last name of the contact person

countryintegerOptional

Related country ID

cityintegerOptional

Related city ID

linestringOptional

Street address line

titlestringOptional

Title of the contact person

townshipintegerOptional

Related township ID

districtintegerOptional

Related district ID

postcodestringOptional

Postal code

notesstringOptional

Additional notes about the address

company_namestringOptional

Company name associated with the address

tax_officestringOptional

Tax office name

tax_nostringOptional

Tax number

e_bill_taxpayerbooleanOptional

Indicates if the address is an e-bill taxpayer

hash_datastringRead-onlyOptional

Hash data for the address

address_typestring · enumOptional

Type of address

Example: customerPossible values:
retail_storeintegerOptional

Related retail store ID

remote_idstringOptional

Remote ID for the address

identity_numberstring | nullableOptional

Identity number of the contact person

extra_fieldobjectOptional

Extra field for additional data

customerintegerOptional

Related customer ID

is_activebooleanOptional

Indicates if the address is active

Responses
200
Sales Channel Address updated
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
patch
PATCH /api/v1/channel/{channel_id}/addresses/{id}/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "pk": 1,
  "email": "name@gmail.com",
  "phone_number": "text",
  "first_name": "text",
  "last_name": "text",
  "country": 1,
  "city": 1,
  "line": "text",
  "title": "text",
  "township": 1,
  "district": 1,
  "postcode": "text",
  "notes": "text",
  "company_name": "text",
  "tax_office": "text",
  "tax_no": "text",
  "e_bill_taxpayer": true,
  "address_type": "customer",
  "retail_store": 1,
  "remote_id": "text",
  "identity_number": "text",
  "extra_field": {},
  "customer": 1,
  "is_active": true,
  "modified_date": "2025-05-22T10:32:34.081Z"
}

No content

Create Sales Channel Address

post

Create Sales Channel Address for a specific channel.

Authorizations
Path parameters
channel_idintegerRequired

The channel ID of the resource.

Example: 5
Body
pkintegerOptional

Primary key of the address

emailstring · emailOptional

Email address of the contact person

phone_numberstringRequired

Phone number of the contact person

first_namestringOptional

First name of the contact person

last_namestringOptional

Last name of the contact person

countryintegerOptional

Related country ID

cityintegerOptional

Related city ID

linestringOptional

Street address line

titlestringOptional

Title of the contact person

townshipintegerOptional

Related township ID

districtintegerOptional

Related district ID

postcodestringOptional

Postal code

notesstringOptional

Additional notes about the address

company_namestringOptional

Company name associated with the address

tax_officestringOptional

Tax office name

tax_nostringOptional

Tax number

e_bill_taxpayerbooleanOptional

Indicates if the address is an e-bill taxpayer

hash_datastringRead-onlyOptional

Hash data for the address

address_typestring · enumOptional

Type of address

Example: customerPossible values:
retail_storeintegerOptional

Related retail store ID

remote_idstringOptional

Remote ID for the address

identity_numberstring | nullableOptional

Identity number of the contact person

extra_fieldobjectOptional

Extra field for additional data

customerintegerOptional

Related customer ID

is_activebooleanOptional

Indicates if the address is active

Responses
201
Address Created
application/json
401
Unauthorized Access
application/json
404
The given resource or object was not found or does not exist.
application/json
500
Server Error
post
POST /api/v1/channel/{channel_id}/addresses/ HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 461

{
  "pk": 1,
  "email": "name@gmail.com",
  "phone_number": "text",
  "first_name": "text",
  "last_name": "text",
  "country": 1,
  "city": 1,
  "line": "text",
  "title": "text",
  "township": 1,
  "district": 1,
  "postcode": "text",
  "notes": "text",
  "company_name": "text",
  "tax_office": "text",
  "tax_no": "text",
  "e_bill_taxpayer": true,
  "address_type": "customer",
  "retail_store": 1,
  "remote_id": "text",
  "identity_number": "text",
  "extra_field": {},
  "customer": 1,
  "is_active": true,
  "modified_date": "2025-05-22T10:32:34.081Z"
}
{
  "pk": 1,
  "email": "name@gmail.com",
  "phone_number": "text",
  "first_name": "text",
  "last_name": "text",
  "country": 1,
  "city": 1,
  "line": "text",
  "title": "text",
  "township": 1,
  "district": 1,
  "postcode": "text",
  "notes": "text",
  "company_name": "text",
  "tax_office": "text",
  "tax_no": "text",
  "e_bill_taxpayer": true,
  "hash_data": "text",
  "address_type": "customer",
  "retail_store": 1,
  "remote_id": "text",
  "identity_number": "text",
  "extra_field": {},
  "customer": 1,
  "is_active": true,
  "created_date": "2025-05-22T10:32:34.081Z",
  "modified_date": "2025-05-22T10:32:34.081Z"
}