Select
Commercial Devices
Access to commercial devices
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | organization name |
sale_type_name | query | SaleTypeName | false | sale type name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | ok | [CommercialDevicesTerms_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of CommercialDevicesTerms_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
campaign_id | string | false | none |
term | Terms_alone_Response | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
campaign_id | string | false | none |
term | Terms_alone_Response | 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 |
id | path | string | true | commercial product identifier |
sale_type_name | query | SaleTypeName | false | sale type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
payment_type | query | PaymentType | false | optional field that indicates if is financed or single payment |
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 |
permanence | query | boolean | false | flag to filter commercial devices based on whether they have permanence or not |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
payment_type | one of [SINGLE_PAYMENT, FINANCED_PAYMENT] |
device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Commercial devices | [CommercialDevice] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of CommercialDevice
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
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 |
id | path | string | true | bundled commercial product identifier |
sale_type_name | query | SaleTypeName | false | sale type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
donor_numeration_type_name | query | DonorNumerationType | false | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) |
commercial_profile_name | query | string | false | commercial profile name |
payment_type | query | PaymentType | false | optional field that indicates if is financed or single payment |
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 |
permanence | query | boolean | false | flag to filter commercial devices based on whether they have permanence or not |
mandatory | query | boolean | false | flag to filter commercial devices that are mandatory to sell in a bundled product. If absent default is false. |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
donor_numeration_type_name | one of [Pospago, Prepago] |
payment_type | one of [SINGLE_PAYMENT, FINANCED_PAYMENT] |
device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Commercial devices | [CommercialDevice] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of CommercialDevice
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
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 |
id | path | string | true | value added service identifier |
sale_type_name | query | SaleTypeName | false | sale type 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 |
permanence | query | boolean | false | flag to filter commercial devices based on whether they have permanence or not |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Commercial devices | [CommercialDevice] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of CommercialDevice
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» digital_channels_name | string | false | name to be shown within digital channels |
» from | string(date-time) | false | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service |
» to | string(date-time) | false | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service |
» is_mandatory | boolean | false | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service |
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 |
refinance_amount | query | number(double) | true | amount to refinance |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Refinance conditions | [CommercialDevice_installment_plan_refinance] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDevice_installment_plan | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» fees | [FeeInstallmentPlan_refinance_Response] | 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 |
sale_type_name | query | SaleTypeName | false | sale type name |
renewal_category | query | RenewalCategory | false | renewal category |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
donor_numeration_type_name | query | DonorNumerationType | false | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) |
commercial_profile_name | query | string | false | commercial profile name |
subs_offer_segment_name | query | string | false | name of the subscription offer segment |
payment_type | query | PaymentType | false | optional field that indicates if is financed or single payment |
device_category | query | DeviceCategory | false | optional field to filter by device category |
device_category[in] | query | string | false | multiple optional field to filter by device category. Case sensitive. Concatenate with ‘,’. |
device_brand | query | string | false | optional field to filter by device brand |
device_name | query | string | false | optional field to filter by device name. Case sensitive |
device_name[contains] | query | string | false | optional field to filter by device name. Case sensitive |
device_model | query | string | false | optional field to filter by device model. Case sensitive |
device_model[contains] | query | string | false | optional field to filter by device model with REGEX. Case sensitive |
device_colour | query | string | false | optional field to filter by device colour |
sort | query | string | false | The fields by which the results will be sorted. It can be a list of fields separated by commas. A suffix must be added: * “:asc” to indicate an ascending order. * “:desc” to indicate a descending order. |
generic_code | query | string | false | optional field to filter by generic code device |
device_id[contains] | query | string | false | filter for devices whose ids contain a specific string |
promotional_renew | query | boolean | false | optional field to indicate if its a promotional renewal. if not specified, it will be set to false |
permanence | query | boolean | false | flag to filter commercial devices based on whether they have permanence or not |
offset | query | integer(int32) | false | The number of elements to skip before starting to collect the result set. It can be used in combination with the limit parameter to control the pagination of the result set. |
limit | query | integer(int32) | false | The number of elements to return in the result set. It can be used in combination with the offset parameter to control the pagination of the result set. |
sellable | query | boolean | false | flag to filter items that are commercially active or not. If absent default is true |
mandatory | query | boolean | false | flag to filter commercial devices that are mandatory to sell in a bundled product. If absent default is false. |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
renewal_category | one of [Generic, Loyalty, Retention] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
donor_numeration_type_name | one of [Pospago, Prepago] |
payment_type | one of [SINGLE_PAYMENT, FINANCED_PAYMENT] |
device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | OK | CommercialDeviceList |
401 | Unauthorized | Unauthorized | string |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | organization name |
sale_type_name | query | SaleTypeName | false | sale type name |
renewal_category | query | RenewalCategory | false | renewal category |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
donor_numeration_type_name | query | DonorNumerationType | false | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) |
commercial_profile_name | query | string | false | commercial profile name |
subs_offer_segment_name | query | string | false | name of the subscription offer segment |
payment_type | query | PaymentType | false | optional field that indicates if is financed or single payment |
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 |
promotional_renew | query | boolean | false | optional field to indicate if its a promotional renewal. if not specified, it will be set to false |
permanence | query | boolean | false | flag to filter commercial devices based on whether they have permanence or not |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
renewal_category | one of [Generic, Loyalty, Retention] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
donor_numeration_type_name | one of [Pospago, Prepago] |
payment_type | one of [SINGLE_PAYMENT, FINANCED_PAYMENT] |
device_category | one of [SMARTPHONE, SMARTWATCH, OTROS, ROUTER, TABLET, STB, WIFI_EXTENDER] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Commercial Devices | [CommercialDeviceAlone] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | CommercialDeviceSimple | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» promotions | [PromotionDetail_Response] | 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 |
id | path | string | true | commercial device identifier |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Commercial device | CommercialDevice |
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
Provisioning Profiles
Services
Commercial Infos
Transaction types
Devices
Commercial profiles
Misc services