SalesChannelCities

Retrieve Sales Channel City

get

Retrieve a specific Sales Channel City 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 City 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

HTTPcURLJavaScriptPython

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

{
  "id": 1,
  "name": "Istanbul",
  "created_date": "2025-05-22T10:48:09.756Z",
  "modified_date": "2025-05-22T10:48:09.756Z",
  "is_active": true,
  "country": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "priority": 1,
  "postcode": "34000"
}

Update Sales Channel City

put

Update a specific Sales Channel City by ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idintegerRead-onlyOptional

City ID

namestring · stringRequired

City Name

Example: Istanbul

created_datestring · date-timeRead-onlyOptional

Creation Date

modified_datestring · date-timeRead-onlyOptional

Last Modification Date

is_activebooleanOptional

Is it active? (True/False)

Example: true

countryinteger · int64Required

Related Country ID

priorityinteger · int64Optional

Priority

Example: 1

postcodestring · stringOptional

Postcode

Example: 34000

Responses

200

Sales Channel City 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

HTTPcURLJavaScriptPython

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

{
  "name": "Istanbul",
  "is_active": true,
  "country": 1,
  "priority": 1,
  "postcode": "34000"
}

No content

Delete Sales Channel City

delete

Delete Sales Channel City 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 City 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

HTTPcURLJavaScriptPython

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

No content

Partial Update Sales Channel City

patch

Partial update a specific Sales Channel City by ID

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

idintegerRequired

Unique identifier of the resource

Example: 1

Body

idintegerRead-onlyOptional

City ID

namestring · stringRequired

City Name

Example: Istanbul

created_datestring · date-timeRead-onlyOptional

Creation Date

modified_datestring · date-timeRead-onlyOptional

Last Modification Date

is_activebooleanOptional

Is it active? (True/False)

Example: true

countryinteger · int64Required

Related Country ID

priorityinteger · int64Optional

Priority

Example: 1

postcodestring · stringOptional

Postcode

Example: 34000

Responses

200

Sales Channel City 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

HTTPcURLJavaScriptPython

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

{
  "name": "Istanbul",
  "is_active": true,
  "country": 1,
  "priority": 1,
  "postcode": "34000"
}

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 City 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

HTTPcURLJavaScriptPython

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

{
  "country": 1,
  "id": 1,
  "name": "Istanbul",
  "created_date": "2025-05-22T10:48:09.756Z",
  "modified_date": "2025-05-22T10:48:09.756Z",
  "is_active": true,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "priority": 1,
  "postcode": "34000"
}

List Sales Channel Cities

get

List Sales Channel Cities

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

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.

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

HTTPcURLJavaScriptPython

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "name": "Istanbul",
      "created_date": "2025-05-22T10:48:09.756Z",
      "modified_date": "2025-05-22T10:48:09.756Z",
      "is_active": true,
      "country": 1,
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "priority": 1,
      "postcode": "34000"
    }
  ]
}

Create Sales Channel City

post

Create Sales Channel City for a specific channel.

Authorizations

Path parameters

channel_idintegerRequired

The channel ID of the resource.

Example: 5

Body

idintegerRead-onlyOptional

City ID

namestring · stringRequired

City Name

Example: Istanbul

created_datestring · date-timeRead-onlyOptional

Creation Date

modified_datestring · date-timeRead-onlyOptional

Last Modification Date

is_activebooleanOptional

Is it active? (True/False)

Example: true

countryinteger · int64Required

Related Country ID

priorityinteger · int64Optional

Priority

Example: 1

postcodestring · stringOptional

Postcode

Example: 34000

Responses

201

City 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

HTTPcURLJavaScriptPython

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

{
  "name": "Istanbul",
  "is_active": true,
  "country": 1,
  "priority": 1,
  "postcode": "34000"
}

{
  "id": 1,
  "name": "Istanbul",
  "created_date": "2025-05-22T10:48:09.756Z",
  "modified_date": "2025-05-22T10:48:09.756Z",
  "is_active": true,
  "country": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "priority": 1,
  "postcode": "34000"
}

List Sales Channel Cities with details

get

List Sales Channel Cities 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

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.

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

HTTPcURLJavaScriptPython

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

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "name": "Istanbul",
      "created_date": "2025-05-22T10:48:09.756Z",
      "modified_date": "2025-05-22T10:48:09.756Z",
      "is_active": true,
      "country": 1,
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "priority": 1,
      "postcode": "34000"
    }
  ]
}