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

1
2
3
4
5

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

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

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products?commercial_profile_name='perfil_comercial.postpago_ventas_pos'&technology_name='FIBRA'&territory_owner_id='FIBMM02'&category='Fixed+Broadband+Mobile'&customer_segment_name='RESIDENCIAL'&commercial_segment_name='Consumer'&customer_type_name='Nuevo'&sale_type_name='Venta'&include_optional_bundled_commercial_products='true' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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

  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
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
[
  {
    "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",
    "bundled_type": "2P",
    "download_speed": "300",
    "upload_speed": "300",
    "internet_speed": "300",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "bundled_product_subs_types": [
      {
        "id": "731",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "min_quantity": 1,
        "max_quantity": 1,
        "is_mandatory": true,
        "used_for_automatic_orphan_subscription_change": false,
        "subs_type": {
          "name": "POST-PAGO",
          "description": "ADSL",
          "id": "5"
        },
        "bundled_commercial_products": [
          {
            "id": "4028",
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "is_mandatory": true,
            "is_main_line": true,
            "is_extra": false,
            "is_additional": false,
            "is_bundled": true,
            "duo_type": "NOT_DUO",
            "max_quantity": 1,
            "invoice_name": "TARIFA MAS 10GB",
            "commercial_product": {
              "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,
              "free_units_packages": [
                {
                  "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,
                  "event_type": "DATA",
                  "unlimited": false,
                  "max_grants": 0,
                  "is_recurring_package": true,
                  "applicability_priority": 1,
                  "used_for_policy_rule_change": false,
                  "category": "ONNET",
                  "sharing_compatible": true,
                  "free_units_package_template": {
                    "id": "BONUS_DATA_NATIONAL_RLAH",
                    "event_type": "DATA",
                    "applicability_rule": "ByEventTypeOriginDestination"
                  },
                  "fees": [
                    {}
                  ],
                  "promotions": [
                    {}
                  ],
                  "base_profiles": [
                    {}
                  ],
                  "commercial_profiles": [
                    {}
                  ],
                  "from": "2019-08-24T14:15:22Z",
                  "to": "2019-08-24T14:15:22Z",
                  "is_mandatory": true,
                  "is_mandatory_optional": false,
                  "is_mandatory_for_sale": true
                }
              ],
              "promotions": [
                {
                  "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,
                  "unlimited_duration": false,
                  "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",
                  "terms": [
                    {}
                  ],
                  "transaction_type": {
                    "id": "121",
                    "name": "DEVOLUCION AT. AL CLIENTE",
                    "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                    "is_active": true,
                    "is_external": false,
                    "tax_rate": "generic",
                    "transaction_type": "Credit",
                    "refund_transaction_type_id": "121"
                  },
                  "commercial_profiles": [
                    {}
                  ]
                }
              ],
              "commercial_profiles": [
                {
                  "id": 4,
                  "name": "perfil_comercial.postpago_ventas_pos",
                  "visibility_type": "POSITIVE",
                  "from": "2022-10-03T22:00:00Z",
                  "to": "2080-10-03T22:00:00Z"
                }
              ],
              "fees": [
                {
                  "id": "1",
                  "description": "TARIFA MAS 10GB cuotamensual",
                  "type": "RecurringCharge",
                  "subtype": "ServiceFee",
                  "recurrence_scheme": "BoundToBillCycle",
                  "recurrence_interval_type": "Monthly",
                  "recurrence_interval": 30,
                  "paid_in_advance": false,
                  "prorated_on_activation": true,
                  "prorated_on_deactivation": true,
                  "is_external": false,
                  "from": "2019-08-24T14:15:22Z",
                  "to": "2019-08-24T14:15:22Z",
                  "value": 8.264463,
                  "currency": "euro",
                  "terms": [
                    {}
                  ],
                  "transaction_type": {
                    "id": "121",
                    "name": "DEVOLUCION AT. AL CLIENTE",
                    "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                    "is_active": true,
                    "is_external": false,
                    "tax_rate": "generic",
                    "transaction_type": "Credit",
                    "refund_transaction_type_id": "121"
                  }
                }
              ]
            },
            "fees": [
              {
                "id": "1",
                "description": "TARIFA MAS 10GB cuotamensual",
                "type": "RecurringCharge",
                "subtype": "ServiceFee",
                "recurrence_scheme": "BoundToBillCycle",
                "recurrence_interval_type": "Monthly",
                "recurrence_interval": 30,
                "paid_in_advance": false,
                "prorated_on_activation": true,
                "prorated_on_deactivation": true,
                "is_external": false,
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z",
                "value": 8.264463,
                "currency": "euro",
                "terms": [
                  {
                    "id": "5138_promotion",
                    "name": "12 MESES-36E",
                    "type": "PermanenceContract",
                    "commitment_duration": 12,
                    "unlimited_duration": false,
                    "penalty_prorated": true,
                    "value": 8.264463,
                    "currency": "euro",
                    "permanence_type": "MAIN",
                    "transaction_type": {},
                    "from": "2019-08-24T14:15:22Z",
                    "to": "2019-08-24T14:15:22Z"
                  }
                ],
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                }
              }
            ],
            "commercial_profiles": [
              {
                "id": 4,
                "name": "perfil_comercial.postpago_ventas_pos",
                "visibility_type": "POSITIVE",
                "from": "2022-10-03T22:00:00Z",
                "to": "2080-10-03T22:00:00Z"
              }
            ]
          }
        ]
      }
    ],
    "promotions": [
      {
        "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,
        "unlimited_duration": false,
        "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",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "binding_type_id": 1
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "commercial_profiles": [
          {
            "id": 4,
            "name": "perfil_comercial.postpago_ventas_pos",
            "visibility_type": "POSITIVE",
            "from": "2022-10-03T22:00:00Z",
            "to": "2080-10-03T22:00:00Z"
          }
        ]
      }
    ],
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "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
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

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
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

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
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

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/sellable?commercial_profile_name='perfil_comercial.postpago_ventas_pos'&technology_name='FIBRA'&territory_owner_id='FIBMM02'&category='Fixed+Broadband+Mobile'&customer_segment_name='RESIDENCIAL'&commercial_segment_name='Consumer'&customer_type_name='Nuevo'&sale_type_name='Venta' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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

  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
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
[
  {
    "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",
    "bundled_type": "2P",
    "download_speed": "300",
    "upload_speed": "300",
    "internet_speed": "300",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "bundled_product_subs_types": [
      {
        "id": "731",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "min_quantity": 1,
        "max_quantity": 1,
        "is_mandatory": true,
        "used_for_automatic_orphan_subscription_change": false,
        "subs_type": {
          "name": "POST-PAGO",
          "description": "ADSL",
          "id": "5"
        },
        "bundled_commercial_products": [
          {
            "id": "4028",
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "is_mandatory": true,
            "is_main_line": true,
            "is_extra": false,
            "is_additional": false,
            "is_bundled": true,
            "duo_type": "NOT_DUO",
            "max_quantity": 1,
            "invoice_name": "TARIFA MAS 10GB",
            "commercial_product": {
              "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,
              "free_units_packages": [
                {
                  "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,
                  "event_type": "DATA",
                  "unlimited": false,
                  "max_grants": 0,
                  "is_recurring_package": true,
                  "applicability_priority": 1,
                  "used_for_policy_rule_change": false,
                  "category": "ONNET",
                  "sharing_compatible": true,
                  "free_units_package_template": {
                    "id": "BONUS_DATA_NATIONAL_RLAH",
                    "event_type": "DATA",
                    "applicability_rule": "ByEventTypeOriginDestination"
                  },
                  "fees": [
                    {}
                  ],
                  "promotions": [
                    {}
                  ],
                  "base_profiles": [
                    {}
                  ],
                  "commercial_profiles": [
                    {}
                  ],
                  "from": "2019-08-24T14:15:22Z",
                  "to": "2019-08-24T14:15:22Z",
                  "is_mandatory": true,
                  "is_mandatory_optional": false,
                  "is_mandatory_for_sale": true
                }
              ],
              "promotions": [
                {
                  "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,
                  "unlimited_duration": false,
                  "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",
                  "terms": [
                    {}
                  ],
                  "transaction_type": {
                    "id": "121",
                    "name": "DEVOLUCION AT. AL CLIENTE",
                    "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                    "is_active": true,
                    "is_external": false,
                    "tax_rate": "generic",
                    "transaction_type": "Credit",
                    "refund_transaction_type_id": "121"
                  },
                  "commercial_profiles": [
                    {}
                  ]
                }
              ],
              "commercial_profiles": [
                {
                  "id": 4,
                  "name": "perfil_comercial.postpago_ventas_pos",
                  "visibility_type": "POSITIVE",
                  "from": "2022-10-03T22:00:00Z",
                  "to": "2080-10-03T22:00:00Z"
                }
              ],
              "fees": [
                {
                  "id": "1",
                  "description": "TARIFA MAS 10GB cuotamensual",
                  "type": "RecurringCharge",
                  "subtype": "ServiceFee",
                  "recurrence_scheme": "BoundToBillCycle",
                  "recurrence_interval_type": "Monthly",
                  "recurrence_interval": 30,
                  "paid_in_advance": false,
                  "prorated_on_activation": true,
                  "prorated_on_deactivation": true,
                  "is_external": false,
                  "from": "2019-08-24T14:15:22Z",
                  "to": "2019-08-24T14:15:22Z",
                  "value": 8.264463,
                  "currency": "euro",
                  "terms": [
                    {}
                  ],
                  "transaction_type": {
                    "id": "121",
                    "name": "DEVOLUCION AT. AL CLIENTE",
                    "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                    "is_active": true,
                    "is_external": false,
                    "tax_rate": "generic",
                    "transaction_type": "Credit",
                    "refund_transaction_type_id": "121"
                  }
                }
              ]
            },
            "fees": [
              {
                "id": "1",
                "description": "TARIFA MAS 10GB cuotamensual",
                "type": "RecurringCharge",
                "subtype": "ServiceFee",
                "recurrence_scheme": "BoundToBillCycle",
                "recurrence_interval_type": "Monthly",
                "recurrence_interval": 30,
                "paid_in_advance": false,
                "prorated_on_activation": true,
                "prorated_on_deactivation": true,
                "is_external": false,
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z",
                "value": 8.264463,
                "currency": "euro",
                "terms": [
                  {
                    "id": "5138_promotion",
                    "name": "12 MESES-36E",
                    "type": "PermanenceContract",
                    "commitment_duration": 12,
                    "unlimited_duration": false,
                    "penalty_prorated": true,
                    "value": 8.264463,
                    "currency": "euro",
                    "permanence_type": "MAIN",
                    "transaction_type": {},
                    "from": "2019-08-24T14:15:22Z",
                    "to": "2019-08-24T14:15:22Z"
                  }
                ],
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                }
              }
            ],
            "commercial_profiles": [
              {
                "id": 4,
                "name": "perfil_comercial.postpago_ventas_pos",
                "visibility_type": "POSITIVE",
                "from": "2022-10-03T22:00:00Z",
                "to": "2080-10-03T22:00:00Z"
              }
            ]
          }
        ]
      }
    ],
    "promotions": [
      {
        "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,
        "unlimited_duration": false,
        "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",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "binding_type_id": 1
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "commercial_profiles": [
          {
            "id": 4,
            "name": "perfil_comercial.postpago_ventas_pos",
            "visibility_type": "POSITIVE",
            "from": "2022-10-03T22:00:00Z",
            "to": "2080-10-03T22:00:00Z"
          }
        ]
      }
    ],
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "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
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

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
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

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
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

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types?subs_type_name='POST-PAGO' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
[
  {
    "id": "731",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "min_quantity": 1,
    "max_quantity": 1,
    "is_mandatory": true,
    "used_for_automatic_orphan_subscription_change": false,
    "subs_type": {
      "name": "POST-PAGO",
      "description": "ADSL",
      "id": "5"
    }
  }
]
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

1
"Origin authentication failed."
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

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
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

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/can-switch?technology_name='FIBRA'&territory_owner_id='FIBMM02'&category='Fixed+Broadband+Mobile'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&include_optional_bundled_commercial_products='true'&used_for_automatic_changes='true'&subs_removed='3476' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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

  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
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
[
  {
    "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",
    "category": "string",
    "category_id": "2",
    "bundled_type": "2P",
    "download_speed": "300",
    "upload_speed": "300",
    "bundled_product_subs_types": [
      {
        "id": "731",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "min_quantity": 1,
        "max_quantity": 1,
        "is_mandatory": true,
        "used_for_automatic_orphan_subscription_change": false,
        "subs_type": {
          "name": "POST-PAGO",
          "description": "ADSL",
          "id": "5"
        },
        "bundled_commercial_products": [
          {
            "id": "4028",
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "is_mandatory": true,
            "is_main_line": true,
            "is_extra": false,
            "is_additional": false,
            "is_bundled": true,
            "duo_type": "NOT_DUO",
            "max_quantity": 1,
            "invoice_name": "TARIFA MAS 10GB",
            "commercial_product": {
              "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,
              "free_units_packages": [
                {
                  "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,
                  "event_type": "DATA",
                  "unlimited": false,
                  "max_grants": 0,
                  "is_recurring_package": true,
                  "applicability_priority": 1,
                  "used_for_policy_rule_change": false,
                  "category": "ONNET",
                  "sharing_compatible": true,
                  "free_units_package_template": {
                    "id": "BONUS_DATA_NATIONAL_RLAH",
                    "event_type": "DATA",
                    "applicability_rule": "ByEventTypeOriginDestination"
                  },
                  "fees": [
                    {}
                  ],
                  "promotions": [
                    {}
                  ],
                  "base_profiles": [
                    {}
                  ],
                  "commercial_profiles": [
                    {}
                  ],
                  "from": "2019-08-24T14:15:22Z",
                  "to": "2019-08-24T14:15:22Z",
                  "is_mandatory": true,
                  "is_mandatory_optional": false,
                  "is_mandatory_for_sale": true
                }
              ],
              "promotions": [
                {
                  "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,
                  "unlimited_duration": false,
                  "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",
                  "terms": [
                    {}
                  ],
                  "transaction_type": {
                    "id": "121",
                    "name": "DEVOLUCION AT. AL CLIENTE",
                    "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                    "is_active": true,
                    "is_external": false,
                    "tax_rate": "generic",
                    "transaction_type": "Credit",
                    "refund_transaction_type_id": "121"
                  },
                  "commercial_profiles": [
                    {}
                  ]
                }
              ],
              "commercial_profiles": [
                {
                  "id": 4,
                  "name": "perfil_comercial.postpago_ventas_pos",
                  "visibility_type": "POSITIVE",
                  "from": "2022-10-03T22:00:00Z",
                  "to": "2080-10-03T22:00:00Z"
                }
              ],
              "fees": [
                {
                  "id": "1",
                  "description": "TARIFA MAS 10GB cuotamensual",
                  "type": "RecurringCharge",
                  "subtype": "ServiceFee",
                  "recurrence_scheme": "BoundToBillCycle",
                  "recurrence_interval_type": "Monthly",
                  "recurrence_interval": 30,
                  "paid_in_advance": false,
                  "prorated_on_activation": true,
                  "prorated_on_deactivation": true,
                  "is_external": false,
                  "from": "2019-08-24T14:15:22Z",
                  "to": "2019-08-24T14:15:22Z",
                  "value": 8.264463,
                  "currency": "euro",
                  "terms": [
                    {}
                  ],
                  "transaction_type": {
                    "id": "121",
                    "name": "DEVOLUCION AT. AL CLIENTE",
                    "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                    "is_active": true,
                    "is_external": false,
                    "tax_rate": "generic",
                    "transaction_type": "Credit",
                    "refund_transaction_type_id": "121"
                  }
                }
              ]
            },
            "fees": [
              {
                "id": "1",
                "description": "TARIFA MAS 10GB cuotamensual",
                "type": "RecurringCharge",
                "subtype": "ServiceFee",
                "recurrence_scheme": "BoundToBillCycle",
                "recurrence_interval_type": "Monthly",
                "recurrence_interval": 30,
                "paid_in_advance": false,
                "prorated_on_activation": true,
                "prorated_on_deactivation": true,
                "is_external": false,
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z",
                "value": 8.264463,
                "currency": "euro",
                "terms": [
                  {
                    "id": "5138_promotion",
                    "name": "12 MESES-36E",
                    "type": "PermanenceContract",
                    "commitment_duration": 12,
                    "unlimited_duration": false,
                    "penalty_prorated": true,
                    "value": 8.264463,
                    "currency": "euro",
                    "permanence_type": "MAIN",
                    "transaction_type": {},
                    "from": "2019-08-24T14:15:22Z",
                    "to": "2019-08-24T14:15:22Z"
                  }
                ],
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                }
              }
            ],
            "commercial_profiles": [
              {
                "id": 4,
                "name": "perfil_comercial.postpago_ventas_pos",
                "visibility_type": "POSITIVE",
                "from": "2022-10-03T22:00:00Z",
                "to": "2080-10-03T22:00:00Z"
              }
            ]
          }
        ]
      }
    ],
    "promotions": [
      {
        "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,
        "unlimited_duration": false,
        "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",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "binding_type_id": 1
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "commercial_profiles": [
          {
            "id": 4,
            "name": "perfil_comercial.postpago_ventas_pos",
            "visibility_type": "POSITIVE",
            "from": "2022-10-03T22:00:00Z",
            "to": "2080-10-03T22:00:00Z"
          }
        ]
      }
    ],
    "is_downsell": false,
    "used_for_automatic_changes": false,
    "involve_speed_change": true,
    "subs_removed": "5678",
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "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
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

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
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

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
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

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/can-switch/3001?territory_owner_id='FIBMM02'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&include_optional_bundled_commercial_products='true'&used_for_automatic_changes='true' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

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