Sales Channel Districts

Retrieve Sales Channel District

get

Retrieve a specific Sales Channel District by ID

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Sales Channel District retrieved successfully

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptional

Primary key of the district

namestring · stringRequired

District Name

Example: Davutpasa

is_activebooleanOptional

Is it active? (True/False)

Example: true

cityinteger · int64Required

Related City ID

townshipinteger · int64Required

Related Township ID

postcodestring · stringOptional

Postcode

Example: 34000

zipcodestring · stringOptional

Zipcode

Example: 34000

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get/api/v1/channel/{channel_id}/districts/{id}/

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

{
  "pk": 1,
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "postcode": "34000",
  "zipcode": "34000",
  "created_date": "2026-07-11T20:38:05.784Z",
  "modified_date": "2026-07-11T20:38:05.784Z"
}

Update Sales Channel District

put

Update a specific Sales Channel District by ID

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptional

Primary key of the district

namestring · stringRequired

District Name

Example: Davutpasa

is_activebooleanOptional

Is it active? (True/False)

Example: true

cityinteger · int64Required

Related City ID

townshipinteger · int64Required

Related Township ID

postcodestring · stringOptional

Postcode

Example: 34000

zipcodestring · stringOptional

Zipcode

Example: 34000

Responses

200

Sales Channel District updated

No content

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

put/api/v1/channel/{channel_id}/districts/{id}/

PUT /api/v1/channel/{channel_id}/districts/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "postcode": "34000",
  "zipcode": "34000",
  "modified_date": "2026-07-11T20:38:05.784Z"
}

No content

Delete Sales Channel District

delete

Delete a specific Sales Channel District by ID

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

Sales Channel District deleted successfully

No content

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

delete/api/v1/channel/{channel_id}/districts/{id}/

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

No content

Partial Update Sales Channel District

patch

Partial update a specific Sales Channel District by ID

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptional

Primary key of the district

namestring · stringRequired

District Name

Example: Davutpasa

is_activebooleanOptional

Is it active? (True/False)

Example: true

cityinteger · int64Required

Related City ID

townshipinteger · int64Required

Related Township ID

postcodestring · stringOptional

Postcode

Example: 34000

zipcodestring · stringOptional

Zipcode

Example: 34000

Responses

200

Sales Channel District updated

No content

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

patch/api/v1/channel/{channel_id}/districts/{id}/

PATCH /api/v1/channel/{channel_id}/districts/{id}/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "postcode": "34000",
  "zipcode": "34000",
  "modified_date": "2026-07-11T20:38:05.784Z"
}

No content

Retrieve Sales Channel District with details

get

Retrieve a specific Sales Channel District by ID with details

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

Sales Channel District retrieved successfully with details

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptional

Primary key of the district

namestring · stringRequired

District Name

Example: Davutpasa

is_activebooleanOptional

Is it active? (True/False)

Example: true

postcodestring · stringOptional

Postcode

Example: 34000

zipcodestring · stringOptional

Zipcode

Example: 34000

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get/api/v1/channel/{channel_id}/districts/{id}/detailed/

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

{
  "city": 1,
  "township": 1,
  "pk": 1,
  "name": "Davutpasa",
  "is_active": true,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "postcode": "34000",
  "zipcode": "34000",
  "created_date": "2026-07-11T20:38:05.784Z",
  "modified_date": "2026-07-11T20:38:05.784Z"
}

List Sales Channel Districts

get

List Sales Channel Districts

Authorizations

AuthorizationstringRequired

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

name__exactstringOptional

Filters by exact name

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.

city_idinteger · min: 1Optional

Filter by City ID

township_idinteger · min: 1Optional

Filter by Township ID

postcodestringOptional

Filter by Postcode

Responses

200

application/json

countintegerOptionalExample: 0

nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get/api/v1/channel/{channel_id}/districts/

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "created_date": "2026-07-11T20:38:05.784Z",
      "modified_date": "2026-07-11T20:38:05.784Z"
    }
  ]
}

Create Sales Channel District

post

Create Sales Channel District

Authorizations

AuthorizationstringRequired

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptional

Primary key of the district

namestring · stringRequired

District Name

Example: Davutpasa

is_activebooleanOptional

Is it active? (True/False)

Example: true

cityinteger · int64Required

Related City ID

townshipinteger · int64Required

Related Township ID

postcodestring · stringOptional

Postcode

Example: 34000

zipcodestring · stringOptional

Zipcode

Example: 34000

Responses

201

Sales Channel District Created

application/json

created_datestring · date-timeRead-onlyOptional

The date and time when the object was created.

modified_datestring · date-timeOptional

The date and time when the object was last modified.

pkintegerRead-onlyOptional

Primary key of the district

namestring · stringRequired

District Name

Example: Davutpasa

is_activebooleanOptional

Is it active? (True/False)

Example: true

cityinteger · int64Required

Related City ID

townshipinteger · int64Required

Related Township ID

postcodestring · stringOptional

Postcode

Example: 34000

zipcodestring · stringOptional

Zipcode

Example: 34000

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

post/api/v1/channel/{channel_id}/districts/

POST /api/v1/channel/{channel_id}/districts/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "postcode": "34000",
  "zipcode": "34000",
  "modified_date": "2026-07-11T20:38:05.784Z"
}

{
  "pk": 1,
  "name": "Davutpasa",
  "is_active": true,
  "city": 1,
  "township": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "postcode": "34000",
  "zipcode": "34000",
  "created_date": "2026-07-11T20:38:05.784Z",
  "modified_date": "2026-07-11T20:38:05.784Z"
}

List Districts with details

get

List Districts with details

Authorizations

AuthorizationstringRequired

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

name__exactstringOptional

Filters by exact name

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.

city_idinteger · min: 1Optional

Filter by City ID

township_idinteger · min: 1Optional

Filter by Township ID

postcodestringOptional

Filter by Postcode

Responses

200

application/json

countintegerOptionalExample: 0

nextstring · nullableOptional

Next page URL

previousstring · nullableOptional

Previous page URL

401

Unauthorized Access

application/json

404

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

application/json

500

Server Error

get/api/v1/channel/{channel_id}/districts/detailed/

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "pk": 1,
      "name": "Davutpasa",
      "is_active": true,
      "city": 1,
      "township": 1,
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "postcode": "34000",
      "zipcode": "34000",
      "created_date": "2026-07-11T20:38:05.784Z",
      "modified_date": "2026-07-11T20:38:05.784Z"
    }
  ]
}

PreviousSales Channel Error Reports NextSales Channel Category Nodes

Last updated 6 months ago

Was this helpful?