Cities

Retrieve City

get

Retrieve a specific City by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

City retrieved successfully

application/json

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

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/cities/{id}/

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

{
  "id": 1,
  "name": "Istanbul",
  "created_date": "2026-03-07T03:10:02.919Z",
  "modified_date": "2026-03-07T03:10:02.919Z",
  "is_active": true,
  "country": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "priority": 1,
  "postcode": "34000"
}

Update City

put

Update a specific City by ID

Authorizations

AuthorizationstringRequired

Path parameters

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

City 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/cities/{id}/

PUT /api/v1/cities/{id}/ HTTP/1.1
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 City

delete

Delete a specific City by ID

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

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

/api/v1/cities/{id}/

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

No content

Partial Update City

patch

Partial update a specific City by ID

Authorizations

AuthorizationstringRequired

Path parameters

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

City 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/cities/{id}/

PATCH /api/v1/cities/{id}/ HTTP/1.1
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 City with details

get

Retrieve a specific City by ID with details

Authorizations

AuthorizationstringRequired

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

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

/api/v1/cities/{id}/detailed/

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

{
  "country": 1,
  "id": 1,
  "name": "Istanbul",
  "created_date": "2026-03-07T03:10:02.919Z",
  "modified_date": "2026-03-07T03:10:02.919Z",
  "is_active": true,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "priority": 1,
  "postcode": "34000"
}

List Cities

get

List Cities

Authorizations

AuthorizationstringRequired

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.

priorityintegerOptional

Filter by priority

Example: 1

country_idinteger · min: 1Optional

Filter by County ID

country__name__exactstringOptional

Filter by Country Name

country__code__exactstringOptional

Filter by Country Code

country__mapping__code__exactstringOptional

Filter by country's integration mapping object's code

country__mapping__integration_typeall ofOptional

Filter by country's integration mapping object's integration type

string · enumOptionalPossible values:

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/cities/

GET /api/v1/cities/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "name": "Istanbul",
      "created_date": "2026-03-07T03:10:02.919Z",
      "modified_date": "2026-03-07T03:10:02.919Z",
      "is_active": true,
      "country": 1,
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "priority": 1,
      "postcode": "34000"
    }
  ]
}

Create City

post

Create City

Authorizations

AuthorizationstringRequired

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

/api/v1/cities/

POST /api/v1/cities/ HTTP/1.1
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": "2026-03-07T03:10:02.919Z",
  "modified_date": "2026-03-07T03:10:02.919Z",
  "is_active": true,
  "country": 1,
  "translations": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "priority": 1,
  "postcode": "34000"
}

List Cities with details

get

List Cities with details

Authorizations

AuthorizationstringRequired

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.

priorityintegerOptional

Filter by priority

Example: 1

country_idinteger · min: 1Optional

Filter by County ID

country__name__exactstringOptional

Filter by Country Name

country__code__exactstringOptional

Filter by Country Code

country__mapping__code__exactstringOptional

Filter by country's integration mapping object's code

country__mapping__integration_typeall ofOptional

Filter by country's integration mapping object's integration type

string · enumOptionalPossible values:

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/cities/detailed/

GET /api/v1/cities/detailed/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "count": 0,
  "next": "text",
  "previous": "text",
  "results": [
    {
      "id": 1,
      "name": "Istanbul",
      "created_date": "2026-03-07T03:10:02.919Z",
      "modified_date": "2026-03-07T03:10:02.919Z",
      "is_active": true,
      "country": 1,
      "translations": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "priority": 1,
      "postcode": "34000"
    }
  ]
}

Create mapping for City

get

Create mapping for City

Authorizations

AuthorizationstringRequired

Responses

200

Mapping created 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

/api/v1/create_mapping/

GET /api/v1/create_mapping/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "content_type": 1,
  "object_id": 1,
  "content_object": {},
  "integration_type": "hepsiburada",
  "code": "text",
  "created_date": "2026-03-07T03:10:02.919Z",
  "modified_date": "2026-03-07T03:10:02.919Z"
}

Get mappings for City

get

Get mappings for City

Authorizations

AuthorizationstringRequired

Responses

200

Mapping collected 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

/api/v1/get_mappings/

GET /api/v1/get_mappings/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "pk": 1,
  "content_type": 1,
  "object_id": 1,
  "content_object": {},
  "integration_type": "hepsiburada",
  "code": "text",
  "created_date": "2026-03-07T03:10:02.919Z",
  "modified_date": "2026-03-07T03:10:02.919Z"
}

Get integration mapping types for City

get

Get integration mapping types for City

Authorizations

AuthorizationstringRequired

Responses

200

Integration Mapping Types collected successfully

application/json

Other propertiesstringOptional

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/get_integration_mapping_types/

GET /api/v1/get_integration_mapping_types/ HTTP/1.1
Authorization: YOUR_API_KEY
Accept: */*

{
  "hepsiburada": "Hepsiburada",
  "hepsiburadads": "Hepsiburadads",
  "n11": "N11",
  "web": "Web",
  "external_company": "External Company",
  "gittigidiyor": "Gittigidiyor",
  "trendyol": "Trendyol",
  "ups": "Ups",
  "morhipo": "Morhipo",
  "morhipoV2": "Morhipov2",
  "amazon": "Amazon",
  "b2c_direct": "B2C Direct",
  "allegro": "Allegro",
  "akinon": "Akinon",
  "ay_cargo": "Ay Cargo",
  "aliexpress": "Aliexpress",
  "emag": "Emag",
  "yurtici": "Yurtici",
  "ciceksepeti": "Ciceksepeti",
  "fancourier": "Fancourier",
  "diva": "Diva",
  "hana": "Hana",
  "gordumaldim": "Gordumaldim",
  "pazarama": "Pazarama",
  "flo": "Flo",
  "dpd": "Dpd",
  "cdek": "Cdek",
  "turkcellds": "Turkcellds",
  "sales_channel": "Sales Channel",
  "kolay_gelsin": "Kolay Gelsin",
  "sameday": "Sameday",
  "sendeo": "Sendeo",
  "cargus": "Cargus",
  "dataeva": "Dataeva",
  "speedy": "Speedy",
  "modanisa": "Modanisa"
}

PreviousDistricts NextCountries

Last updated 1 month ago

Was this helpful?

hashtagRetrieve City

hashtagUpdate City

hashtagDelete City

hashtagPartial Update City

hashtagRetrieve City with details

hashtagList Cities

hashtagCreate City

hashtagList Cities with details

hashtagCreate mapping for City

hashtagGet mappings for City

hashtagGet integration mapping types for City

Retrieve City

Update City

Delete City

Partial Update City

Retrieve City with details

List Cities

Create City

List Cities with details

Create mapping for City

Get mappings for City

Get integration mapping types for City