Select
Bundled Products
Access to bundled products
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | organization name |
id | path | string | true | bundled product identifier |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bundled product | BundledProductBasic_Response |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | organization name |
commercial_profile_name | query | string | false | commercial profile name |
technology_name | query | TechnologyName | false | technology name |
territory_owner_id | query | string | false | territory owner identifier |
category | query | BundleCategory | false | bundled product category |
customer_segment_name | query | CustomerSegmentName | false | customer segment name |
commercial_segment_name | query | CommercialSegmentName | false | commercial segment name (SME (SmallMediumEnterprise) or Consumer) |
customer_type_name | query | CustomerTypeName | false | customer type name |
sale_type_name | query | SaleTypeName | false | sale type name |
include_optional_bundled_commercial_products | query | boolean | false | boolean to indicate if optional bundled commercial products details must be returned (not recommended). false by default |
Enumerated Values
Property | Values |
---|---|
technology_name | one of [ADSL, FIBRA] |
category | one of [Mobile, TV, Fixed+Broadband, Fixed+Mobile, Fixed+Broadband+Mobile, Fixed+Broadband+TV, Fixed+Broadband+Mobile+Netflix, Fixed+Broadband+Mobile+TV] |
customer_segment_name | one of [RESIDENCIAL, EMPRESA, AUTONOMO, HORECA] |
commercial_segment_name | one of [SME, Consumer] |
customer_type_name | one of [Nuevo, Existente] |
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bundled products | [BundledProduct_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of BundledProduct_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | real provisioning download speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | real provisioning upload speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
fees | [Fee_Response] | false | none |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | real provisioning download speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | real provisioning upload speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
fees | [Fee_Response] | false | none |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
commercial_profiles | [CommercialProfile_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 |
commercial_profile_name | query | string | false | commercial profile name |
technology_name | query | TechnologyName | false | technology name |
territory_owner_id | query | string | false | territory owner identifier |
category | query | BundleCategory | false | bundled product category |
customer_segment_name | query | CustomerSegmentName | false | customer segment name |
commercial_segment_name | query | CommercialSegmentName | false | commercial segment name (SME (SmallMediumEnterprise) or Consumer) |
customer_type_name | query | CustomerTypeName | false | customer type name |
sale_type_name | query | SaleTypeName | false | sale type name |
Enumerated Values
Property | Values |
---|---|
technology_name | one of [ADSL, FIBRA] |
category | one of [Mobile, TV, Fixed+Broadband, Fixed+Mobile, Fixed+Broadband+Mobile, Fixed+Broadband+TV, Fixed+Broadband+Mobile+Netflix, Fixed+Broadband+Mobile+TV] |
customer_segment_name | one of [RESIDENCIAL, EMPRESA, AUTONOMO, HORECA] |
commercial_segment_name | one of [SME, Consumer] |
customer_type_name | one of [Nuevo, Existente] |
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bundled products | [BundledProduct_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of BundledProduct_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | real provisioning download speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | real provisioning upload speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
fees | [Fee_Response] | false | none |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
invoice_name | string | false | none |
invoice_description | string | false | none |
in_catalogue_since | string(date-time) | false | none |
in_catalogue_until | string(date-time) | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | real provisioning download speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | real provisioning upload speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
internet_speed | string | false | commercial speed to be shown to client, could be different than the down and upload provisioning speed, used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
fees | [Fee_Response] | false | none |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
commercial_profiles | [CommercialProfile_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 | bundled product identifier |
subs_type_name | query | SubsTypeName | false | subscription type name |
Enumerated Values
Property | Values |
---|---|
subs_type_name | one of [PRE-PAGO, POST-PAGO, INTERNET FTTH, FIJO ANALOGICO, FIJO DIGITAL, INTERNET ADSL, AGILE TV, ENERGY, SECURITY, DATA_SHARING, MULTISIM, HEALTH, DEVICEINSURANCE, NETFLIX, APPLEWATCH, AMAZONPRIME, MAX, TV, ORANGE_TV_LIBRE, DISNEY] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bundled Product Subscription Type | [BundledProductSubsTypeBasic] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of BundledProductSubsTypeBasic
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
min_quantity | number(int32) | false | number of minimum subscriptions that must be included within the bundled product for the correspondent subscription type |
max_quantity | number(int32) | false | number of maximum subscriptions that can be included within the bundled product for the correspondent subscription type |
is_mandatory | boolean | false | indicates if the correspondent subscription type is mandatory within the bundled product |
used_for_automatic_orphan_subscription_change | boolean | false | boolean to indicate if the bundled commercial product change is available for manual or automatic changes. |
subs_type | SubsTypeName_Response | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
from | string(date-time) | false | none |
to | string(date-time) | false | none |
min_quantity | number(int32) | false | number of minimum subscriptions that must be included within the bundled product for the correspondent subscription type |
max_quantity | number(int32) | false | number of maximum subscriptions that can be included within the bundled product for the correspondent subscription type |
is_mandatory | boolean | false | indicates if the correspondent subscription type is mandatory within the bundled product |
used_for_automatic_orphan_subscription_change | boolean | false | boolean to indicate if the bundled commercial product change is available for manual or automatic changes. |
subs_type | SubsTypeName_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 | bundled product identifier |
technology_name | query | TechnologyName | false | technology name |
territory_owner_id | query | string | false | territory owner identifier |
category | query | BundleCategory | false | bundled product category |
commercial_profile_name | query | string | false | commercial profile name |
include_optional_bundled_commercial_products | query | boolean | false | boolean to indicate if optional bundled commercial products details must be returned (not recommended). false by default |
used_for_automatic_changes | query | boolean | false | boolean to indicate if the bundled product change is available for manual or automatic changes. false by default. Sale channels and customer apps must use always false . |
subs_removed | query | string | false | this query param allows to filter by a particular bundled_product_subscription_type |
Enumerated Values
Property | Values |
---|---|
technology_name | one of [ADSL, FIBRA] |
category | one of [Mobile, TV, Fixed+Broadband, Fixed+Mobile, Fixed+Broadband+Mobile, Fixed+Broadband+TV, Fixed+Broadband+Mobile+Netflix, Fixed+Broadband+Mobile+TV] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bundled products | [SwitchBundledProduct_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of SwitchBundledProduct_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
is_downsell | boolean | false | indicates if the switch involves a 3P to 2P change or a 4P to 3P/2P change |
used_for_automatic_changes | boolean | false | indicates if the bundled product change is supposed to be used for changes that don’t require manual agent/customer intervention (i,e partial deactivations due to mobile portability processes) |
involve_speed_change | boolean | false | indicates if the switch involves a speed change |
subs_removed | string | false | bundled product subscription type id removed in the automatic change. Null if used_for_automatic_changes = false |
commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
id | string | false | none |
name | string | false | none |
marketing_name | string | false | none |
digital_channels_name | string | false | name used within digital channels |
bundled_segment | BundledSegment_Response | false | none |
category | BundleCategory_Response | false | none |
category_id | string | false | none |
bundled_type | BundledType_Response | false | none |
download_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
upload_speed | string | false | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or ‘Fixed+Broadband+Mobile+TV’) and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ |
bundled_product_subs_types | [BundledProductSubsType] | false | array of subscription types included within the bundled products |
promotions | [PromotionDetail_Response] | false | array of promotions compatible with the bundled product |
is_downsell | boolean | false | indicates if the switch involves a 3P to 2P change or a 4P to 3P/2P change |
used_for_automatic_changes | boolean | false | indicates if the bundled product change is supposed to be used for changes that don’t require manual agent/customer intervention (i,e partial deactivations due to mobile portability processes) |
involve_speed_change | boolean | false | indicates if the switch involves a speed change |
subs_removed | string | false | bundled product subscription type id removed in the automatic change. Null if used_for_automatic_changes = false |
commercial_profiles | [CommercialProfile_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 |
target_id | path | string | true | id of target bundled_product to switch |
id | path | string | true | bundled product identifier |
territory_owner_id | query | string | false | territory owner identifier |
commercial_profile_name | query | string | false | commercial profile name |
include_optional_bundled_commercial_products | query | boolean | false | boolean to indicate if optional bundled commercial products details must be returned (not recommended). false by default |
used_for_automatic_changes | query | boolean | false | boolean to indicate if the bundled product change is available for manual or automatic changes. false by default. Sale channels and customer apps must use always false . |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Bundled products | SwitchBundledProduct_Response |
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