V2
Devices
Access to devices endpoints
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | organization name |
| device_category | query | DeviceCategory | false | optional field to filter by device category |
| device_brand | query | string | false | optional field to filter by device brand |
| generic_code | query | string | false | optional field to filter by generic code device |
| Accept-Language | header | string | false | Flag to indicate the text language, relies on ISO-639-1 |
| category_web | query | string | false | category web |
Enumerated Values
| Property | Values |
|---|---|
| device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
| category_web | one of [SMARTPHONE, TABLET, SMARTWATCH, SMART_TV, ROBOT_VACUUM_CLEANER, LAPTOP, SCOOTER, MONITOR, MODEM, GAMING, DEVICE, SCALE, HEADPHONE, SPEAKER, AIR_FRYER] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | [Device_Response] |
| 400 | Bad Request | Bad request | string |
| 401 | Unauthorized | Unauthorized | string |
| 404 | Not Found | Item not found | KOGenericResponse |
200 - instance of Device_Response
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | none |
| generic_code | string | false | none |
| brand | string | false | none |
| model | string | false | none |
| name | string | false | none |
| description | string | false | none |
| category | string | false | none |
| colour | string | false | none |
| is_available | boolean | false | based on this attribute we know if a device is active or not |
| include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
| image_url | string(url)¦null | false | url to device image |
| category_web | string | false | none |
| model_web | string | false | none |
| colour_name | string | false | none |
| hexadecimal_colour | string | false | none |
| brand_colour | boolean | false | none |
| specifications | string | false | none |
| control_app | boolean | false | none |
| battery | string | false | none |
| bluetooth_version | string | false | none |
| frontal_camera | string | false | none |
| back_camera | string | false | none |
| storage | string | false | none |
| wireless_charging | boolean | false | none |
| fast_charge | boolean | false | none |
| fast_charge_speed | string | false | none |
| box_content | string | false | none |
| telecare_compatible | boolean | false | none |
| connectivity | string | false | none |
| control_voice_assitant | boolean | false | none |
| dimensions | string | false | none |
| hard_drive | string | false | none |
| dual_sim | boolean | false | none |
| battery_duration | string | false | none |
| esim | boolean | false | none |
| flash | boolean | false | none |
| functions | string | false | none |
| touch_id | boolean | false | none |
| max_speed | string | false | none |
| memory | string | false | none |
| memory_expandable_to | string | false | none |
| ram_memory | string | false | none |
| microphone | boolean | false | none |
| nfc | boolean | false | none |
| user_number | string | false | none |
| mapping_allowed | boolean | false | none |
| weight | string | false | none |
| power | string | false | none |
| gaming_capabilities | string | false | none |
| processor | string | false | none |
| ports | string | false | none |
| weight_range | string | false | none |
| network | string | false | none |
| system_requirements | string | false | none |
| water_resistant | boolean | false | none |
| resolution | string | false | none |
| output | string | false | none |
| noise_cancelling | boolean | false | none |
| sensors | string | false | none |
| digital_tuner | string | false | none |
| os | string | false | none |
| sound | string | false | none |
| size | string | false | none |
| screen_size | string | false | none |
| technology | string | false | none |
| battery_charge_time | string | false | none |
| hard_drive_type | string | false | none |
| sim_type | string | false | none |
| download_speed | string | false | none |
| wifi | string | false | none |
| comments | string | false | none |
| promotional_info | PromotionalInfo | false | none |
| energy_label | string | false | none |
| esim_only | boolean | false | none |
| ean_code | string | false | none |
400 - JsonObject
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | none |
| generic_code | string | false | none |
| brand | string | false | none |
| model | string | false | none |
| name | string | false | none |
| description | string | false | none |
| category | string | false | none |
| colour | string | false | none |
| is_available | boolean | false | based on this attribute we know if a device is active or not |
| include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
| image_url | string(url)¦null | false | url to device image |
| category_web | string | false | none |
| model_web | string | false | none |
| colour_name | string | false | none |
| hexadecimal_colour | string | false | none |
| brand_colour | boolean | false | none |
| specifications | string | false | none |
| control_app | boolean | false | none |
| battery | string | false | none |
| bluetooth_version | string | false | none |
| frontal_camera | string | false | none |
| back_camera | string | false | none |
| storage | string | false | none |
| wireless_charging | boolean | false | none |
| fast_charge | boolean | false | none |
| fast_charge_speed | string | false | none |
| box_content | string | false | none |
| telecare_compatible | boolean | false | none |
| connectivity | string | false | none |
| control_voice_assitant | boolean | false | none |
| dimensions | string | false | none |
| hard_drive | string | false | none |
| dual_sim | boolean | false | none |
| battery_duration | string | false | none |
| esim | boolean | false | none |
| flash | boolean | false | none |
| functions | string | false | none |
| touch_id | boolean | false | none |
| max_speed | string | false | none |
| memory | string | false | none |
| memory_expandable_to | string | false | none |
| ram_memory | string | false | none |
| microphone | boolean | false | none |
| nfc | boolean | false | none |
| user_number | string | false | none |
| mapping_allowed | boolean | false | none |
| weight | string | false | none |
| power | string | false | none |
| gaming_capabilities | string | false | none |
| processor | string | false | none |
| ports | string | false | none |
| weight_range | string | false | none |
| network | string | false | none |
| system_requirements | string | false | none |
| water_resistant | boolean | false | none |
| resolution | string | false | none |
| output | string | false | none |
| noise_cancelling | boolean | false | none |
| sensors | string | false | none |
| digital_tuner | string | false | none |
| os | string | false | none |
| sound | string | false | none |
| size | string | false | none |
| screen_size | string | false | none |
| technology | string | false | none |
| battery_charge_time | string | false | none |
| hard_drive_type | string | false | none |
| sim_type | string | false | none |
| download_speed | string | false | none |
| wifi | string | false | none |
| comments | string | false | none |
| promotional_info | PromotionalInfo | false | none |
| energy_label | string | false | none |
| esim_only | boolean | false | none |
| ean_code | string | false | none |
401 - JsonObject
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | none |
| generic_code | string | false | none |
| brand | string | false | none |
| model | string | false | none |
| name | string | false | none |
| description | string | false | none |
| category | string | false | none |
| colour | string | false | none |
| is_available | boolean | false | based on this attribute we know if a device is active or not |
| include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
| image_url | string(url)¦null | false | url to device image |
| category_web | string | false | none |
| model_web | string | false | none |
| colour_name | string | false | none |
| hexadecimal_colour | string | false | none |
| brand_colour | boolean | false | none |
| specifications | string | false | none |
| control_app | boolean | false | none |
| battery | string | false | none |
| bluetooth_version | string | false | none |
| frontal_camera | string | false | none |
| back_camera | string | false | none |
| storage | string | false | none |
| wireless_charging | boolean | false | none |
| fast_charge | boolean | false | none |
| fast_charge_speed | string | false | none |
| box_content | string | false | none |
| telecare_compatible | boolean | false | none |
| connectivity | string | false | none |
| control_voice_assitant | boolean | false | none |
| dimensions | string | false | none |
| hard_drive | string | false | none |
| dual_sim | boolean | false | none |
| battery_duration | string | false | none |
| esim | boolean | false | none |
| flash | boolean | false | none |
| functions | string | false | none |
| touch_id | boolean | false | none |
| max_speed | string | false | none |
| memory | string | false | none |
| memory_expandable_to | string | false | none |
| ram_memory | string | false | none |
| microphone | boolean | false | none |
| nfc | boolean | false | none |
| user_number | string | false | none |
| mapping_allowed | boolean | false | none |
| weight | string | false | none |
| power | string | false | none |
| gaming_capabilities | string | false | none |
| processor | string | false | none |
| ports | string | false | none |
| weight_range | string | false | none |
| network | string | false | none |
| system_requirements | string | false | none |
| water_resistant | boolean | false | none |
| resolution | string | false | none |
| output | string | false | none |
| noise_cancelling | boolean | false | none |
| sensors | string | false | none |
| digital_tuner | string | false | none |
| os | string | false | none |
| sound | string | false | none |
| size | string | false | none |
| screen_size | string | false | none |
| technology | string | false | none |
| battery_charge_time | string | false | none |
| hard_drive_type | string | false | none |
| sim_type | string | false | none |
| download_speed | string | false | none |
| wifi | string | false | none |
| comments | string | false | none |
| promotional_info | PromotionalInfo | false | none |
| energy_label | string | false | none |
| esim_only | boolean | false | none |
| ean_code | string | false | none |
404 - instance of KOGenericResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| error | string | false | none |
| message | string | false | none |
| code | string | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | organization name |
| commercial_profile_name | query | string | true | commercial profile name |
| device_category | query | DeviceCategory | false | optional field to filter by device category |
| device_brand | query | string | false | optional field to filter by device brand |
| generic_code | query | string | false | optional field to filter by generic code device |
| Accept-Language | header | string | false | Flag to indicate the text language, relies on ISO-639-1 |
| category_web | query | string | false | category web |
Enumerated Values
| Property | Values |
|---|---|
| device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
| category_web | one of [SMARTPHONE, TABLET, SMARTWATCH, SMART_TV, ROBOT_VACUUM_CLEANER, LAPTOP, SCOOTER, MONITOR, MODEM, GAMING, DEVICE, SCALE, HEADPHONE, SPEAKER, AIR_FRYER] |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | [Device_Response] |
| 400 | Bad Request | Bad request | string |
| 401 | Unauthorized | Unauthorized | string |
| 404 | Not Found | Item not found | KOGenericResponse |
200 - instance of Device_Response
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | none |
| generic_code | string | false | none |
| brand | string | false | none |
| model | string | false | none |
| name | string | false | none |
| description | string | false | none |
| category | string | false | none |
| colour | string | false | none |
| is_available | boolean | false | based on this attribute we know if a device is active or not |
| include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
| image_url | string(url)¦null | false | url to device image |
| category_web | string | false | none |
| model_web | string | false | none |
| colour_name | string | false | none |
| hexadecimal_colour | string | false | none |
| brand_colour | boolean | false | none |
| specifications | string | false | none |
| control_app | boolean | false | none |
| battery | string | false | none |
| bluetooth_version | string | false | none |
| frontal_camera | string | false | none |
| back_camera | string | false | none |
| storage | string | false | none |
| wireless_charging | boolean | false | none |
| fast_charge | boolean | false | none |
| fast_charge_speed | string | false | none |
| box_content | string | false | none |
| telecare_compatible | boolean | false | none |
| connectivity | string | false | none |
| control_voice_assitant | boolean | false | none |
| dimensions | string | false | none |
| hard_drive | string | false | none |
| dual_sim | boolean | false | none |
| battery_duration | string | false | none |
| esim | boolean | false | none |
| flash | boolean | false | none |
| functions | string | false | none |
| touch_id | boolean | false | none |
| max_speed | string | false | none |
| memory | string | false | none |
| memory_expandable_to | string | false | none |
| ram_memory | string | false | none |
| microphone | boolean | false | none |
| nfc | boolean | false | none |
| user_number | string | false | none |
| mapping_allowed | boolean | false | none |
| weight | string | false | none |
| power | string | false | none |
| gaming_capabilities | string | false | none |
| processor | string | false | none |
| ports | string | false | none |
| weight_range | string | false | none |
| network | string | false | none |
| system_requirements | string | false | none |
| water_resistant | boolean | false | none |
| resolution | string | false | none |
| output | string | false | none |
| noise_cancelling | boolean | false | none |
| sensors | string | false | none |
| digital_tuner | string | false | none |
| os | string | false | none |
| sound | string | false | none |
| size | string | false | none |
| screen_size | string | false | none |
| technology | string | false | none |
| battery_charge_time | string | false | none |
| hard_drive_type | string | false | none |
| sim_type | string | false | none |
| download_speed | string | false | none |
| wifi | string | false | none |
| comments | string | false | none |
| promotional_info | PromotionalInfo | false | none |
| energy_label | string | false | none |
| esim_only | boolean | false | none |
| ean_code | string | false | none |
400 - JsonObject
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | none |
| generic_code | string | false | none |
| brand | string | false | none |
| model | string | false | none |
| name | string | false | none |
| description | string | false | none |
| category | string | false | none |
| colour | string | false | none |
| is_available | boolean | false | based on this attribute we know if a device is active or not |
| include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
| image_url | string(url)¦null | false | url to device image |
| category_web | string | false | none |
| model_web | string | false | none |
| colour_name | string | false | none |
| hexadecimal_colour | string | false | none |
| brand_colour | boolean | false | none |
| specifications | string | false | none |
| control_app | boolean | false | none |
| battery | string | false | none |
| bluetooth_version | string | false | none |
| frontal_camera | string | false | none |
| back_camera | string | false | none |
| storage | string | false | none |
| wireless_charging | boolean | false | none |
| fast_charge | boolean | false | none |
| fast_charge_speed | string | false | none |
| box_content | string | false | none |
| telecare_compatible | boolean | false | none |
| connectivity | string | false | none |
| control_voice_assitant | boolean | false | none |
| dimensions | string | false | none |
| hard_drive | string | false | none |
| dual_sim | boolean | false | none |
| battery_duration | string | false | none |
| esim | boolean | false | none |
| flash | boolean | false | none |
| functions | string | false | none |
| touch_id | boolean | false | none |
| max_speed | string | false | none |
| memory | string | false | none |
| memory_expandable_to | string | false | none |
| ram_memory | string | false | none |
| microphone | boolean | false | none |
| nfc | boolean | false | none |
| user_number | string | false | none |
| mapping_allowed | boolean | false | none |
| weight | string | false | none |
| power | string | false | none |
| gaming_capabilities | string | false | none |
| processor | string | false | none |
| ports | string | false | none |
| weight_range | string | false | none |
| network | string | false | none |
| system_requirements | string | false | none |
| water_resistant | boolean | false | none |
| resolution | string | false | none |
| output | string | false | none |
| noise_cancelling | boolean | false | none |
| sensors | string | false | none |
| digital_tuner | string | false | none |
| os | string | false | none |
| sound | string | false | none |
| size | string | false | none |
| screen_size | string | false | none |
| technology | string | false | none |
| battery_charge_time | string | false | none |
| hard_drive_type | string | false | none |
| sim_type | string | false | none |
| download_speed | string | false | none |
| wifi | string | false | none |
| comments | string | false | none |
| promotional_info | PromotionalInfo | false | none |
| energy_label | string | false | none |
| esim_only | boolean | false | none |
| ean_code | string | false | none |
401 - JsonObject
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| id | string | false | none |
| generic_code | string | false | none |
| brand | string | false | none |
| model | string | false | none |
| name | string | false | none |
| description | string | false | none |
| category | string | false | none |
| colour | string | false | none |
| is_available | boolean | false | based on this attribute we know if a device is active or not |
| include_preinstalled_sim | boolean | false | if the device has a built-in sim card |
| image_url | string(url)¦null | false | url to device image |
| category_web | string | false | none |
| model_web | string | false | none |
| colour_name | string | false | none |
| hexadecimal_colour | string | false | none |
| brand_colour | boolean | false | none |
| specifications | string | false | none |
| control_app | boolean | false | none |
| battery | string | false | none |
| bluetooth_version | string | false | none |
| frontal_camera | string | false | none |
| back_camera | string | false | none |
| storage | string | false | none |
| wireless_charging | boolean | false | none |
| fast_charge | boolean | false | none |
| fast_charge_speed | string | false | none |
| box_content | string | false | none |
| telecare_compatible | boolean | false | none |
| connectivity | string | false | none |
| control_voice_assitant | boolean | false | none |
| dimensions | string | false | none |
| hard_drive | string | false | none |
| dual_sim | boolean | false | none |
| battery_duration | string | false | none |
| esim | boolean | false | none |
| flash | boolean | false | none |
| functions | string | false | none |
| touch_id | boolean | false | none |
| max_speed | string | false | none |
| memory | string | false | none |
| memory_expandable_to | string | false | none |
| ram_memory | string | false | none |
| microphone | boolean | false | none |
| nfc | boolean | false | none |
| user_number | string | false | none |
| mapping_allowed | boolean | false | none |
| weight | string | false | none |
| power | string | false | none |
| gaming_capabilities | string | false | none |
| processor | string | false | none |
| ports | string | false | none |
| weight_range | string | false | none |
| network | string | false | none |
| system_requirements | string | false | none |
| water_resistant | boolean | false | none |
| resolution | string | false | none |
| output | string | false | none |
| noise_cancelling | boolean | false | none |
| sensors | string | false | none |
| digital_tuner | string | false | none |
| os | string | false | none |
| sound | string | false | none |
| size | string | false | none |
| screen_size | string | false | none |
| technology | string | false | none |
| battery_charge_time | string | false | none |
| hard_drive_type | string | false | none |
| sim_type | string | false | none |
| download_speed | string | false | none |
| wifi | string | false | none |
| comments | string | false | none |
| promotional_info | PromotionalInfo | false | none |
| energy_label | string | false | none |
| esim_only | boolean | false | none |
| ean_code | string | false | none |
404 - instance of KOGenericResponse
Custom schema example
|
|
| Name | Type | Required | Description |
|---|---|---|---|
| error | string | false | none |
| message | string | false | none |
| code | string | false | none |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string | true | organization name |
| device_id | path | string | true | device identifier |
| Accept-Language | header | string | false | Flag to indicate the text language, relies on ISO-639-1 |
Request example
|
|
Responses
| Code | Meaning | Description | Schema |
|---|---|---|---|
| 200 | OK | OK | Device_Response |
| 400 | Bad Request | Bad request | string |
| 401 | Unauthorized | Unauthorized | string |
| 404 | Not Found | Item not found | KOGenericResponse |
Endpoints
Commercial Products
Bundled Products
Bundled Commercial Products
Free Units Packages
Promotions
Commercial Devices
Rate Plans
Base profiles and services
Value Added Services
Services
Commercial Infos
Transaction types
Devices
Commercial profiles
Misc services