masstack

V2
API Overview Resources Schemas

Commercial profiles

Access to commercial profile endpoints

Parameters

Name In Type Required Description
org_id path string true organization name
visibility_type query VisibilityType false visibility type

Request example

1
2
3
4
5


curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles?visibility_type='POSITIVE' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK [getCommercialProfileBasic_Response]
400 Bad Request Bad request string
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of getCommercialProfileBasic_Response

Custom schema example

1
2
3
4
5
6
7

[
  {
    "id": 4,
    "name": "perfil_comercial.postpago_ventas_pos",
    "visibility_type": "POSITIVE"
  }
]
Name Type Required Description
id string false none
name string false none
visibility_type string false none

400 - JsonObject

Custom schema example

1

"Bad Request"
Name Type Required Description
id string false none
name string false none
visibility_type string false none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."
Name Type Required Description
id string false none
name string false none
visibility_type string false none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5

{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}
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
com_profile_id path string true commercial profile id

Request example

1
2
3
4
5


curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/commercial_products \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK [getCPByComProfile_Response]
400 Bad Request Bad request string
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of getCPByComProfile_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

[
  {
    "id": "341",
    "name": "TARIFA MAS 10GB",
    "marketing_name": "TARIFA MAS 10GB",
    "digital_channels_name": "TARIFA MAS 10GB",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "mysim_commercial_product_id": "770",
    "data_sharing_compatible": true,
    "penalty_reference": 6.9043,
    "max_devices": 1,
    "max_concurrent_views": 2,
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z"
  }
]
Name Type Required Description
anonymous CommercialProductSimple false none
Name Type Required Description
anonymous object false none
» from string(date-time) false date when the commercial product starts to be included within the commercial profile
» to string(date-time) false date when the commercial product starts to be included within the commercial profile

400 - JsonObject

Custom schema example

1

"Bad Request"
Name Type Required Description
anonymous CommercialProductSimple false none
Name Type Required Description
anonymous object false none
» from string(date-time) false date when the commercial product starts to be included within the commercial profile
» to string(date-time) false date when the commercial product starts to be included within the commercial profile

401 - JsonObject

Custom schema example

1

"Origin authentication failed."
Name Type Required Description
anonymous CommercialProductSimple false none
Name Type Required Description
anonymous object false none
» from string(date-time) false date when the commercial product starts to be included within the commercial profile
» to string(date-time) false date when the commercial product starts to be included within the commercial profile

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5

{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}
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
com_profile_id path string true commercial profile id

Request example

1
2
3
4
5


curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/free_units_packages \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK [getFUPByComProfile_Response]
400 Bad Request Bad request string
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of getFUPByComProfile_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

[
  {
    "id": "313",
    "name": "INTERNET 10GB_TPILI",
    "marketing_name": "INTERNET 10GB_TPILI",
    "digital_channels_name": "INTERNET 10GB_TPILI",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "mysim_free_units_package_id": "469",
    "unit_amount": 10737418240,
    "volume_home_sl0": 10737418240,
    "volume_home_sl1": 10737418240,
    "volume_rlah_sl0": 10737418240,
    "volume_rlah_sl1": 10737418240,
    "volume_nr_sl0": 10737418240,
    "volume_nr_sl1": 10737418240,
    "unlimited": false,
    "max_grants": 0,
    "is_recurring_package": true,
    "applicability_priority": 1,
    "used_for_policy_rule_change": false,
    "sharing_compatible": true,
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z"
  }
]
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
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
mysim_free_units_package_id string false internal id used within Mysim, null for ‘dummy’ unlimited voice free units packages
unit_amount number(int64) false amount of units granted within the package. Currently, the unit type is always the same depending on the event type. VOZ (secs), DATOS (bytes), SMS (SMS)
volume_home_sl0 number(int64) false Data volume in bytes navigable at maximum speed
volume_home_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps)
volume_rlah_sl0 number(int64) false Data volume in bytes navigable at maximum speed with roaming like at home
volume_rlah_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home
volume_nr_sl0 number(int64) false Data volume in bytes navigable at maximum speed with national roaming
volume_nr_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming
unlimited boolean false indicates if the free units is sold as an unlimited package
max_grants number(int32) false maximum number of grants before the free units package expires (the maxGrants value never includes the first grant period. This means that a free units package with NRTIMES = 11 that is activated on 15/01/2020 will be active until 31/12/2020). Zero for recurring packages with no limit. In this case the package will expire when being explicitly deactivated. Null for one time packages
is_recurring_package boolean false indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned
applicability_priority number(int32) false priority of the free units package when consuming
used_for_policy_rule_change boolean false indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached)
sharing_compatible boolean false none
from string(date-time) false date when the free units package starts to be included within the commercial profile
to string(date-time) false date when the free units package starts to be included within the commercial profile

400 - JsonObject

Custom schema example

1

"Bad Request"
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
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
mysim_free_units_package_id string false internal id used within Mysim, null for ‘dummy’ unlimited voice free units packages
unit_amount number(int64) false amount of units granted within the package. Currently, the unit type is always the same depending on the event type. VOZ (secs), DATOS (bytes), SMS (SMS)
volume_home_sl0 number(int64) false Data volume in bytes navigable at maximum speed
volume_home_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps)
volume_rlah_sl0 number(int64) false Data volume in bytes navigable at maximum speed with roaming like at home
volume_rlah_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home
volume_nr_sl0 number(int64) false Data volume in bytes navigable at maximum speed with national roaming
volume_nr_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming
unlimited boolean false indicates if the free units is sold as an unlimited package
max_grants number(int32) false maximum number of grants before the free units package expires (the maxGrants value never includes the first grant period. This means that a free units package with NRTIMES = 11 that is activated on 15/01/2020 will be active until 31/12/2020). Zero for recurring packages with no limit. In this case the package will expire when being explicitly deactivated. Null for one time packages
is_recurring_package boolean false indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned
applicability_priority number(int32) false priority of the free units package when consuming
used_for_policy_rule_change boolean false indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached)
sharing_compatible boolean false none
from string(date-time) false date when the free units package starts to be included within the commercial profile
to string(date-time) false date when the free units package starts to be included within the commercial profile

401 - JsonObject

Custom schema example

1

"Origin authentication failed."
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
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
mysim_free_units_package_id string false internal id used within Mysim, null for ‘dummy’ unlimited voice free units packages
unit_amount number(int64) false amount of units granted within the package. Currently, the unit type is always the same depending on the event type. VOZ (secs), DATOS (bytes), SMS (SMS)
volume_home_sl0 number(int64) false Data volume in bytes navigable at maximum speed
volume_home_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps)
volume_rlah_sl0 number(int64) false Data volume in bytes navigable at maximum speed with roaming like at home
volume_rlah_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home
volume_nr_sl0 number(int64) false Data volume in bytes navigable at maximum speed with national roaming
volume_nr_sl1 number(int64) false Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming
unlimited boolean false indicates if the free units is sold as an unlimited package
max_grants number(int32) false maximum number of grants before the free units package expires (the maxGrants value never includes the first grant period. This means that a free units package with NRTIMES = 11 that is activated on 15/01/2020 will be active until 31/12/2020). Zero for recurring packages with no limit. In this case the package will expire when being explicitly deactivated. Null for one time packages
is_recurring_package boolean false indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned
applicability_priority number(int32) false priority of the free units package when consuming
used_for_policy_rule_change boolean false indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached)
sharing_compatible boolean false none
from string(date-time) false date when the free units package starts to be included within the commercial profile
to string(date-time) false date when the free units package starts to be included within the commercial profile

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5

{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}
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
com_profile_id path string true commercial profile id

Request example

1
2
3
4
5


curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/promotions \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK [getPromoByComProfile_Response]
400 Bad Request Bad request string
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of getPromoByComProfile_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA"
  }
]
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
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
need_promotion_code boolean false boolean to indicate if the promotion requires capturing a code for being applied
need_existent_MSISDN boolean false boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign)
applicability_model string false it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase),
restrictions_applicability_rule string false rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions
target_applicability_rule string false rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype)
fee_subtypes string false used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied
calculation_model string false used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used)
discount_type string false it defines if the discount value is a % or a fixed amount
duration number(int32) false promotion duration indicated in number of months
keep_on_upgrade boolean false used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost
keep_on_downgrade boolean false used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost
priority number(int32) false promotion applicability priority (lower value = higher priority). Currently always 1
is_mandatory boolean false none
xsell_permit boolean false none
reduced_fee_amount boolean false none
value number(double) false none
currency string false null for values associated to promotion with discountTYpe=percentage. euro for rest
from string(date-time) false date when the promotion starts to be included within the commercial profile
to string(date-time) false date when the promotion starts to be included within the commercial profile
skip_first_period boolean false it indicates if the first period of billing is skipped
reduce_penalty_threshold boolean false it indicates if the reference value has to be decreased
category_name string false name to define the promotion category
type_name string false name to define the promotion type

400 - JsonObject

Custom schema example

1

"Bad Request"
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
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
need_promotion_code boolean false boolean to indicate if the promotion requires capturing a code for being applied
need_existent_MSISDN boolean false boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign)
applicability_model string false it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase),
restrictions_applicability_rule string false rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions
target_applicability_rule string false rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype)
fee_subtypes string false used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied
calculation_model string false used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used)
discount_type string false it defines if the discount value is a % or a fixed amount
duration number(int32) false promotion duration indicated in number of months
keep_on_upgrade boolean false used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost
keep_on_downgrade boolean false used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost
priority number(int32) false promotion applicability priority (lower value = higher priority). Currently always 1
is_mandatory boolean false none
xsell_permit boolean false none
reduced_fee_amount boolean false none
value number(double) false none
currency string false null for values associated to promotion with discountTYpe=percentage. euro for rest
from string(date-time) false date when the promotion starts to be included within the commercial profile
to string(date-time) false date when the promotion starts to be included within the commercial profile
skip_first_period boolean false it indicates if the first period of billing is skipped
reduce_penalty_threshold boolean false it indicates if the reference value has to be decreased
category_name string false name to define the promotion category
type_name string false name to define the promotion type

401 - JsonObject

Custom schema example

1

"Origin authentication failed."
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
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
need_promotion_code boolean false boolean to indicate if the promotion requires capturing a code for being applied
need_existent_MSISDN boolean false boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign)
applicability_model string false it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase),
restrictions_applicability_rule string false rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions
target_applicability_rule string false rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype)
fee_subtypes string false used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied
calculation_model string false used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used)
discount_type string false it defines if the discount value is a % or a fixed amount
duration number(int32) false promotion duration indicated in number of months
keep_on_upgrade boolean false used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost
keep_on_downgrade boolean false used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost
priority number(int32) false promotion applicability priority (lower value = higher priority). Currently always 1
is_mandatory boolean false none
xsell_permit boolean false none
reduced_fee_amount boolean false none
value number(double) false none
currency string false null for values associated to promotion with discountTYpe=percentage. euro for rest
from string(date-time) false date when the promotion starts to be included within the commercial profile
to string(date-time) false date when the promotion starts to be included within the commercial profile
skip_first_period boolean false it indicates if the first period of billing is skipped
reduce_penalty_threshold boolean false it indicates if the reference value has to be decreased
category_name string false name to define the promotion category
type_name string false name to define the promotion type

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5

{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}
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
com_profile_id path string true commercial profile id

Request example

1
2
3
4
5


curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/bundled_products \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK OK [getBPByComProfile_Response]
400 Bad Request Bad request string
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of getBPByComProfile_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

[
  {
    "id": "182",
    "name": "Fibra 300 + Plan 3GB con ilimitadas",
    "marketing_name": "Fibra 300 + Plan 3GB con ilimitadas",
    "digital_channels_name": "Fibra 300 + Plan 3GB con ilimitadas",
    "bundled_segment": "PRO",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "category": "string",
    "category_id": "2",
    "download_speed": "300",
    "upload_speed": "300",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z"
  }
]
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
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’
from string(date-time) false date when the promotion starts to be included within the commercial profile
to string(date-time) false date when the promotion starts to be included within the commercial profile

400 - JsonObject

Custom schema example

1

"Bad Request"
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
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’
from string(date-time) false date when the promotion starts to be included within the commercial profile
to string(date-time) false date when the promotion starts to be included within the commercial profile

401 - JsonObject

Custom schema example

1

"Origin authentication failed."
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
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’
from string(date-time) false date when the promotion starts to be included within the commercial profile
to string(date-time) false date when the promotion starts to be included within the commercial profile

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5

{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}
Name Type Required Description
error string false none
message string false none
code string false none

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