Bundled Commercial Products

Access to bundled commercial products


Parameters

Name In Type Required Description
org_id path string true organization name
id path string true bundled product identifier
subs_type_id path string true bundled product subscription type identifier
numeration_type_name query NumerationTypeName false numeration type name
sale_type_name query SaleTypeName false sale type name
commercial_profile_name query string false commercial profile name
insured_amount query number(double) false in case subs_type_id belongs to DEVICEINSURANCE this query param will be used to search by the insurance policy available for this particular amount

Enumerated Values

Property Values
numeration_type_name one of [Nuevo numero, Numero portado, Numero entre marcas]
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/609/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/sellable?numeration_type_name='Nuevonumero'&sale_type_name='Venta'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&insured_amount='350' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Bundled Commercial products [BundledCommercialProduct]
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of BundledCommercialProduct

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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
[
  {
    "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": [
            {
              "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"
              }
            }
          ],
          "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"
                }
              ]
            }
          ],
          "base_profiles": [
            {
              "id": "4442",
              "name": "INTERNET 10GB_TPILI YOIGO",
              "in_catalogue_since": "2019-08-24T14:15:22Z",
              "in_catalogue_until": "2019-08-24T14:15:22Z",
              "network_id": "2",
              "network_provisioning_id": "INTERNET_TPILI_10GB",
              "offer_id": "344000010",
              "charging_id": "344010",
              "expire_with_tariff": true
            }
          ],
          "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"
            }
          ],
          "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": [
            {
              "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"
        }
      ],
      "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"
          }
        }
      ]
    },
    "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"
        }
      }
    ],
    "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
anonymous BundledCommercialProductBasic false none
Name Type Required Description
anonymous object false none
» commercial_product CommercialProduct_Response false none
» fees [Fee_Response] false none
» commercial_profiles [CommercialProfile_Response] false none

401 - JsonObject

Custom schema example

1
"Origin authentication failed."
Name Type Required Description
anonymous BundledCommercialProductBasic false none
Name Type Required Description
anonymous object false none
» commercial_product CommercialProduct_Response false none
» fees [Fee_Response] false none
» 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_id path string true bundled product subscription type identifier
numeration_type_name query NumerationTypeName false numeration type name
sale_type_name query SaleTypeName false sale type name
commercial_profile_name query string false commercial profile name
insured_amount query number(double) false in case subs_type_id belongs to DEVICEINSURANCE this query param will be used to search by the insurance policy available for this particular amount

Enumerated Values

Property Values
numeration_type_name one of [Nuevo numero, Numero portado, Numero entre marcas]
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/609/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products?numeration_type_name='Nuevonumero'&sale_type_name='Venta'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&insured_amount='350' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Bundled Commercial products [BundledCommercialProductBasic]
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of BundledCommercialProductBasic

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
[
  {
    "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"
  }
]
Name Type Required Description
id string false none
from string(date-time) false none
to string(date-time) false none
is_mandatory boolean false indicates if the bundled commercial product is mandatory within the bundled product subscription type
is_main_line boolean false indicates if the bundled commercial product must be handled as main line within the bundled product
is_extra boolean false indicates if the bundled commercial product must be handed as an extra line within the bundled product
is_additional boolean false indicates if the bundled commercial product must be handed as an additional line within the bundled product
is_bundled boolean false indicates if the bundled commercial product must be ‘bundled’ in invoice, contract and pre-contractual info.
duo_type DuoType_Response false none
max_quantity number(int32) false max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type
invoice_name string 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
is_mandatory boolean false indicates if the bundled commercial product is mandatory within the bundled product subscription type
is_main_line boolean false indicates if the bundled commercial product must be handled as main line within the bundled product
is_extra boolean false indicates if the bundled commercial product must be handed as an extra line within the bundled product
is_additional boolean false indicates if the bundled commercial product must be handed as an additional line within the bundled product
is_bundled boolean false indicates if the bundled commercial product must be ‘bundled’ in invoice, contract and pre-contractual info.
duo_type DuoType_Response false none
max_quantity number(int32) false max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type
invoice_name 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
id path string true bundled product identifier
subs_type_id path string true bundled product subscription type identifier
bcp_id path string true bundled commercial product identifier

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_id}/bundled_commercial_products/3009_BUNDLED_3P \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Bundled Commercial product BundledCommercialProduct
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

Parameters

Name In Type Required Description
org_id path string true organization name
bundled_product_id path string true bundled product identifier
id path string true bundled commercial product identifier
used_for_automatic_orphan_subscription_change query boolean false boolean to indicate if the bundled commercial product change is available for manual or automatic changes. false by default. Sale channels and customer apps must use always false.
commercial_profile_name query string false commercial profile name
destination_bundled_product_id query string false destination bundled product identifier

Request example

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_commercial_products/3009_BUNDLED_3P/can-switch?used_for_automatic_orphan_subscription_change='true'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&destination_bundled_product_id='609' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Bundled Commercial products [BundledCommercialProductCanSwitch]
401 Unauthorized Unauthorized string
404 Not Found Item not found KOGenericResponse

200 - instance of BundledCommercialProductCanSwitch

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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
[
  {
    "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": [
            {
              "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"
              }
            }
          ],
          "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"
                }
              ]
            }
          ],
          "base_profiles": [
            {
              "id": "4442",
              "name": "INTERNET 10GB_TPILI YOIGO",
              "in_catalogue_since": "2019-08-24T14:15:22Z",
              "in_catalogue_until": "2019-08-24T14:15:22Z",
              "network_id": "2",
              "network_provisioning_id": "INTERNET_TPILI_10GB",
              "offer_id": "344000010",
              "charging_id": "344010",
              "expire_with_tariff": true
            }
          ],
          "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"
            }
          ],
          "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": [
            {
              "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"
        }
      ],
      "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"
          }
        }
      ]
    },
    "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"
        }
      }
    ],
    "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"
      }
    ],
    "used_for_automatic_orphan_subscription_change": false
  }
]
Name Type Required Description
anonymous BundledCommercialProduct false none
Name Type Required Description
anonymous object false none
» used_for_automatic_orphan_subscription_change boolean false boolean to indicate if the bundled commercial product change is available for manual or automatic changes.

401 - JsonObject

Custom schema example

1
"Origin authentication failed."
Name Type Required Description
anonymous BundledCommercialProduct false none
Name Type Required Description
anonymous object false none
» used_for_automatic_orphan_subscription_change boolean false boolean to indicate if the bundled commercial product change is available for manual or automatic changes.

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 destination bundled product id
origin_bundled_commercial_product query string false bundled commercial product for which it is necessary an equivalence in the commercial definition of a particular bundled product

Request example

1
2
3
4
5

curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_commercial_products/can-migrate?origin_bundled_commercial_product='3009_BUNDLED_3P' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of getBCPbyBPCanMigrate

Custom schema example

1
2
3
4
5
6
[
  {
    "origin_bundled_commercial_product": "3456_BUNDLED_3P",
    "destination_bundled_commercial_product": "3489_BUNDLED_3P"
  }
]
Name Type Required Description
origin_bundled_commercial_product string false none
destination_bundled_commercial_product string false none

400 - JsonObject

Custom schema example

1
2
3
4
5
{
  "error": "Bad Request",
  "message": "Bad request",
  "code": "020015"
}
Name Type Required Description
origin_bundled_commercial_product string false none
destination_bundled_commercial_product string false none

401 - JsonObject

Custom schema example

1
"Origin authentication failed."
Name Type Required Description
origin_bundled_commercial_product string false none
destination_bundled_commercial_product 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

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