API Overview Resources Schemas

Free Units Packages

Access to free units packages

Get free units packages

Returns an array of both mandatory and optional free units packages related to a commercial product id. Includes main characteristics of each free units package, as well as fees and promotions associated to the free units package. Note that the free units packages compatible with a product are always related to the commercial product and are available for both bundled product and standalone product sales scenarios.

GET /orgs/{org_id}/commercial_products/{id}/free_units_packages

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name
commercial_profile_name	query	string	false	commercial profile name
debit_account_id	query	string	false	id to filter free_units_packages with a specific debit_account

Enumerated Values

Property	Values
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/commercial_products/2311/free_units_packages?sale_type_name='Venta'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&debit_account_id='1000' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Free Units Package	[FreeUnitsPackage_Response]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of FreeUnitsPackage_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


[
  {
    "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,
            "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",
              "refound_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",
          "refound_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,
        "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,
            "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",
              "refound_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",
          "refound_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
  }
]

Name	Type	Required	Description
anonymous	FreeUnitsPackageDetailBySP	false	none

Name	Type	Required	Description
anonymous	object	false	none
» from	string(date-time)	false	date when the free units package starts to be included within the commercial product
» to	string(date-time)	false	date when the free units package is no longer included within the commercial product
» is_mandatory	boolean	false	indicates if the free units package is mandatory with the commercial product
» is_mandatory_optional	boolean	false	indicates if the free units package is one of those that require at least one package to be selected with the commercial product
» is_mandatory_for_sale	boolean	false	indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change)

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	FreeUnitsPackageDetailBySP	false	none

Name	Type	Required	Description
anonymous	object	false	none
» from	string(date-time)	false	date when the free units package starts to be included within the commercial product
» to	string(date-time)	false	date when the free units package is no longer included within the commercial product
» is_mandatory	boolean	false	indicates if the free units package is mandatory with the commercial product
» is_mandatory_optional	boolean	false	indicates if the free units package is one of those that require at least one package to be selected with the commercial product
» is_mandatory_for_sale	boolean	false	indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change)

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

Get free units package

Returns free units package info by id related to a commercial product id.

GET /orgs/{org_id}/commercial_products/{id}/free_units_packages/{fup_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier
fup_id	path	string	true	free units package identifier
commercial_profile_name	query	string	false	commercial profile name

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/free_units_packages/145?commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Free Units Package	FreeUnitsPackage_Response
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

Get free units package by id

Returns free units package info by id related to a service provider id.

GET /orgs/{org_id}/free_units_packages/{fup_id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
fup_id	path	string	true	free units package identifier

Request example

1
2
3
4
5



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

Responses

Code	Meaning	Description	Schema
200	OK	Free Units Package	FreeUnitsPackageDetailBySP
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

Get free units package by service provider

Returns free units package info by service provider

GET /orgs/{org_id}/free_units_packages

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
commercial_profile_name	query	string	false	commercial profile name

Request example

1
2
3
4
5



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

Responses

Code	Meaning	Description	Schema
200	OK	Free Units Package	[FreeUnitsPackageDetailBySP]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of FreeUnitsPackageDetailBySP

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


[
  {
    "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,
            "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",
              "refound_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",
          "refound_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,
        "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,
            "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",
              "refound_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",
          "refound_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"
      }
    ]
  }
]

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

Get sellable free units packages

Returns an array of sellable mandatory and optional free units packages for a commercial product id. Includes details for each free units package about associated fees and promotions applicable to the free units package. Note that the free units packages compatible with a product are always related to the commercial product and are available for both bundled product and standalone product sales scenarios.

GET /orgs/{org_id}/commercial_products/{id}/free_units_packages/sellable

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name
commercial_profile_name	query	string	false	commercial profile name
debit_account_id	query	string	false	id to filter free_units_packages with a specific debit_account

Enumerated Values

Property	Values
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/commercial_products/2311/free_units_packages/sellable?sale_type_name='Venta'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&debit_account_id='1000' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Free units packages	[FreeUnitsPackage_Response]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of FreeUnitsPackage_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


[
  {
    "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,
            "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",
              "refound_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",
          "refound_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,
        "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,
            "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",
              "refound_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",
          "refound_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
  }
]

Name	Type	Required	Description
anonymous	FreeUnitsPackageDetailBySP	false	none

Name	Type	Required	Description
anonymous	object	false	none
» from	string(date-time)	false	date when the free units package starts to be included within the commercial product
» to	string(date-time)	false	date when the free units package is no longer included within the commercial product
» is_mandatory	boolean	false	indicates if the free units package is mandatory with the commercial product
» is_mandatory_optional	boolean	false	indicates if the free units package is one of those that require at least one package to be selected with the commercial product
» is_mandatory_for_sale	boolean	false	indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change)

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	FreeUnitsPackageDetailBySP	false	none

Name	Type	Required	Description
anonymous	object	false	none
» from	string(date-time)	false	date when the free units package starts to be included within the commercial product
» to	string(date-time)	false	date when the free units package is no longer included within the commercial product
» is_mandatory	boolean	false	indicates if the free units package is mandatory with the commercial product
» is_mandatory_optional	boolean	false	indicates if the free units package is one of those that require at least one package to be selected with the commercial product
» is_mandatory_for_sale	boolean	false	indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change)

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


{
  "error": "Item not found",
  "message": "Item not found",
  "code": "0200XX"
}

Name	Type	Required	Description
error	string	false	none
message	string	false	none
code	string	false	none

Endpoints

Commercial Products

Bundled Products

Bundled Commercial Products

Free Units Packages

Promotions

Commercial Devices

Rate Plans

Base profiles and services

Value Added Services

Provisioning Profiles

Services

Commercial Infos

Transaction types

Devices

Commercial profiles

Misc services