Promotions
Access to promotions
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | organization name |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
target_applicability_rule | query | TargetApplicabilityRule | false | target applicability rule |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
target_applicability_rule | one of [PreviousInvoiceTotalAmount, CurrentInvoiceTotalAmount, FeeSubtype, NOT_APPLICABLE] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotion | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 | commercial product identifier |
commercial_profile_name | query | string | false | commercial profile name |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotion | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 | commercial product identifier |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotions | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotion | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotions | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 commercial product identifier |
commercial_profile_name | query | string | false | commercial profile name |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotion | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 commercial product identifier |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotions | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 | value added service identifier |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotion | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 | value added service identifier |
sale_type_name | query | SaleTypeName | false | sale type name |
customer_type_name | query | CustomerTypeName | false | customer type name |
numeration_type_name | query | NumerationTypeName | false | numeration type name |
commercial_profile_name | query | string | false | commercial profile name |
Enumerated Values
Property | Values |
---|---|
sale_type_name | one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera] |
customer_type_name | one of [Nuevo, Existente] |
numeration_type_name | one of [Nuevo numero, Numero portado, Numero entre marcas] |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotions | [PromotionDetail_Response] |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
200 - instance of PromotionDetail_Response
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» commercial_profiles | [CommercialProfile_Response] | false | none |
401 - JsonObject
Custom schema example
|
|
Name | Type | Required | Description |
---|---|---|---|
anonymous | getPromoByComProfile_Response | false | none |
Name | Type | Required | Description |
---|---|---|---|
anonymous | object | false | none |
» terms | [TermsPromotion_Response] | false | none |
» transaction_type | TransactionType | false | none |
» 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 | promotion identifier |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | Promotion | PromotionDetail_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_product_id | path | string | true | Unique commercial_product identifier |
promotion_id | path | string | true | promotion identifier |
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. |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | List of incompatible promotions | PromotionIncompatibilityPaginatedList |
401 | Unauthorized | Unauthorized | string |
404 | Not Found | Item not found | KOGenericResponse |
Parameters
Name | In | Type | Required | Description |
---|---|---|---|---|
org_id | path | string | true | organization name |
bcp_id | path | string | true | bundled commercial product identifier |
promotion_id | path | string | true | promotion identifier |
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. |
Request example
|
|
Responses
Code | Meaning | Description | Schema |
---|---|---|---|
200 | OK | List of incompatible promotions | PromotionIncompatibilityPaginatedList |
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