Imported data
Bearer Bearer Token (JWT) | Resource | Description |
|---|---|
| Commercial Products | Access to commercial products |
| Bundled Products | Access to bundled products |
| Bundled Commercial Products | Access to bundled commercial products |
| Free Units Packages | Access to free units packages |
| Promotions | Access to promotions |
| Commercial Devices | Access to commercial devices |
| Rate Plans | Access to rate plans |
| Base profiles and services | Access to base profiles and services associated |
| Value Added Services | Access to value added services |
| Services | Access to services |
| Commercial Infos | Access to commercial infos |
| Transaction types | Access to billing transaction type endpoints |
| Devices | Access to devices endpoints |
| Commercial profiles | Access to commercial profile endpoints |
| Misc services | Access to different endpoints to get configuration definition |
| Health |
Bearer Bearer Token (JWT) | Resource | Description |
|---|---|
| Commercial Products | Access to commercial products |
| Bundled Products | Access to bundled products |
| Bundled Commercial Products | Access to bundled commercial products |
| Free Units Packages | Access to free units packages |
| Promotions | Access to promotions |
| Commercial Devices | Access to commercial devices |
| Rate Plans | Access to rate plans |
| Base profiles and services | Access to base profiles and services associated |
| Value Added Services | Access to value added services |
| Services | Access to services |
| Commercial Infos | Access to commercial infos |
| Transaction types | Access to billing transaction type endpoints |
| Devices | Access to devices endpoints |
| Commercial profiles | Access to commercial profile endpoints |
| Misc services | Access to different endpoints to get configuration definition |
| Health |
GET /orgs/{org_id}/bundled_products/{bundled_product_id}/bundled_commercial_products/{bcp_id}/commercial_devices/sellable
numeration_type_name from bundled commercial products endpoints
/orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/sellable/orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/orgs/{org_id}/bundled_products/{id}/bundled_commercial_productsAGILETV to SubsTypeName and SubsTypeName_Response schemascharger_included and charger_label to Device_Response schema
charger_included (boolean): indicates whether a charger is included in the device boxcharger_label (string): descriptive label of the charger type/standard (e.g. USB-C 25W)/orgs/{org_id}/devices, /orgs/{org_id}/devices/sellable, /orgs/{org_id}/devices/{device_id}RECURRING_PAYMENT to PaymentType and PaymentType_Response schemasmin_main_line and max_main_line to min_main_lines and max_main_lines in schema BundledProductSubsTypeBasicreverse_logistic_method to Device_Response schema
POST_OFFICE (customer brings device to a post office), HOME_PICKUP (courier picks up at home)/orgs/{org_id}/devices, /orgs/{org_id}/devices/sellable, /orgs/{org_id}/devices/{device_id}min_devices to schema CommercialProductSimplemin_main_line and max_main_line to schema BundledProductSubsTypeBasicSIM to DeviceCategory and Device_Response schemaRetailPrice to FeeInstallmentPlan_refinance_Response schematype_group attribute to PromotionDetail_Response schema
type_name (BUNDLE for "PAQUETE SUBS" types, OTHER for all else)promotion_type_group in PromotionIncompatibilitycategory_name and type_name from getPromoByComProfile_Response to PromotionDetail_Response
PromotionDetail_Response previously inherited these fields via allOfdigital_channels_name from CommercialDevice schemaCommercialDevice_device_Response schema:
in_catalogue_since renamed to fromin_catalogue_until renamed to toFee_Response schema:
RepairExcessFee - Franquicia de reparaciónReplacementExcessFee - Franquicia de reemplazopromotion_type_group to the promotion incompatibility schemas.
BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL)OTHER: Any other promotion typeinsurance_type to the CommercialProduct schemas.
GLOBAL, MULTIMEDIA, null (only if the CommercialProduct is not a Zurich insurance tariff).device_category_web to the following endpoint:
/orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/sellabledevice_category_web to the following endpoints:
/orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/orgs/{org_id}/bundled_products/{id}/bundled_commercial_productsapplicable_at to commercial_product and bundled_commercial_product incompatibilities endpointscategory_group to /devices/sellable and /devices endpointscategory_group to DeviceResponsepromotional_renew for the following endpoints:
/orgs/{org_id}/commercial_devices/orgs/{org_id}/commercial_devices/sellable/orgs/{org_id}/value_added_services/{id}/commercial_infos to get commercial infos for value added servicesean_code to DeviceResponseesim_only to DeviceResponseenergy_label to DeviceResponsecategory_web to /devices/sellable and /devices endpoints/orgs/{org_id}/bundled_commercial_products/{bcp_id}/commercial_devices/{cd_id}dest_bundled_product_id name to destination_bundled_product_id/orgs/{org_id}/devices not rendering in developer portal401 response /orgs/{org_id}/devices/{device_id}/orgs/{org_id}/bundled_products/{id}/provisioning_profiles endpointupload_speed and download_speed fields to TerritoryOwnerDetail schemaupload_speed and download_speed fields in BundledProductBasic_Response schemaupload_speed and download_speed fields in getBaseProfiles_Response schematarget_applicability_rule to endpoint /orgs/{org_id}/promotions/sellabledestBundledProductId to endpoint:
/orgs/{org_id}/bundled_products/{bundled_product_id}/bundled_commercial_products/{id}/can-switchrefound_transaction_type_id to refund_transaction_type_id in TransactionType schemaSubsTypeName, remove DISNEY+SubsTypeName for DISNEY and DISNEY+unlimited_duration to Terms_alone_Response schemaunlimited_duration to PromotionDetail_Response schemapermanence_type to endpoints:
/orgs/{org_id}/commercial_devices/orgs/{org_id}/commercial_devices/sellable/orgs/{org_id}/bundled_commercial_products/{id}/commercial_devices/sellablerefound_transaction_type_id to TransactionType schema/orgs/{org_id}/commercial_products/{commercial_product_id}/promotions/{promotion_id}/incompatibilities/orgs/{org_id}/bundled_commercial_products/{bcp_id}/promotions/{promotion_id}/incompatibilitiespromotional_info to Device_Response schemaExcessFee to Fee_Response schemaBundleCategory and SubsTypeName for ORANGE_TV_LIBREmandatory to endpoints:
/orgs/{org_id}/bundled_commercial_products/{id}/commercial_devices/sellable/orgs/{org_id}/commercial_devicesstore_delivery_allowed field in CommercialProfile schemaValueAddedServiceDetail and ValueAddedService schemas by adding max_quantity field and deprecating max_cardinalityTV subscription typeCommercialProduct schema:
max_devicesmax_concurrent_viewspermanence_type to Terms_alone_Responsevolume_home_sl0volume_home_sl1volume_rlah_sl0volume_rlah_sl1volume_nr_sl0volume_nr_sl1NOT_APPLICABLE to target_applicability_rule and applicability_model extensible enumsmysim_service_id to endpoints:
/orgs/{org_id}/commercial_products/{id}/value_added_services/orgs/{org_id}/bundled_commercial_products/{id}/value_added_servicesbinding_type_id to TermsPromotion_ResponseBundledProduct and FreeUnitsPackage schemastype[in] and category[in] query params in GET /commercial_profiles/{commercial_profile_id}/free_units_packages endpointGET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/free_units_packagesFeeGeneration and add FeeSubtype from target_applicability_rule enum in getPromoByComProfile_Response schemaFEE_GENERATION and add FEE_SUBTYPE from target_applicability_rule enum in Promotion schemaprovisioning_id as external_provisioning_id in CommercialProduct schema/orgs/{org_id}/designer/promotion_categories/orgs/{org_id}/designer/promotion_category/{promotion_category_id}rate_plan and billing_type fields in CommercialProduct schemaprovisioning_id, service_class, external_offer_id, external_charging_id and manual_renewal fields in CommercialProduct schemaGET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/commercial_products endpointpromotion_category_name[in] and promotion_type_name[in] query filters in GET
/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/promotions endpointtype[in] query filter in GET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/bundled_products endpointis_ on params of transaction_type schemaGET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/bundled_productsBundledProductType, CustomerSegment, BillingType, Technology and SubscriptionType enumsrefound_transaction_type_id from fields required in transaction_types createiso_language from Promotion and CommercialProduct schemas/orgs/{org_id}/designer/transaction_types/orgs/{org_id}/designer/transaction_types/{transaction_type_id}promotion_type_id and promotion_category_id query params in GET
/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/promotions endpoint/bundled_products/{bp_id}/bundled_commercial_productsPOST and PATCH endpoint:
/orgs/{org_id}/designer/commercial_profiles/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id}/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/commercial_products/{commercial_product_id}/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/free_units_packages/{free_units_package_id}/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/bundled_products/{bundled_product_id}/orgs/{org_id}/designer/free_units_package/orgs/{org_id}/designer/free_units_package/{free_units_package_id}rate_plan_id field in CommercialProduct schema as rate_planbilling_type_id field in CommercialProduct schema as billing_type/designer/orgs/{org_id}/bundled_products/designer/orgs/{org_id}/bundled_products/{bundled_product_id}/orgs/{org_id}/promotions/{existent_promotion_id}/can-switch/{new_promotion_id}MAXid[contains] query param to device_id[contains] for the /commercial_devices endpointcustomer_type to Promotion schemacustomer_type query param in GET /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions endpoint/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id} endpoint/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id} endpoint/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/commercial_products/{commercial_product_id}
endpoint/designer/orgs/{org_id}/sale_types/{sale_type_id} endpoint/designer/orgs/{org_id}/promotion_types/{promotion_type_id} endpoint/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/commercial_products/designer/orgs/{org_id}/commercial_products/{commercial_product_id}/commercial_profiles/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/commercial_products/{commercial_product_id}PromotionRelatedRaw and PromotionRelatedRawList schemas as PromotionRelatedWithDatesRaw and PromotionRelatedWithDatesRawList
respectivelyPromotionSoldByCommercialProfileRawList and PromotionSoldByCommercialProfileRaw schemasduration field in Promotion schema as integerterm_id fields in Promotion schema as commitment_id and set as nullableexternal_market_id field from Promotion schema and added as field in PromotionRaw schema/orgs/{org_id}/commercial_devices/designer/orgs/{org_id}/sale_types/designer/orgs/{org_id}/sale_types/{sale_type_id}/designer/orgs/{org_id}/promotion_types/designer/orgs/{org_id}/promotion_types/{promotion_type_id}/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions201 status code in response of endpoint:
/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id}category_name to promotions response for endpoint:
/orgs/{org_id}/promotion/{id}/orgs/{org_id}/commercial_devices/designer/orgs/{org_id}/promotions/{promotion_id}/commercial_profiles/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id}penalty_reference field in the response of CommercialProduct/commercial_profiles enpoint:
namestart_date[gt]start_date[gte]start_date[lt]start_date[lte]end_date[gt]end_date[gte]end_date[lt]end_date[lte]CommercialProfileRawList schema in GET /commercial_profiles endpoint.language_code to header parameterreduce_penalty_threshold field in the response of Promotionsconsolidated and updated_at fields in the response body of commercial profile by id.skip_first_period field in the response body of Promotionsstart_date and end_date fields in the response body of commercial profile getters.start_date and end_date fields in the request body of commercial profile operations./orgs/{org_id}/bundled_products/{id}/orgs/{org_id}/bundled_products/orgs/{org_id}/bundled_products/sellable/orgs/{org_id}/bundled_products/{id}/can-switch/orgs/{org_id}/bundled_products/{id}/can-switch/{target_id}AMAZONPRIME.mysim_id in ValueAddedService schemas./designer/orgs/{org_id}/upload_file endpoint./designer/orgs/{org_id}/download/{file_name} to return a ResponseBody/designer/orgs/{org_id}/commercial_profiles/designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/designer/orgs/{org_id}/upload_file content from csv to multipart/form-dataofc-manager API (it must be used through designer)/designer/orgs/{org_id}/download/{fileName}debit_account_id for the following endpoints:
/orgs/{org_id}/commercial_products/{id}/free_units_packages/orgs/{org_id}/commercial_products/{id}/free_units_packages/sellable/designer/orgs/{org_id}/upload_file/orgs/{org_id}/bundled_products/{id}/orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/orgs/{org_id}/commercial_devices/sellablepermanence for the endpoints:
/orgs/{org_id}/commercial_devices/sellable/orgs/{org_id}/commercial_products/{id}/commercial_devices/sellable/orgs/{org_id}/bundled_commercial_products/{id}/commercial_devices/sellable/orgs/{org_id}/value_added_services/{id}/commercial_devices/sellable/orgs/{org_id}/commercial_devices/sellablemandatory_commercial_devices/orgs/{org_id}/commercial_devices/refinance/orgs/{org_id}/devices/orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products
numeration_type_namesale_type_namecommercial_profile_nameinsured_amount/orgs/{org_id}/commercial_products/{id}/free_units_packages
sale_type_name/orgs/{org_id}/commercial_products/{id}/promotions
customer_type_namesale_type_namenumeration_type_name/orgs/{org_id}/bundled_commercial_products/{id}/promotions
customer_type_namesale_type_namenumeration_type_nameAPPLEWATCHpromotional_renew for endpoint /orgs/{org_id}/commercial_devices/sellable/orgs/{org_id}/commercial_devices/refinance descriptions/orgs/{org_id}/commercial_devices/refinance to cover commercial device refinancing functionality/manager/orgs/{org_id}/validationand /manager/orgs/{org_id}/execution/{load_id}/orgs/{org_id}/bundled_products/{bundled_product_id}/bundled_commercial_products/{id}/can-switch
used_for_automatic_orphan_subscription_changeBundledCommercialProductCanSwitchBundledCommercialProduct, BundledCommercialProductDetail and BundledCommercialProductBasic schema by adding invoice_name missing
attributeexternal_id in BundledProductBasic_Response schemaLoadSegment schemain_catalogue_since and in_catalogue_until from CommercialDevice_device_ResponseDevice_Response for extended device characteristicsis_external attribute in CommercialDevice_fees_Response y FeeInstallmentPlan_Responsein_catalogue_since and in_catalogue_until from CommercialDevice_device_Responsefrom and to in CommercialDevicesTerms_Response schema updating terms responseevent_type in FreeUnitsPackage_Response schemaused_for_automatic_changes
subs_removed )subs_removed in schema SwitchBundledProduct_Responsepayment_type in commercial_devices endpoints response, CommercialDevice and CommercialDeviceAlone schemasgeneric_code :
sale_type_name query param in:
{MAJOR}.{MINOR}.{PATCH}
{MAJOR} implies uncompatible changes with the previous {MAJOR} version and also set {MINOR} to 0{MINOR} implies new functionalities or information compatible with previous version and set {PATCH} to 0{PATCH} implies bug fixes compatible with previous versionReturns basic commercial product info for a commercial product id, including marketing name, billing type and fees applicable to the commercial product when this is sold as a standalone product.
PATH PARAMETERS
organization name
commercial product identifier
OK 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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"billing_type": "modalidad postpago",
"subs_type": {
"name": "POST-PAGO",
"description": "ADSL",
"id": "5"
},
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
],
"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"
}
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_commercial_product_id | string | internal id used within MySim | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sharing_compatible | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalty_reference | number (double) | it is the reference price of the fee to take in account when a penalty is applied to the terminal | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
min_devices | integer | Minimum number of devices that must be purchased for this tariff. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | integer | Maximum number of devices that can be purchased for this tariff. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_concurrent_views | integer | Maximum number of concurrent views allowed for the TV tariff. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurance_type | string | Type of insurance product. Possible values: - GLOBAL - MULTIMEDIA - null: When CommercialProduct is not a Zurich insurance tariff | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
billing_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subs_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of standalone commercial products based on input criteria. Includes details for each commercial product about the marketing name, fees, mandatory free units packages included within the product and mandatory promotions applicable for the product.
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
customer segment name
commercial segment name (SME (SmallMediumEnterprise) or Consumer)
customer type name
subscription type name
billing type name
numeration type name
sale type name
OK Commercial products
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": null,
"event_type": null,
"applicability_rule": null
},
"fees": [
null
],
"promotions": [
null
],
"base_profiles": [
null
],
"commercial_profiles": [
null
],
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"subs_type": {
"name": "POST-PAGO",
"description": "ADSL",
"id": "5"
}
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_commercial_product_id | string | internal id used within MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalty_reference | number (double) | it is the reference price of the fee to take in account when a penalty is applied to the terminal | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
min_devices | integer | Minimum number of devices that must be purchased for this tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | integer | Maximum number of devices that can be purchased for this tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_concurrent_views | integer | Maximum number of concurrent views allowed for the TV tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurance_type | string | Type of insurance product. Possible values: - GLOBAL - MULTIMEDIA - null: When CommercialProduct is not a Zurich insurance tariff | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subs_type | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products?commercial_profile_name=perfil_comercial.postpago_ventas_pos&customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable standalone commercial products based on input criteria. Includes details for each commercial product about the marketing name, fees, mandatory free units packages included within the product and mandatory promotions applicable for the product.
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
customer segment name
commercial segment name (SME (SmallMediumEnterprise) or Consumer)
customer type name
subscription type name
billing type name
numeration type name
sale type name
OK Commercial products
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": null,
"event_type": null,
"applicability_rule": null
},
"fees": [
null
],
"promotions": [
null
],
"base_profiles": [
null
],
"commercial_profiles": [
null
],
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"subs_type": {
"name": "POST-PAGO",
"description": "ADSL",
"id": "5"
}
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_commercial_product_id | string | internal id used within MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalty_reference | number (double) | it is the reference price of the fee to take in account when a penalty is applied to the terminal | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
min_devices | integer | Minimum number of devices that must be purchased for this tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | integer | Maximum number of devices that can be purchased for this tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_concurrent_views | integer | Maximum number of concurrent views allowed for the TV tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurance_type | string | Type of insurance product. Possible values: - GLOBAL - MULTIMEDIA - null: When CommercialProduct is not a Zurich insurance tariff | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subs_type | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/sellable?commercial_profile_name=perfil_comercial.postpago_ventas_pos&customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of eligible commercial products to which a given commercial product id can be changed. Aimed to be used for retrieving allowed commercial product changes for a standalone subscription (which may be a standalone subscription from the beginning of the subscription life cycle or a subcription that has become orphan after a package partial deactivation). Includes details for each commercial product about the marketing name, fees, mandatory free units packages included within the product and mandatory promotions applicable for the product.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
commercial profile name
OK Commercial products
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": null,
"event_type": null,
"applicability_rule": null
},
"fees": [
null
],
"promotions": [
null
],
"base_profiles": [
null
],
"commercial_profiles": [
null
],
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"used_for_automatic_orphan_subscription_change": false
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_commercial_product_id | string | internal id used within MySim | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
data_sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
penalty_reference | number (double) | it is the reference price of the fee to take in account when a penalty is applied to the terminal | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
min_devices | integer | Minimum number of devices that must be purchased for this tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_devices | integer | Maximum number of devices that can be purchased for this tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_concurrent_views | integer | Maximum number of concurrent views allowed for the TV tariff. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insurance_type | string | Type of insurance product. Possible values: - GLOBAL - MULTIMEDIA - null: When CommercialProduct is not a Zurich insurance tariff | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_packages | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_automatic_orphan_subscription_change | boolean | indicates if the change is supposed to be used for automatic commercial product changes triggered when a subscription within a package becomes orphan (i.e after partial deactivation of fixed and broadband within a 3P package, the mobile subscription becomes orphan) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/can-switch?commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns basic bundled product info for a bundled product id, including marketing name, technology, territory owners and associated bundled product subscription types. For each bundled product subscription type, the related bundled commercial products are returned including the fees that are applicable for each bundled commercial product (which may be different than the fees applicable for the correspondent commercial product when it is sold as a standalone product).
PATH PARAMETERS
organization name
bundled product identifier
OK Bundled product
{
"id": "182",
"name": "Fibra 300 + Plan 3GB con ilimitadas",
"marketing_name": "Fibra 300 + Plan 3GB con ilimitadas",
"external_id": "2cb2ed65-76e6-4962-9a7e-927fbffcbcf7",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"category": "string",
"category_id": "2",
"bundled_type": "2P",
"download_speed": "300",
"upload_speed": "300",
"internet_speed": "300",
"technology": {
"id": "2",
"name": "FIBRA"
},
"territory_owners": [
{
"id": "FIBMM02",
"name": "FIBRA PROPIA MM2",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"download_speed": 300,
"upload_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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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"
},
"min_main_lines": 1,
"max_main_lines": 1,
"bundled_commercial_products": [
{
"id": null,
"from": null,
"to": null,
"is_mandatory": null,
"is_main_line": null,
"is_extra": null,
"is_additional": null,
"is_bundled": null,
"duo_type": null,
"max_quantity": null,
"invoice_name": null,
"commercial_product": null,
"fees": null
}
]
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
external_id | string | identifies the product in external systems, so it is only informed in bundled with third party interactions, for example Netflix | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_segment | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
download_speed | string | 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 | 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 | 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’ | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
technology | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
territory_owners | object[] | array of territory owners where the bundled product services can be provisioned and the bundled product product can be purchased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_product_subs_types | object[] | array of subscription types included within the bundled products | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of bundled products based on input criteria, including the mandatory bundled commercial products for each bundled product (default behaviour returns only mandatory bundled commercial products. With additional boolean include_optional_bundled_commercial_products query param, optional ones can be returned too, with considerable impact on response time and response size). Provides details for each bundled commercial product about the marketing name, fees (which may be different than the fees applicable for the correspondent commercial product when it is sold as a standalone product), mandatory free units packages included within the bundled commercial product and mandatory promotions applicable for the bundle commercial product (which may be different than the promotions applicable for the correspondent commercial product when it is sold as a standalone product).
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
technology name
territory owner identifier
bundled product category
customer segment name
commercial segment name (SME (SmallMediumEnterprise) or Consumer)
customer type name
sale type name
boolean to indicate if optional bundled commercial products details must be returned (not recommended). false by default
OK Bundled products
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"min_quantity": 1,
"max_quantity": 1,
"is_mandatory": true,
"used_for_automatic_orphan_subscription_change": false,
"subs_type": {
"name": null,
"description": null,
"id": null
},
"min_main_lines": 1,
"max_main_lines": 1,
"bundled_commercial_products": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_segment | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
download_speed | string | 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 | 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 | 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 | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_product_subs_types | object[] | array of subscription types included within the bundled products | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | array of promotions compatible with the bundled product | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products?commercial_profile_name=perfil_comercial.postpago_ventas_pos&territory_owner_id=FIBMM02&customer_type_name=Nuevo&include_optional_bundled_commercial_products=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable bundled products based on input criteria, including the mandatory bundled commercial products for each bundled product (default behaviour returns only mandatory bundled commercial products. With additional boolean include_optional_bundled_commercial_products query param, optional ones can be returned too, with considerable impact on response time and response size). Provides details for each bundled commercial product about the marketing name, fees (which may be different than the fees applicable for the correspondent commercial product when it is sold as a standalone product), mandatory free units packages included within the bundled commercial product and mandatory promotions applicable for the bundle commercial product (which may be different than the promotions applicable for the correspondent commercial product when it is sold as a standalone product)
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
technology name
territory owner identifier
bundled product category
customer segment name
commercial segment name (SME (SmallMediumEnterprise) or Consumer)
customer type name
sale type name
OK Bundled products
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"min_quantity": 1,
"max_quantity": 1,
"is_mandatory": true,
"used_for_automatic_orphan_subscription_change": false,
"subs_type": {
"name": null,
"description": null,
"id": null
},
"min_main_lines": 1,
"max_main_lines": 1,
"bundled_commercial_products": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_segment | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
download_speed | string | 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 | 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 | 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 | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_product_subs_types | object[] | array of subscription types included within the bundled products | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | array of promotions compatible with the bundled product | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/sellable?commercial_profile_name=perfil_comercial.postpago_ventas_pos&territory_owner_id=FIBMM02&customer_type_name=Nuevo' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of bundled product subscription types included in the bundled product
PATH PARAMETERS
organization name
bundled product identifier
QUERY PARAMETERS
subscription type name
OK Bundled Product Subscription Type
[
{
"id": "731",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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"
},
"min_main_lines": 1,
"max_main_lines": 1
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||
from | string (date-time) | |||||||||||||||||||||||
to | string (date-time) | |||||||||||||||||||||||
min_quantity | number (int32) | number of minimum subscriptions that must be included within the bundled product for the correspondent subscription type | ||||||||||||||||||||||
max_quantity | number (int32) | number of maximum subscriptions that can be included within the bundled product for the correspondent subscription type | ||||||||||||||||||||||
is_mandatory | boolean | indicates if the correspondent subscription type is mandatory within the bundled product | ||||||||||||||||||||||
used_for_automatic_orphan_subscription_change | boolean | boolean to indicate if the bundled commercial product change is available for manual or automatic changes. | ||||||||||||||||||||||
subs_type | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
min_main_lines | integer (int32) | Minimum number of main line products that must be contracted when this subscription type is included in a bundle. | ||||||||||||||||||||||
max_main_lines | integer (int32) | Maximum number of main line products that can be contracted when this subscription type is included in a bundle. | ||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of eligible bundled products to which a given bundled product id can be changed. Aimed to be used for retrieving allowed bundled product changes for a package of subscriptions, required within different use cases, like package tariff change (with or without speed change), package tariff change together with a service address change, technology change, technology change together with a service address change, 2P → 3P/4P migration, 3P → 2P migration, 4P → 3P migration or 4P → 2P migration). For each bundled product, response includes the mandatory bundled commercial products for (default behaviour returns only mandatory bundled commercial products. With additional boolean include_optional_bundled_commercial_products query param, optional ones can be returned too, with considerable impact on response time and response size). Provides details for each bundled commercial product about the marketing name, fees (which may be different than the fees applicable for the correspondent commercial product when it is sold as a standalone product), mandatory free units packages included within the bundled commercial product and mandatory promotions applicable for the bundle commercial product (which may be different than the promotions applicable for the correspondent commercial product when it is sold as a standalone product).
PATH PARAMETERS
organization name
bundled product identifier
QUERY PARAMETERS
technology name
territory owner identifier
bundled product category
commercial profile name
boolean to indicate if optional bundled commercial products details must be returned (not recommended). false by default
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`.
this query param allows to filter by a particular bundled_product_subscription_type
OK Bundled products
[
{
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"min_quantity": 1,
"max_quantity": 1,
"is_mandatory": true,
"used_for_automatic_orphan_subscription_change": false,
"subs_type": {
"name": null,
"description": null,
"id": null
},
"min_main_lines": 1,
"max_main_lines": 1,
"bundled_commercial_products": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_segment | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
download_speed | string | 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 | 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 | object[] | array of subscription types included within the bundled products | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | array of promotions compatible with the bundled product | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_downsell | boolean | indicates if the switch involves a 3P to 2P change or a 4P to 3P/2P change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_automatic_changes | boolean | 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 | indicates if the switch involves a speed change | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subs_removed | string | bundled product subscription type id removed in the automatic change. Null if `used_for_automatic_changes` = false | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/can-switch?territory_owner_id=FIBMM02&commercial_profile_name=perfil_comercial.postpago_ventas_pos&include_optional_bundled_commercial_products=false&used_for_automatic_changes=false&subs_removed=3476' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns the details of a target bundled product to which a given bundled product id can be changed. Aimed to be used for validating if a specific bundled product switch is valid and in that case retrieving the details of the target bundled product. It can be used in the context of different use cases, like package tariff change (with or without speed change), package tariff change together with a service address change, technology change, technology change together with a service address change, 2P->3P/4P migration, 3P → 2P migration, 4P → 3P migration or 4P → 2P migration).
PATH PARAMETERS
organization name
id of target bundled_product to switch
bundled product identifier
QUERY PARAMETERS
territory owner identifier
commercial profile name
boolean to indicate if optional bundled commercial products details must be returned (not recommended). false by default
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`.
OK Bundled products
{
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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"
},
"min_main_lines": 1,
"max_main_lines": 1,
"bundled_commercial_products": [
{
"id": null,
"from": null,
"to": null,
"is_mandatory": null,
"is_main_line": null,
"is_extra": null,
"is_additional": null,
"is_bundled": null,
"duo_type": null,
"max_quantity": null,
"invoice_name": null,
"commercial_product": null,
"fees": null,
"commercial_profiles": null
}
]
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"binding_type_id": null
}
],
"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": null,
"name": null,
"visibility_type": null,
"from": null,
"to": null
}
]
}
],
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_segment | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
bundled_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
download_speed | string | 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 | 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 | object[] | array of subscription types included within the bundled products | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | array of promotions compatible with the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_downsell | boolean | indicates if the switch involves a 3P to 2P change or a 4P to 3P/2P change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_automatic_changes | boolean | 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 | indicates if the switch involves a speed change | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
subs_removed | string | bundled product subscription type id removed in the automatic change. Null if `used_for_automatic_changes` = false | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
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=false&used_for_automatic_changes=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of eligible bundled commercial products related to a given bundled product and a given bundled product subscription type. Aimed to be used for retrieving sellable bundled commercial products within the context of a given bundled product, required for the use case of adding a new subscription to an existent package. It includes within the response fees related with each bundled commercial product, as well as all the mandatory promotions and free units packages that are compatible/included within each bundled commercial product.
PATH PARAMETERS
organization name
bundled product identifier
bundled product subscription type identifier
QUERY PARAMETERS
sale type name
commercial profile name
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
This parameter is optional and should only be used to retrieve device insurance tariffs (subs_type=DEVICEINSURANCE)
OK Bundled Commercial products
[
{
"id": "4028",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"free_units_packages": [
{
"id": null,
"name": null,
"marketing_name": null,
"digital_channels_name": null,
"invoice_name": null,
"invoice_description": null,
"in_catalogue_since": null,
"in_catalogue_until": null,
"mysim_free_units_package_id": null,
"unit_amount": null,
"volume_home_sl0": null,
"volume_home_sl1": null,
"volume_rlah_sl0": null,
"volume_rlah_sl1": null,
"volume_nr_sl0": null,
"volume_nr_sl1": null,
"event_type": null,
"unlimited": null,
"max_grants": null,
"is_recurring_package": null,
"applicability_priority": null,
"used_for_policy_rule_change": null,
"category": null,
"sharing_compatible": null,
"free_units_package_template": null,
"fees": null,
"promotions": null,
"base_profiles": null,
"commercial_profiles": null,
"from": null,
"to": null,
"is_mandatory": null,
"is_mandatory_optional": null,
"is_mandatory_for_sale": null
}
],
"promotions": [
{
"id": null,
"name": null,
"marketing_name": null,
"digital_channels_name": null,
"invoice_name": null,
"invoice_description": null,
"in_catalogue_since": null,
"in_catalogue_until": null,
"need_promotion_code": null,
"need_existent_MSISDN": null,
"applicability_model": null,
"restrictions_applicability_rule": null,
"target_applicability_rule": null,
"fee_subtypes": null,
"calculation_model": null,
"discount_type": null,
"duration": null,
"unlimited_duration": null,
"keep_on_upgrade": null,
"keep_on_downgrade": null,
"priority": null,
"is_mandatory": null,
"xsell_permit": null,
"reduced_fee_amount": null,
"value": null,
"currency": null,
"from": null,
"to": null,
"skip_first_period": null,
"reduce_penalty_threshold": null,
"type_group": null,
"category_name": null,
"type_name": null,
"terms": null,
"transaction_type": null,
"commercial_profiles": null
}
],
"commercial_profiles": [
{
"id": null,
"name": null,
"visibility_type": null,
"from": null,
"to": null
}
],
"fees": [
{
"id": null,
"description": null,
"type": null,
"subtype": null,
"recurrence_scheme": null,
"recurrence_interval_type": null,
"recurrence_interval": null,
"paid_in_advance": null,
"prorated_on_activation": null,
"prorated_on_deactivation": null,
"is_external": null,
"from": null,
"to": null,
"value": null,
"currency": null,
"terms": null,
"transaction_type": null
}
]
},
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the bundled commercial product is mandatory within the bundled product subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_main_line | boolean | indicates if the bundled commercial product must be handled as main line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_extra | boolean | indicates if the bundled commercial product must be handed as an extra line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_additional | boolean | indicates if the bundled commercial product must be handed as an additional line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_bundled | boolean | indicates if the bundled commercial product must be 'bundled' in invoice, contract and pre-contractual info. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duo_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | number (int32) | max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_product | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types/120/bundled_commercial_products/sellable?commercial_profile_name=perfil_comercial.postpago_ventas_pos&insured_amount=350' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of all, not only sellable, bundled commercial products related to a given bundled product and a given bundled product subscription type.
PATH PARAMETERS
organization name
bundled product identifier
bundled product subscription type identifier
QUERY PARAMETERS
sale type name
commercial profile name
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
This parameter is optional and should only be used to retrieve device insurance tariffs (subs_type=DEVICEINSURANCE)
OK Bundled Commercial products
[
{
"id": "4028",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
from | string (date-time) | |||
to | string (date-time) | |||
is_mandatory | boolean | indicates if the bundled commercial product is mandatory within the bundled product subscription type | ||
is_main_line | boolean | indicates if the bundled commercial product must be handled as main line within the bundled product | ||
is_extra | boolean | indicates if the bundled commercial product must be handed as an extra line within the bundled product | ||
is_additional | boolean | indicates if the bundled commercial product must be handed as an additional line within the bundled product | ||
is_bundled | boolean | indicates if the bundled commercial product must be 'bundled' in invoice, contract and pre-contractual info. | ||
duo_type | string | |||
max_quantity | number (int32) | max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type | ||
invoice_name | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types/120/bundled_commercial_products?commercial_profile_name=perfil_comercial.postpago_ventas_pos&insured_amount=350' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns details of a bundled commercial product related to a given bundled product and a given bundled product subscription type. It includes within the response the related fees as well as all the mandatory promotions and free units packages that are compatible/included within it
PATH PARAMETERS
organization name
bundled product identifier
bundled product subscription type identifier
bundled commercial product identifier
OK Bundled Commercial product
{
"id": "4028",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": null,
"event_type": null,
"applicability_rule": null
},
"fees": [
null
],
"promotions": [
null
],
"base_profiles": [
null
],
"commercial_profiles": [
null
],
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
]
},
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
],
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the bundled commercial product is mandatory within the bundled product subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_main_line | boolean | indicates if the bundled commercial product must be handled as main line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_extra | boolean | indicates if the bundled commercial product must be handed as an extra line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_additional | boolean | indicates if the bundled commercial product must be handed as an additional line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_bundled | boolean | indicates if the bundled commercial product must be 'bundled' in invoice, contract and pre-contractual info. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duo_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | number (int32) | max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_product | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types/120/bundled_commercial_products/3009_BUNDLED_3P' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of eligible bundled commercial products to which a given bundled commercial product id can be changed, in the context of a specific bundled product. If it is a migration within the same package, the origin bundled product from the path is enough (it acts as both origin and destination). Otherwise, for migrations between different bundled products, the existing query parameter for the destination bundled product must be filled. Aimed to be used for retrieving allowed bundled commercial product changes for a subscription included within a package. It includes within the response fees related with each bundled commercial product, as well as all the mandatory promotions and free units packages that are compatible/included within each bundled commercial product.
PATH PARAMETERS
organization name
bundled product identifier
bundled commercial product identifier
QUERY PARAMETERS
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
destination bundled product identifier
OK Bundled Commercial products
[
{
"id": "4028",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"free_units_packages": [
{
"id": null,
"name": null,
"marketing_name": null,
"digital_channels_name": null,
"invoice_name": null,
"invoice_description": null,
"in_catalogue_since": null,
"in_catalogue_until": null,
"mysim_free_units_package_id": null,
"unit_amount": null,
"volume_home_sl0": null,
"volume_home_sl1": null,
"volume_rlah_sl0": null,
"volume_rlah_sl1": null,
"volume_nr_sl0": null,
"volume_nr_sl1": null,
"event_type": null,
"unlimited": null,
"max_grants": null,
"is_recurring_package": null,
"applicability_priority": null,
"used_for_policy_rule_change": null,
"category": null,
"sharing_compatible": null,
"free_units_package_template": null,
"fees": null,
"promotions": null,
"base_profiles": null,
"commercial_profiles": null,
"from": null,
"to": null,
"is_mandatory": null,
"is_mandatory_optional": null,
"is_mandatory_for_sale": null
}
],
"promotions": [
{
"id": null,
"name": null,
"marketing_name": null,
"digital_channels_name": null,
"invoice_name": null,
"invoice_description": null,
"in_catalogue_since": null,
"in_catalogue_until": null,
"need_promotion_code": null,
"need_existent_MSISDN": null,
"applicability_model": null,
"restrictions_applicability_rule": null,
"target_applicability_rule": null,
"fee_subtypes": null,
"calculation_model": null,
"discount_type": null,
"duration": null,
"unlimited_duration": null,
"keep_on_upgrade": null,
"keep_on_downgrade": null,
"priority": null,
"is_mandatory": null,
"xsell_permit": null,
"reduced_fee_amount": null,
"value": null,
"currency": null,
"from": null,
"to": null,
"skip_first_period": null,
"reduce_penalty_threshold": null,
"type_group": null,
"category_name": null,
"type_name": null,
"terms": null,
"transaction_type": null,
"commercial_profiles": null
}
],
"commercial_profiles": [
{
"id": null,
"name": null,
"visibility_type": null,
"from": null,
"to": null
}
],
"fees": [
{
"id": null,
"description": null,
"type": null,
"subtype": null,
"recurrence_scheme": null,
"recurrence_interval_type": null,
"recurrence_interval": null,
"paid_in_advance": null,
"prorated_on_activation": null,
"prorated_on_deactivation": null,
"is_external": null,
"from": null,
"to": null,
"value": null,
"currency": null,
"terms": null,
"transaction_type": null
}
]
},
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"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
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the bundled commercial product is mandatory within the bundled product subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_main_line | boolean | indicates if the bundled commercial product must be handled as main line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_extra | boolean | indicates if the bundled commercial product must be handed as an extra line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_additional | boolean | indicates if the bundled commercial product must be handed as an additional line within the bundled product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_bundled | boolean | indicates if the bundled commercial product must be 'bundled' in invoice, contract and pre-contractual info. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duo_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | number (int32) | max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_product | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_automatic_orphan_subscription_change | boolean | boolean to indicate if the bundled commercial product change is available for manual or automatic changes. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
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=false&commercial_profile_name=perfil_comercial.postpago_ventas_pos&destination_bundled_product_id=609' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'This endpoint allows us to resolve the scenario in a bundled product movement where a particular subscription type is compatible but the origin tariff is not present in destination bundled product, providing this destination bundled product ({id}) you can get all the equivalence between conflictives bcp.
PATH PARAMETERS
organization name
destination bundled product id
QUERY PARAMETERS
bundled commercial product for which it is necessary an equivalence in the commercial definition of a particular bundled product
OK OK
[
{
"origin_bundled_commercial_product": "3456_BUNDLED_3P",
"destination_bundled_commercial_product": "3489_BUNDLED_3P"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
origin_bundled_commercial_product | string | |||
destination_bundled_commercial_product | string |
Bad Request Bad request
{
"error": "Bad Request",
"message": "Bad request",
"code": "020015"
}Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
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 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of all bundled commercial products related to a given bundled product.
PATH PARAMETERS
organization name
bundled product identifier
QUERY PARAMETERS
sale type name
commercial profile name
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
flag to filter items that are commercially active or not. If absent default is true
subscription type name
This parameter is optional and should only be used to retrieve device insurance tariffs (subs_type=DEVICEINSURANCE)
OK Bundled Commercial products
[
{
"id": "4028",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL"
},
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the bundled commercial product is mandatory within the bundled product subscription type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_main_line | boolean | indicates if the bundled commercial product must be handled as main line within the bundled product | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_extra | boolean | indicates if the bundled commercial product must be handed as an extra line within the bundled product | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_additional | boolean | indicates if the bundled commercial product must be handed as an additional line within the bundled product | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_bundled | boolean | indicates if the bundled commercial product must be 'bundled' in invoice, contract and pre-contractual info. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duo_type | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | number (int32) | max quantity of the correspondent bundled commercial product allowed for the specific bundled product subscription type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_product | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_commercial_products?commercial_profile_name=perfil_comercial.postpago_ventas_pos&insured_amount=350&sellable=true' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'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.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
sale type name
commercial profile name
id to filter free_units_packages with a specific debit_account
OK Free Units Package
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"base_profiles": [
{
"id": "4442",
"name": "INTERNET 10GB_TPILI YOIGO",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": true,
"is_mandatory_optional": false,
"is_mandatory_for_sale": true
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_free_units_package_id | string | internal id used within Mysim, null for 'dummy' unlimited voice free units packages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit_amount | number (int64) | 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) | Data volume in bytes navigable at maximum speed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_home_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited | boolean | indicates if the free units is sold as an unlimited package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_grants | number (int32) | 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 | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_priority | number (int32) | priority of the free units package when consuming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_policy_rule_change | boolean | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_package_template | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the free units package starts to be included within the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the free units package is no longer included within the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the free units package is mandatory with the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory_optional | boolean | 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 | indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/free_units_packages?commercial_profile_name=perfil_comercial.postpago_ventas_pos&debit_account_id=1000' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns free units package info by id related to a commercial product id.
PATH PARAMETERS
organization name
commercial product identifier
free units package identifier
QUERY PARAMETERS
commercial profile name
OK Free Units Package
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"binding_type_id": null
}
],
"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": null,
"name": null,
"visibility_type": null,
"from": null,
"to": null
}
]
}
],
"base_profiles": [
{
"id": "4442",
"name": "INTERNET 10GB_TPILI YOIGO",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": true,
"is_mandatory_optional": false,
"is_mandatory_for_sale": true
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_free_units_package_id | string | internal id used within Mysim, null for 'dummy' unlimited voice free units packages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit_amount | number (int64) | 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) | Data volume in bytes navigable at maximum speed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_home_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited | boolean | indicates if the free units is sold as an unlimited package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_grants | number (int32) | 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 | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_priority | number (int32) | priority of the free units package when consuming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_policy_rule_change | boolean | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_package_template | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the free units package starts to be included within the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the free units package is no longer included within the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the free units package is mandatory with the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory_optional | boolean | 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 | indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
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 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns free units package info by id related to a service provider id.
PATH PARAMETERS
organization name
free units package identifier
OK Free Units Package
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"binding_type_id": null
}
],
"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": null,
"name": null,
"visibility_type": null,
"from": null,
"to": null
}
]
}
],
"base_profiles": [
{
"id": "4442",
"name": "INTERNET 10GB_TPILI YOIGO",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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"
}
]
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_free_units_package_id | string | internal id used within Mysim, null for 'dummy' unlimited voice free units packages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit_amount | number (int64) | 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) | Data volume in bytes navigable at maximum speed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_home_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited | boolean | indicates if the free units is sold as an unlimited package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_grants | number (int32) | 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 | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_priority | number (int32) | priority of the free units package when consuming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_policy_rule_change | boolean | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_package_template | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/free_units_packages/145' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns free units package info by service provider
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
OK Free Units Package
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"base_profiles": [
{
"id": "4442",
"name": "INTERNET 10GB_TPILI YOIGO",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_free_units_package_id | string | internal id used within Mysim, null for 'dummy' unlimited voice free units packages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit_amount | number (int64) | 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) | Data volume in bytes navigable at maximum speed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_home_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited | boolean | indicates if the free units is sold as an unlimited package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_grants | number (int32) | 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 | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_priority | number (int32) | priority of the free units package when consuming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_policy_rule_change | boolean | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_package_template | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/free_units_packages?commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'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.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
sale type name
commercial profile name
id to filter free_units_packages with a specific debit_account
OK 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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
],
"base_profiles": [
{
"id": "4442",
"name": "INTERNET 10GB_TPILI YOIGO",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": true,
"is_mandatory_optional": false,
"is_mandatory_for_sale": true
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_free_units_package_id | string | internal id used within Mysim, null for 'dummy' unlimited voice free units packages | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unit_amount | number (int64) | 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) | Data volume in bytes navigable at maximum speed | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_home_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_rlah_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
volume_nr_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
event_type | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited | boolean | indicates if the free units is sold as an unlimited package | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_grants | number (int32) | 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 | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_priority | number (int32) | priority of the free units package when consuming | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
used_for_policy_rule_change | boolean | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sharing_compatible | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
free_units_package_template | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
base_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the free units package starts to be included within the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the free units package is no longer included within the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | indicates if the free units package is mandatory with the commercial product | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory_optional | boolean | 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 | indicates if the free units package is mandatory with the commercial product during sale, but not for migration (commercial product change) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/free_units_packages/sellable?commercial_profile_name=perfil_comercial.postpago_ventas_pos&debit_account_id=1000' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns the promotions with ApplicabilityModel=Billing and which are commercially active for the correspondent Service Provider
PATH PARAMETERS
organization name
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
target applicability rule
OK Promotion
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/promotions/sellable?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of both mandatory and optional promotions related to a commercial product id, applicable when the commercial product is sold as a standalone product. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
commercial profile name
sale type name
customer type name
numeration type name
OK Promotion
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/promotions?commercial_profile_name=perfil_comercial.postpago_ventas_pos&customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional promotions for a commercial product id, when this is sold as a standalone product. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
OK 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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/promotions/sellable?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of both mandatory and optional promotions related to a bundled product id. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
bundled product identifier
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
OK Promotion
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/promotions?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional promotions related to a bundled product id. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
bundled product identifier
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
OK 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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/promotions/sellable?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of both mandatory and optional promotions related to a bundled commercial product id, applicable when the commercial product is sold as a bundled commercial product. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
bundled commercial product identifier
QUERY PARAMETERS
commercial profile name
sale type name
customer type name
numeration type name
OK Promotion
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/promotions?commercial_profile_name=perfil_comercial.postpago_ventas_pos&customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional promotions related to a bundled commercial product id, when this is sold as part of a bundled product. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
bundled commercial product identifier
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
OK 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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/promotions/sellable?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of both mandatory and optional promotions compatible with the given value added service. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
value added service identifier
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
OK Promotion
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/promotions?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional promotions for a value added service id. Includes main characteristics of each promotion, as well as terms associated to the promotion.
PATH PARAMETERS
organization name
value added service identifier
QUERY PARAMETERS
sale type name
customer type name
numeration type name
commercial profile name
OK 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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"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"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/promotions/sellable?customer_type_name=Nuevo&numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'This endpoint returns the promotion information by a given id
PATH PARAMETERS
organization name
promotion identifier
OK Promotion
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"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"
}
]
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | name used within digital channels | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | promotion duration indicated in number of months | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
xsell_permit | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduced_fee_amount | boolean | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value | number (double) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_group | string | Group classification of the promotion type. Use this field to identify bundle promotions. - BUNDLE: Promotion is a bundle type (e.g., PAQUETE SUBS, PAQUETE SUBS MENSUAL) - OTHER: Any other promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
category_name | string | name to define the promotion category | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
type_name | string | name to define the promotion type | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
transaction_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/promotions/234' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns a paginated list of incompatible promotions for the given promotion if any or an empty list if there are no incompatibilities
PATH PARAMETERS
organization name
Unique commercial_product identifier
promotion identifier
QUERY PARAMETERS
Return only incompatibilities applicable at the specified date-time
The number of elements to skip before starting to collect the result set. It can be used in combination with the limit parameter to control the pagination of the result set.
The number of elements to return in the result set. It can be used in combination with the offset parameter to control the pagination of the result set.
OK List of incompatible promotions
{
"items": [
{
"promotion_id": "1832",
"promotion_marketing_name": "R Descuento 2P 100% 6 meses",
"promotion_type": "PAQUETE SUBS",
"promotion_type_group": "BUNDLE",
"from": "2025-01-01T00:00:00Z",
"to": "2025-01-01T00:00:00Z"
}
],
"pagination": {
"total": 150,
"offset": 20,
"limit": 10
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items* | object[] | ||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||
pagination* | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/promotions/234/incompatibilities?applicable_at=2080-10-03T22%3A00%3A00Z&offset=0&limit=20' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns a paginated list of incompatible promotions for the given promotion if any or an empty list if there are no incompatibilities
PATH PARAMETERS
organization name
bundled commercial product identifier
promotion identifier
QUERY PARAMETERS
Return only incompatibilities applicable at the specified date-time
The number of elements to skip before starting to collect the result set. It can be used in combination with the limit parameter to control the pagination of the result set.
The number of elements to return in the result set. It can be used in combination with the offset parameter to control the pagination of the result set.
OK List of incompatible promotions
{
"items": [
{
"promotion_id": "1832",
"promotion_marketing_name": "R Descuento 2P 100% 6 meses",
"promotion_type": "PAQUETE SUBS",
"promotion_type_group": "BUNDLE",
"from": "2025-01-01T00:00:00Z",
"to": "2025-01-01T00:00:00Z"
}
],
"pagination": {
"total": 150,
"offset": 20,
"limit": 10
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items* | object[] | ||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||
pagination* | object | ||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/promotions/234/incompatibilities?applicable_at=2080-10-03T22%3A00%3A00Z&offset=0&limit=20' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array with the information about terms (campaignid, penalty, permanency) assigned to sellable commercial devices for the specified service provider.
PATH PARAMETERS
organization name
QUERY PARAMETERS
sale type name
OK ok
[
{
"campaign_id": "1234567",
"term": {
"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"
}
}
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
campaign_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
term | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_devices/terms/sellable' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional commercial devices for a commercial product id, when this is sold as a standalone product. Includes main characteristics of each device, as well as fees and installment plans associated to the commercial device and terms associated to them.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
sale type name
numeration type name
commercial profile name
optional field that indicates if is financed, single or recurring payment
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
flag to filter commercial devices based on whether they have permanence or not
OK Commercial devices
[
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"terms": [
null
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
null
],
"terms": [
null
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": false
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/commercial_devices/sellable?numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos&device_brand=SAMSUNG&generic_code=P062P63&permanence=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional commercial devices related to a bundled commercial product id, when this is sold as part of a bundled product. Includes main characteristics of each device, as well as fees and installment plans associated to the commercial device and terms associated to them.
PATH PARAMETERS
organization name
bundled commercial product identifier
QUERY PARAMETERS
sale type name
numeration type name
optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero)
commercial profile name
optional field that indicates if is financed, single or recurring payment
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
flag to filter commercial devices based on whether they have permanence or not
flag to filter device permanences according to the multi-financing business rules - **MAIN**: Penalties that apply to header lines and non-OXF segments. You can only have 1 at a time - **NOT_MAIN**: Permanences that apply to devices on additional lines, OXF segments. You can have more than 1 at a time **Note:** If this parameter (`permanence_type`) is provided in the request, the `permanence` query parameter will be `true`.
flag to filter commercial devices that are mandatory to sell in a bundled product. If absent, no filtering is applied (null).
OK Commercial devices
[
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"terms": [
null
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
null
],
"terms": [
null
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": false
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/commercial_devices/sellable?numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos&device_brand=SAMSUNG&generic_code=P062P63&permanence=false&mandatory=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional commercial devices related to a bundled commercial product id, when this is sold as part of a bundled product. Includes main characteristics of each device, as well as fees and installment plans associated to the commercial device and terms associated to them.
PATH PARAMETERS
organization name
bundled product identifier
bundled commercial product identifier
QUERY PARAMETERS
sale type name
numeration type name
optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero)
commercial profile name
optional field that indicates if is financed, single or recurring payment
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
flag to filter commercial devices based on whether they have permanence or not
flag to filter device permanences according to the multi-financing business rules - **MAIN**: Penalties that apply to header lines and non-OXF segments. You can only have 1 at a time - **NOT_MAIN**: Permanences that apply to devices on additional lines, OXF segments. You can have more than 1 at a time **Note:** If this parameter (`permanence_type`) is provided in the request, the `permanence` query parameter will be `true`.
flag to filter commercial devices that are mandatory to sell in a bundled product. If absent, no filtering is applied (null).
OK Commercial devices
[
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"terms": [
null
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
null
],
"terms": [
null
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": false
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_commercial_products/3009_BUNDLED_3P/commercial_devices/sellable?numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos&device_brand=SAMSUNG&generic_code=P062P63&permanence=false&mandatory=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional commercial devices for a value added service id. Includes main characteristics of each device, as well as fees and installment plans associated to the commercial device and terms associated to them.
PATH PARAMETERS
organization name
value added service identifier
QUERY PARAMETERS
sale type name
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
flag to filter commercial devices based on whether they have permanence or not
OK Commercial devices
[
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"terms": [
null
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
null
],
"terms": [
null
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": false
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/commercial_devices/sellable?device_brand=SAMSUNG&generic_code=P062P63&permanence=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns all the different refinance possibilities for the last payment of a previous financed commercial device
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
amount to refinance
OK Refinance conditions
[
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
{
"id": "1",
"description": "cuota financiación",
"type": "OneTimeFee",
"subtype": "UpfrontFee",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": false,
"prorated_on_activation": false,
"prorated_on_deactivation": false,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_external": false,
"value": 8.264463,
"currency": "euro",
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"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": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the term starts to be applicable for the commercial device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the term is no longer applicable for the commercial device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
duration | number (int32) | duration of the installment plan indicated in number of months | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tin | string | only informed in case of financed offer_id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
tae | string | only informed in case of financed offer_id | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commission | string | only informed in case of financed, amunt of the commission applied | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commission_percentage | string | only informed in case of financed, percentage of the commission applied | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terms | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_devices/refinance?commercial_profile_name=perfil_comercial.postpago_ventas_pos&refinance_amount=154%2C87' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns paginated commercial devices for the correspondent Service Provider. Default order ASC
PATH PARAMETERS
organization name
QUERY PARAMETERS
sale type name
renewal category
numeration type name
optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero)
commercial profile name
name of the subscription offer segment
optional field that indicates if is financed, single or recurring payment
optional field to filter by device category
multiple optional field to filter by device category. Case sensitive. Concatenate with ','.
optional field to filter by device brand
optional field to filter by device name. Case sensitive
optional field to filter by device name. Case sensitive
optional field to filter by device model. Case sensitive
optional field to filter by device model with REGEX. Case sensitive
optional field to filter by device colour
The fields by which the results will be sorted. It can be a list of fields separated by commas. A suffix must be added: * ":asc" to indicate an ascending order. * ":desc" to indicate a descending order.
optional field to filter by generic code device
filter for devices whose ids contain a specific string
flag to filter commercial devices based on whether they have permanence or not
flag to filter device permanences according to the multi-financing business rules - **MAIN**: Penalties that apply to header lines and non-OXF segments. You can only have 1 at a time - **NOT_MAIN**: Permanences that apply to devices on additional lines, OXF segments. You can have more than 1 at a time **Note:** If this parameter (`permanence_type`) is provided in the request, the `permanence` query parameter will be `true`.
The number of elements to skip before starting to collect the result set. It can be used in combination with the limit parameter to control the pagination of the result set.
The number of elements to return in the result set. It can be used in combination with the offset parameter to control the pagination of the result set.
flag to filter items that are commercially active or not. If absent default is true
flag to filter commercial devices that are mandatory to sell in a bundled product. If absent, no filtering is applied (null).
OK OK
{
"items": [
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": null,
"name": null,
"description": null,
"from": null,
"to": null
}
],
"donor_numeration_types": [
{
"id": null,
"name": null,
"description": null,
"from": null,
"to": null
}
],
"sale_types": [
{
"id": null,
"name": null,
"description": null,
"from": null,
"to": null
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": null,
"description": null,
"type": null,
"subtype": null,
"from": null,
"to": null,
"recurrence_scheme": null,
"recurrence_interval_type": null,
"recurrence_interval": null,
"paid_in_advance": null,
"prorated_on_activation": null,
"prorated_on_deactivation": null,
"is_external": null,
"value": null,
"currency": null,
"transaction_type": null,
"terms": null
}
],
"installment_plans": [
{
"id": null,
"name": null,
"from": null,
"to": null,
"duration": null,
"tin": null,
"tae": null,
"commission": null,
"commission_percentage": null,
"fees": null,
"terms": null
}
],
"commercial_profiles": [
{
"id": null,
"name": null,
"visibility_type": null,
"from": null,
"to": null,
"logistic_required": null,
"store_delivery_allowed": null
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"promotions": [
{
"id": null,
"name": null,
"marketing_name": null,
"digital_channels_name": null,
"invoice_name": null,
"invoice_description": null,
"in_catalogue_since": null,
"in_catalogue_until": null,
"need_promotion_code": null,
"need_existent_MSISDN": null,
"applicability_model": null,
"restrictions_applicability_rule": null,
"target_applicability_rule": null,
"fee_subtypes": null,
"calculation_model": null,
"discount_type": null,
"duration": null,
"unlimited_duration": null,
"keep_on_upgrade": null,
"keep_on_downgrade": null,
"priority": null,
"is_mandatory": null,
"xsell_permit": null,
"reduced_fee_amount": null,
"value": null,
"currency": null,
"from": null,
"to": null,
"skip_first_period": null,
"reduce_penalty_threshold": null,
"type_group": null,
"category_name": null,
"type_name": null,
"terms": null,
"transaction_type": null,
"commercial_profiles": null
}
]
}
],
"pagination": {
"total": 150,
"offset": 20,
"limit": 10
}
}| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
items* | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
pagination* | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_devices?numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos&subs_offer_segment_name=OCA&device_category[in]=SMARTPHONE%2CSMARTWATCH&device_brand=SAMSUNG&device_name=512GB&device_name[contains]=iPhone&device_model=iPhone&device_model[contains]=iPhone&device_colour=NEGRO&sort=name%3Adesc%2Cexternal_id%3Aasc&generic_code=P062P63&device_id[contains]=P062&permanence=false&offset=0&limit=20&sellable=true&mandatory=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns all commercial devices that are commercially active for the correspondent Service Provider
PATH PARAMETERS
organization name
QUERY PARAMETERS
sale type name
renewal category
numeration type name
optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero)
commercial profile name
name of the subscription offer segment
optional field that indicates if is financed, single or recurring payment
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
flag to filter commercial devices based on whether they have permanence or not
flag to filter device permanences according to the multi-financing business rules - **MAIN**: Penalties that apply to header lines and non-OXF segments. You can only have 1 at a time - **NOT_MAIN**: Permanences that apply to devices on additional lines, OXF segments. You can have more than 1 at a time **Note:** If this parameter (`permanence_type`) is provided in the request, the `permanence` query parameter will be `true`.
OK Commercial Devices
[
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"terms": [
null
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
null
],
"terms": [
null
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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,
"type_group": "BUNDLE",
"category_name": "captación",
"type_name": "PERMANENCIA",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
},
"commercial_profiles": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
promotions | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_devices/sellable?numeration_type_name=Nuevo%20numero&commercial_profile_name=perfil_comercial.postpago_ventas_pos&subs_offer_segment_name=OCA&device_brand=SAMSUNG&generic_code=P062P63&permanence=false' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns basic commercial device info for a commercial device id
PATH PARAMETERS
organization name
commercial device identifier
OK Commercial device
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"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"
},
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
{
"id": null,
"description": null,
"type": null,
"subtype": null,
"recurrence_scheme": null,
"recurrence_interval_type": null,
"recurrence_interval": null,
"paid_in_advance": null,
"prorated_on_activation": null,
"prorated_on_deactivation": null,
"from": null,
"to": null,
"is_external": null,
"value": null,
"currency": null,
"transaction_type": null
}
],
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": false
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_devices/006703d738efe9b30aeefaadd4bfe20b' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns basic commercial device info for a commercial device id with a related bundled commercial product
PATH PARAMETERS
organization name
bundled commercial product identifier
commercial device identifier
OK Commercial device
{
"id": "579153",
"terminal_id": "45",
"campaign_id": "644",
"renewal_category": "Generic",
"cession_price": 50.5,
"retail_price": 50.5,
"discount": 50.5,
"insured_amount": -1,
"payment_type": "string",
"numeration_types": [
{
"id": "3",
"name": "Numero entre marcas",
"description": "Número portado de operador dentro del grupo",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"donor_numeration_types": [
{
"id": "1",
"name": "string",
"description": "Pospago",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"sale_types": [
{
"id": "2",
"name": "Añadir Línea",
"description": "Venta móvil sobre paquete existente",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z"
}
],
"device": {
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"model_web": "ALCATEL 1S NEGRO"
},
"fees": [
{
"id": "1",
"description": "579153 pagoupfront",
"type": "UpfrontFee",
"subtype": "UpfrontFee",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"recurrence_scheme": "BoundToBillCycle",
"recurrence_interval_type": "Monthly",
"recurrence_interval": 30,
"paid_in_advance": true,
"prorated_on_activation": true,
"prorated_on_deactivation": true,
"is_external": false,
"value": 8.264463,
"currency": "euro",
"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"
},
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
]
}
],
"installment_plans": [
{
"id": "420124",
"name": "420124",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"duration": 12,
"tin": "0.00",
"tae": "4.08",
"commission": "25.15",
"commission_percentage": "4.00",
"fees": [
{
"id": null,
"description": null,
"type": null,
"subtype": null,
"recurrence_scheme": null,
"recurrence_interval_type": null,
"recurrence_interval": null,
"paid_in_advance": null,
"prorated_on_activation": null,
"prorated_on_deactivation": null,
"from": null,
"to": null,
"is_external": null,
"value": null,
"currency": null,
"transaction_type": null
}
],
"terms": [
{
"id": null,
"name": null,
"type": null,
"commitment_duration": null,
"unlimited_duration": null,
"penalty_prorated": null,
"value": null,
"currency": null,
"permanence_type": null,
"transaction_type": null,
"from": null,
"to": null
}
]
}
],
"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",
"logistic_required": false,
"store_delivery_allowed": false
}
],
"installation_type": {
"id": 2,
"description": "SELF-INSTALLATION"
},
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"is_mandatory": false
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
terminal_id | string | terminalId within legacy MySim, required to be sent within legacy Mysim socket request | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
campaign_id | string | optional field, mysim campaign for handling permanency associated to the commercial device | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
renewal_category | string | optional field, only informed for 'Cartera' subscriptions to inform the commercial profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
cession_price | number (double) | optional field, only informed for 'Cartera' subscriptions to inform the cession price | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
retail_price | number (double) | optional field, only informed in non-mandatory commercial devices. is the price the end user pays for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
discount | number (double) | optional field, only informed in non-mandatory commercial devices. is the discount made by the service provider for the device. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
insured_amount | number (double) | field with the amount that can be insured in a particular device, if there is no insurance option a -1.00 value is returned | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
payment_type | string | field that indicates if is financed, single or recurring payment | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
numeration_types | object[] | optional field that indicates the numeration origin. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
donor_numeration_types | object[] | optional field that indicates the numeration type in case of portability (numeration type is not Nuevo numero) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
sale_types | object[] | optional field that indicates if it is a new sale or an action over an existing subscription | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
device | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installment_plans | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
commercial_profiles | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
installation_type | object | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | date when the commercial device starts to be applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | date when the commercial device is no longer applicable for a commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | if the commercial device is mandatory when purchasing the correspondent commercial product/bundled commercial product/value added service | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/commercial_devices/006703d738efe9b30aeefaadd4bfe20b' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns the rate plans related to a commercial product id
PATH PARAMETERS
organization name
commercial product identifier
OK RatePlan
[
{
"id": "TARIFA_CERO_PREPAGO_TOT_VOZ",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/rate_plans' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of base profiles related to a commercial product id. Includes network provisioning details for each base profile as well as details of the services provisioned in the connection process as part of the profile.
PATH PARAMETERS
organization name
commercial product identifier
OK Base Profile
[
{
"id": "71_COMPRODUCT",
"name": "PERFIL FTTH 50MB",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"network_id": "2",
"network_provisioning_id": "MM_CERO_VC_600M",
"service_class": "2900",
"offer_id": "300030015",
"charging_id": "300030015",
"manual_renewal": false,
"download_speed": "300",
"internet_speed": "300",
"upload_speed": "300",
"services": [
{
"id": "2",
"name": "BLOQUEO DE LLAMADAS ENTRANTES",
"description": "BLOQUEO DE LLAMADAS ENTRANTES",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"network_code": "obi",
"is_changeable": true,
"activate_on_network_provisioning": true,
"language": "ESPANOL",
"speed": "300Mb",
"available_networks": "RED YOIGO+ORANGE+TELEFÓNICA"
}
]
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
name | string | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_id | string | network that can be used for provisioning the services encapsulated within the base profile | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
network_provisioning_id | string | id used for provisioning the commercial product within the correspondent network | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
service_class | string | additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
offer_id | string | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
charging_id | string | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
manual_renewal | boolean | boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
download_speed | string | download speed for broadband base profiles, used for provisioning purpose | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
internet_speed | string | commercial speed to be shown to client, could be different than the down and upload provisioning speed | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
upload_speed | string | upload speed for broadband base profiles, used for provisioning purpose | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
services | object[] | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/base_profiles' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of existing base profiles
PATH PARAMETERS
organization name
OK OK
[
{
"id": "71_COMPRODUCT",
"name": "PERFIL FTTH 50MB",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"network_id": "2",
"network_provisioning_id": "MM_CERO_VC_600M",
"service_class": "2900",
"offer_id": "300030015",
"charging_id": "300030015",
"manual_renewal": false,
"download_speed": "300",
"internet_speed": "300",
"upload_speed": "300"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
network_id | string | network that can be used for provisioning the services encapsulated within the base profile | ||
network_provisioning_id | string | id used for provisioning the commercial product within the correspondent network | ||
service_class | string | additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1 | ||
offer_id | string | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||
charging_id | string | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||
manual_renewal | boolean | boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||
download_speed | string | download speed for broadband base profiles, used for provisioning purpose | ||
internet_speed | string | commercial speed to be shown to client, could be different than the down and upload provisioning speed | ||
upload_speed | string | upload speed for broadband base profiles, used for provisioning purpose |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/base_profiles' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a particular base profile
PATH PARAMETERS
organization name
base profile identifier
OK OK
{
"id": "71_COMPRODUCT",
"name": "PERFIL FTTH 50MB",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"network_id": "2",
"network_provisioning_id": "MM_CERO_VC_600M",
"service_class": "2900",
"offer_id": "300030015",
"charging_id": "300030015",
"manual_renewal": false,
"download_speed": "300",
"internet_speed": "300",
"upload_speed": "300"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
network_id | string | network that can be used for provisioning the services encapsulated within the base profile | ||
network_provisioning_id | string | id used for provisioning the commercial product within the correspondent network | ||
service_class | string | additional value required for provisioning within Yoigo network (networkId=2). Not used for networkId=1 | ||
offer_id | string | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||
charging_id | string | additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||
manual_renewal | boolean | boolean additional value required for provisioning prepaid tariffs within Yoigo network (networkId=2). Not used for networkId=1 | ||
download_speed | string | download speed for broadband base profiles, used for provisioning purpose | ||
internet_speed | string | commercial speed to be shown to client, could be different than the down and upload provisioning speed | ||
upload_speed | string | upload speed for broadband base profiles, used for provisioning purpose |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/base_profiles/122_COMPRODUCT' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a particular base profile
PATH PARAMETERS
organization name
base profile identifier
OK OK
[
{
"id": "2",
"name": "BLOQUEO DE LLAMADAS ENTRANTES",
"description": "BLOQUEO DE LLAMADAS ENTRANTES",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"network_code": "obi",
"is_changeable": true,
"activate_on_network_provisioning": true,
"language": "ESPANOL",
"speed": "300Mb",
"available_networks": "RED YOIGO+ORANGE+TELEFÓNICA"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
description | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
from | string (date-time) | |||
to | string (date-time) | |||
network_code | string | parameter used by network to identify the service | ||
is_changeable | boolean | means if the surrent service status can be changed | ||
activate_on_network_provisioning | boolean | indicates if the service is automatically activated when the technical profile is provisioned | ||
language | string | characteristic used for serviceId = 2. Not used for other services | ||
speed | string | characteristic used for serviceId = 16. Not used for other services | ||
available_networks | string | characteristic used for serviceId = 30. Not used for other services |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/base_profiles/122_COMPRODUCT/services' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of both mandatory and optional value added services related to a commercial product id, eligible when the commercial product is sold as a standalone product. Includes basic characteristics of each value added service, as well as applicable fees, with the correspondent values and tax details.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
sale type name
internal service id used within mySim
OK Value Added Service
[
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30: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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"is_mandatory": false,
"max_cardinality": 1,
"max_quantity": 1,
"related_bundled_product_id": 1000,
"value_added_services": [
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"fees": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_cardinality | string | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | integer | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_bundled_product_id | string | Id of the bundled_product for which the value_added_service is configured. It is `null` when value_added_services are requested for a commercial_product instead of bundled_commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value_added_services | object[] | Required value_added_services that need to be hired with the parent value_added_service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/value_added_services?mysim_service_id=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional value added services for a commercial product id, when this is sold as a standalone product. Includes main characteristics of each value added service, as well as fees associated to the value added service.
PATH PARAMETERS
organization name
commercial product identifier
QUERY PARAMETERS
sale type name
OK ValueAddedServices
[
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30: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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"is_mandatory": false,
"max_cardinality": 1,
"max_quantity": 1,
"related_bundled_product_id": 1000,
"value_added_services": [
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"fees": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_cardinality | string | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | integer | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_bundled_product_id | string | Id of the bundled_product for which the value_added_service is configured. It is `null` when value_added_services are requested for a commercial_product instead of bundled_commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value_added_services | object[] | Required value_added_services that need to be hired with the parent value_added_service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/value_added_services/sellable' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of both mandatory and optional value added services related to a bundled commercial product id, eligible when the commercial product is sold as a bundled commercial product. Includes main characteristics of each value added service, as well as fees associated to them.
PATH PARAMETERS
organization name
bundled commercial product identifier
QUERY PARAMETERS
sale type name
internal service id used within mySim
OK Value Added Service
[
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30: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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"is_mandatory": false,
"max_cardinality": 1,
"max_quantity": 1,
"related_bundled_product_id": 1000,
"value_added_services": [
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"fees": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_cardinality | string | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | integer | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_bundled_product_id | string | Id of the bundled_product for which the value_added_service is configured. It is `null` when value_added_services are requested for a commercial_product instead of bundled_commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value_added_services | object[] | Required value_added_services that need to be hired with the parent value_added_service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/value_added_services?mysim_service_id=1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional value added services relatd to a bundled commercial product id, when this is sold as part of a bundled product. Includes main characteristics of each value added service, as well as fees associated to the value added service.
PATH PARAMETERS
organization name
bundled commercial product identifier
QUERY PARAMETERS
sale type name
OK ValueAddedServices
[
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30: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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"is_mandatory": false,
"max_cardinality": 1,
"max_quantity": 1,
"related_bundled_product_id": 1000,
"value_added_services": [
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"fees": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_cardinality | string | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | integer | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_bundled_product_id | string | Id of the bundled_product for which the value_added_service is configured. It is `null` when value_added_services are requested for a commercial_product instead of bundled_commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value_added_services | object[] | Required value_added_services that need to be hired with the parent value_added_service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/value_added_services/sellable' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional value added services relatd to a bundled commercial product id, when this is sold as part of a bundled product. Includes main characteristics of each value added service, as well as fees associated to the value added service.
PATH PARAMETERS
organization name
bundled product identifier
bundled commercial product identifier
QUERY PARAMETERS
sale type name
OK ValueAddedServices
[
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30: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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"is_mandatory": false,
"max_cardinality": 1,
"max_quantity": 1,
"related_bundled_product_id": 1000,
"value_added_services": [
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"fees": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_cardinality | string | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | integer | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_bundled_product_id | string | Id of the bundled_product for which the value_added_service is configured. It is `null` when value_added_services are requested for a commercial_product instead of bundled_commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value_added_services | object[] | Required value_added_services that need to be hired with the parent value_added_service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_commercial_products/3009_BUNDLED_3P/value_added_services/sellable' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of sellable mandatory and optional value added services relatd to a bundled commercial product id, when this is sold as part of a bundled product. Includes main characteristics of each value added service, as well as fees associated to the value added service.
PATH PARAMETERS
organization name
bundled product identifier
bundled product subscription type identifier
bundled commercial product identifier
QUERY PARAMETERS
sale type name
OK ValueAddedServices
[
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30: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": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"value": 8.264463,
"currency": "euro",
"terms": [
null
],
"transaction_type": {
"id": null,
"name": null,
"description": null,
"is_active": null,
"is_external": null,
"tax_rate": null,
"transaction_type": null,
"refund_transaction_type_id": null
}
}
],
"is_mandatory": false,
"max_cardinality": 1,
"max_quantity": 1,
"related_bundled_product_id": 1000,
"value_added_services": [
{
"id": "261",
"mysim_id": "21",
"marketing_name": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"digital_channels_name": "IP FIJA",
"invoice_name": "IP FIJA",
"invoice_description": "IP FIJA DESCRIPTION",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"fees": [
null
]
}
]
}
]| Property | Type | Description | Constraints | Default | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
mysim_id | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
marketing_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_since | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
in_catalogue_until | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
digital_channels_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_name | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
invoice_description | string | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
from | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
to | string (date-time) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fees | object[] | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
is_mandatory | boolean | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_cardinality | string | Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
max_quantity | integer | Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
related_bundled_product_id | string | Id of the bundled_product for which the value_added_service is configured. It is `null` when value_added_services are requested for a commercial_product instead of bundled_commercial_product. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
value_added_services | object[] | Required value_added_services that need to be hired with the parent value_added_service. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Array items:
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types/5964/bundled_commercial_products/3009_BUNDLED_3P/value_added_services/sellable' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of the services provided with the given value added service
PATH PARAMETERS
organization name
value added service identifier
OK Service
[
{
"id": "261",
"name": "IP FIJA",
"digital_channels_name": "IP FIJA",
"description": "IP FIJA",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"from": "2025-01-15T10:30:00Z",
"to": "2025-01-15T10:30:00Z",
"activation_work_order_type_id": "101",
"deactivation_work_order_type_id": "103"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
digital_channels_name | string | |||
description | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
from | string (date-time) | |||
to | string (date-time) | |||
activation_work_order_type_id | string | work order type id used for provisioning an activation order for the correspondent value added service | ||
deactivation_work_order_type_id | string | work order type id used for provisioning a deactivation order for the correspondent value added service |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/services' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of commercial info related to a commercial product id, applicable when the commercial product is sold as a standalone product. Commercial Info are currently used for configuring details to be shown within pre-agreement landing page and details to be shown within agreement document.
PATH PARAMETERS
organization name
commercial product identifier
OK CommercialInfo
[
{
"id": "109ES1DESCRIPTION",
"commercial_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>",
"language": "ES",
"invoice_name": "Tarifa Cero Prepago 150min+700mb",
"invoice_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
commercial_description | string | |||
language | string | |||
invoice_name | string | |||
invoice_description | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/commercial_infos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of commercial info related to a bundled product id. Commercial Info are currently used for configuring details to be shown within pre-agreement landing page and details to be shown within agreement document.
PATH PARAMETERS
organization name
bundled product identifier
OK CommercialInfo
[
{
"id": "109ES1DESCRIPTION",
"commercial_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>",
"language": "ES",
"invoice_name": "Tarifa Cero Prepago 150min+700mb",
"invoice_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
commercial_description | string | |||
language | string | |||
invoice_name | string | |||
invoice_description | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/commercial_infos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of commercial info related to a bundled commercial product id, applicable when the commercial product is sold within a bundled product. Commercial Info are currently used for configuring details to be shown within pre-agreement landing page and details to be shown within agreement document.
PATH PARAMETERS
organization name
bundled commercial product identifier
OK CommercialInfo
[
{
"id": "109ES1DESCRIPTION",
"commercial_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>",
"language": "ES",
"invoice_name": "Tarifa Cero Prepago 150min+700mb",
"invoice_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
commercial_description | string | |||
language | string | |||
invoice_name | string | |||
invoice_description | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/commercial_infos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of commercial info related to a free units package. Commercial Info are currently used for configuring details to be shown within pre-agreement landing page and details to be shown within agreement document.
PATH PARAMETERS
organization name
free units package identifier
OK CommercialInfo
[
{
"id": "109ES1DESCRIPTION",
"commercial_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>",
"language": "ES",
"invoice_name": "Tarifa Cero Prepago 150min+700mb",
"invoice_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
commercial_description | string | |||
language | string | |||
invoice_name | string | |||
invoice_description | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/free_units_packages/145/commercial_infos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of commercial info related to a promotion. Commercial Info are currently used for configuring details to be shown within pre-agreement landing page and details to be shown within agreement document.
PATH PARAMETERS
organization name
promotion identifier
OK CommercialInfo
[
{
"id": "109ES1DESCRIPTION",
"commercial_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>",
"language": "ES",
"invoice_name": "Tarifa Cero Prepago 150min+700mb",
"invoice_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
commercial_description | string | |||
language | string | |||
invoice_name | string | |||
invoice_description | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/promotions/234/commercial_infos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns an array of commercial info related to a value added service. Commercial Info are currently used for configuring details to be shown within pre-agreement landing page and details to be shown within agreement document.
PATH PARAMETERS
organization name
value added service identifier
OK CommercialInfo
[
{
"id": "109ES1DESCRIPTION",
"commercial_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>",
"language": "ES",
"invoice_name": "Tarifa Cero Prepago 150min+700mb",
"invoice_description": "<strong>Tarifa Cero Prepago 150min+700mb</strong>"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
commercial_description | string | |||
language | string | |||
invoice_name | string | |||
invoice_description | string |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/commercial_infos' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'This service returns an array with all the transaction types defined
PATH PARAMETERS
organization name
OK List of transaction_types
[
{
"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"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
description | string | |||
is_active | boolean | |||
is_external | boolean | indicates if the fee/term/promotion value is own (MM) or external (third-party) | ||
tax_rate | string | indicates the tax applied to the fee/term/promotion value | ||
transaction_type | string | |||
refund_transaction_type_id | string | id of the transaction type used for refund transactions |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/transaction_types' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'This service returns the information for a particular transaction type
PATH PARAMETERS
organization name
transaction type identifier
OK 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"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
description | string | |||
is_active | boolean | |||
is_external | boolean | indicates if the fee/term/promotion value is own (MM) or external (third-party) | ||
tax_rate | string | indicates the tax applied to the fee/term/promotion value | ||
transaction_type | string | |||
refund_transaction_type_id | string | id of the transaction type used for refund transactions |
Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/transaction_types/232' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list with all the devices related to the organization specified
PATH PARAMETERS
organization name
QUERY PARAMETERS
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
optional field to filter by category web
optional field to filter by category group, each category group consists of at least one category web
HEADER PARAMETERS
Flag to indicate the text language, relies on ISO-639-1
OK OK
[
{
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"category_web": "LAPTOP",
"model_web": "ALCATEL 1S",
"colour_name": "Midnight",
"hexadecimal_colour": "#FF0000",
"brand_colour": true,
"specifications": "256GB / 6,1' / 5G 128GB / 6,2'",
"control_app": false,
"battery": "1530 mAh",
"bluetooth_version": "5.0",
"frontal_camera": "1 MP cámara recesiva",
"back_camera": "1,3 MP",
"storage": "2L",
"wireless_charging": false,
"fast_charge": false,
"fast_charge_speed": "20W",
"box_content": "Cargador Auriculares Fundas",
"telecare_compatible": false,
"connectivity": "WIFI y Bluetooth 5.0",
"control_voice_assitant": false,
"dimensions": "243,2 x 162,2 x 9,55 mm",
"hard_drive": "256 GB",
"dual_sim": false,
"battery_duration": "Hasta 5 h de música; hasta 3 h en conversación; más de 24 h de música con el estuche de carga ",
"esim": false,
"flash": false,
"functions": "Peso, BMI, grasa corporal, masa muscular, agua, proteína, grasa visceral, metabolismo basal, masa ósea, edad física, peso ideal, tipo de cuerpo y puntuación de salud",
"touch_id": false,
"max_speed": "25 km/h",
"memory": "128 MB",
"memory_expandable_to": "32GB (MicroSD)",
"ram_memory": "128 MB",
"microphone": true,
"nfc": true,
"user_number": "Hasta 16",
"mapping_allowed": false,
"weight": "200 g",
"power": "20W",
"gaming_capabilities": "HDR GiG, ALLM, Cloud Gaming Stadia y GeForce",
"processor": "Procesador Inteligente α5 AI Processor 4K Gen6",
"ports": "1 x HDMI, 1 x USB - C, 1 x USB 3.0, 2 x USB 2.0",
"weight_range": "100 g - 150 kg",
"network": "5G",
"system_requirements": "iPad Pro de 11 pulgadas (1.ª, 2.ª o 3.ª generación) o iPad Air (4.ª generación) con iPadOS 14.5 o posterior",
"water_resistant": false,
"resolution": "HDR",
"output": "2 HDMI y 1 USB",
"noise_cancelling": false,
"sensors": "Acelerómetro de 3 ejes, giroscopio de 3 ejes y sensor de frecuencia cardíaca PPG",
"digital_tuner": "DVB-T2C",
"os": "Android 10",
"sound": "AI Sound (Virtual 5.1 Up-mix)",
"size": "M",
"screen_size": "1,47\"",
"technology": "4G LTE",
"battery_charge_time": "90 min (auricular) – 120 min (estuche con cable, sin los auriculares)",
"hard_drive_type": "SSD",
"sim_type": "Nano SIM + MicroSD",
"download_speed": "Descarga inalámbrica hasta 550 Mbps; 1 Gbps si es con cable",
"wifi": "Wi-Fi 802.11a/b/g/n/ac/ax",
"comments": "Además de ser ultra ligero y fino, cuenta con 8GB de RAM, para que ejecutes tanto tus juegos, como la multitarea de forma eficiente, con un aumento del rendimiento gracias a su mayor ancho de banda. Todo esto, con el sistema operativo Windows 11 Home 64. Gracias a su pantalla de 15,6” FHD proporciona una imagen detallada, clarísima y con los colores más vivos que nunca. Su disco duro SSD tiene una capacidad de 256 GB por lo que podrás guardar infinidad de archivos sin preocuparte por el espacio.",
"promotional_info": {
"trade_in_description": "Trade-in 200€: Desde el 11 de julio de 2024 hasta el 30 de marzo 2025. Más info disponible en timón.",
"trade_in_value": 100,
"additional_info": "Como promoción durante el periodo de preventa, los clientes podrán adquirir un smartphone de rango más alto de memoria por el mismo precio que uno de gama baja."
},
"energy_label": "B",
"esim_only": false,
"ean_code": "1234567890123",
"category_group": "MOBILE",
"reverse_logistic_method": "POST_OFFICE",
"charger_included": true,
"charger_label": "USB-C 25W"
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||
generic_code | string | |||||||||||||||||||||||
brand | string | |||||||||||||||||||||||
model | string | |||||||||||||||||||||||
name | string | |||||||||||||||||||||||
description | string | |||||||||||||||||||||||
category | string | |||||||||||||||||||||||
colour | string | |||||||||||||||||||||||
is_available | boolean | based on this attribute we know if a device is active or not | ||||||||||||||||||||||
include_preinstalled_sim | boolean | if the device has a built-in sim card | ||||||||||||||||||||||
image_url | string (url) | null | url to device image | ||||||||||||||||||||||
category_web | string | |||||||||||||||||||||||
model_web | string | |||||||||||||||||||||||
colour_name | string | |||||||||||||||||||||||
hexadecimal_colour | string | |||||||||||||||||||||||
brand_colour | boolean | |||||||||||||||||||||||
specifications | string | |||||||||||||||||||||||
control_app | boolean | |||||||||||||||||||||||
battery | string | |||||||||||||||||||||||
bluetooth_version | string | |||||||||||||||||||||||
frontal_camera | string | |||||||||||||||||||||||
back_camera | string | |||||||||||||||||||||||
storage | string | |||||||||||||||||||||||
wireless_charging | boolean | |||||||||||||||||||||||
fast_charge | boolean | |||||||||||||||||||||||
fast_charge_speed | string | |||||||||||||||||||||||
box_content | string | |||||||||||||||||||||||
telecare_compatible | boolean | |||||||||||||||||||||||
connectivity | string | |||||||||||||||||||||||
control_voice_assitant | boolean | |||||||||||||||||||||||
dimensions | string | |||||||||||||||||||||||
hard_drive | string | |||||||||||||||||||||||
dual_sim | boolean | |||||||||||||||||||||||
battery_duration | string | |||||||||||||||||||||||
esim | boolean | |||||||||||||||||||||||
flash | boolean | |||||||||||||||||||||||
functions | string | |||||||||||||||||||||||
touch_id | boolean | |||||||||||||||||||||||
max_speed | string | |||||||||||||||||||||||
memory | string | |||||||||||||||||||||||
memory_expandable_to | string | |||||||||||||||||||||||
ram_memory | string | |||||||||||||||||||||||
microphone | boolean | |||||||||||||||||||||||
nfc | boolean | |||||||||||||||||||||||
user_number | string | |||||||||||||||||||||||
mapping_allowed | boolean | |||||||||||||||||||||||
weight | string | |||||||||||||||||||||||
power | string | |||||||||||||||||||||||
gaming_capabilities | string | |||||||||||||||||||||||
processor | string | |||||||||||||||||||||||
ports | string | |||||||||||||||||||||||
weight_range | string | |||||||||||||||||||||||
network | string | |||||||||||||||||||||||
system_requirements | string | |||||||||||||||||||||||
water_resistant | boolean | |||||||||||||||||||||||
resolution | string | |||||||||||||||||||||||
output | string | |||||||||||||||||||||||
noise_cancelling | boolean | |||||||||||||||||||||||
sensors | string | |||||||||||||||||||||||
digital_tuner | string | |||||||||||||||||||||||
os | string | |||||||||||||||||||||||
sound | string | |||||||||||||||||||||||
size | string | |||||||||||||||||||||||
screen_size | string | |||||||||||||||||||||||
technology | string | |||||||||||||||||||||||
battery_charge_time | string | |||||||||||||||||||||||
hard_drive_type | string | |||||||||||||||||||||||
sim_type | string | |||||||||||||||||||||||
download_speed | string | |||||||||||||||||||||||
wifi | string | |||||||||||||||||||||||
comments | string | |||||||||||||||||||||||
promotional_info | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
energy_label | string | |||||||||||||||||||||||
esim_only | boolean | |||||||||||||||||||||||
ean_code | string | |||||||||||||||||||||||
category_group | string | |||||||||||||||||||||||
reverse_logistic_method | string | Indicates the method to return a device in case of withdrawal. POST_OFFICE means the customer must bring the device to a post office, HOME_PICKUP means a courier will pick up the device at home. | ||||||||||||||||||||||
charger_included | boolean | Indicates whether a charger is included in the device box. Required by EU Directive 2022/2380 on common chargers (legal obligation). | ||||||||||||||||||||||
charger_label | string | Descriptive label of the charger type or standard associated with the device (e.g. USB-C 25W). Required by EU Directive 2022/2380 on common chargers (legal obligation). | ||||||||||||||||||||||
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
Content-Languageunknowncurl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/devices?device_brand=SAMSUNG&generic_code=P062P63' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept-Language: es' \
-H 'Accept: application/json'Get a list with all the sellable devices related to the organization specified
PATH PARAMETERS
organization name
QUERY PARAMETERS
commercial profile name
optional field to filter by device category
optional field to filter by device brand
optional field to filter by generic code device
optional field to filter by category web
optional field to filter by category group, each category group consists of at least one category web
HEADER PARAMETERS
Flag to indicate the text language, relies on ISO-639-1
OK OK
[
{
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"category_web": "LAPTOP",
"model_web": "ALCATEL 1S",
"colour_name": "Midnight",
"hexadecimal_colour": "#FF0000",
"brand_colour": true,
"specifications": "256GB / 6,1' / 5G 128GB / 6,2'",
"control_app": false,
"battery": "1530 mAh",
"bluetooth_version": "5.0",
"frontal_camera": "1 MP cámara recesiva",
"back_camera": "1,3 MP",
"storage": "2L",
"wireless_charging": false,
"fast_charge": false,
"fast_charge_speed": "20W",
"box_content": "Cargador Auriculares Fundas",
"telecare_compatible": false,
"connectivity": "WIFI y Bluetooth 5.0",
"control_voice_assitant": false,
"dimensions": "243,2 x 162,2 x 9,55 mm",
"hard_drive": "256 GB",
"dual_sim": false,
"battery_duration": "Hasta 5 h de música; hasta 3 h en conversación; más de 24 h de música con el estuche de carga ",
"esim": false,
"flash": false,
"functions": "Peso, BMI, grasa corporal, masa muscular, agua, proteína, grasa visceral, metabolismo basal, masa ósea, edad física, peso ideal, tipo de cuerpo y puntuación de salud",
"touch_id": false,
"max_speed": "25 km/h",
"memory": "128 MB",
"memory_expandable_to": "32GB (MicroSD)",
"ram_memory": "128 MB",
"microphone": true,
"nfc": true,
"user_number": "Hasta 16",
"mapping_allowed": false,
"weight": "200 g",
"power": "20W",
"gaming_capabilities": "HDR GiG, ALLM, Cloud Gaming Stadia y GeForce",
"processor": "Procesador Inteligente α5 AI Processor 4K Gen6",
"ports": "1 x HDMI, 1 x USB - C, 1 x USB 3.0, 2 x USB 2.0",
"weight_range": "100 g - 150 kg",
"network": "5G",
"system_requirements": "iPad Pro de 11 pulgadas (1.ª, 2.ª o 3.ª generación) o iPad Air (4.ª generación) con iPadOS 14.5 o posterior",
"water_resistant": false,
"resolution": "HDR",
"output": "2 HDMI y 1 USB",
"noise_cancelling": false,
"sensors": "Acelerómetro de 3 ejes, giroscopio de 3 ejes y sensor de frecuencia cardíaca PPG",
"digital_tuner": "DVB-T2C",
"os": "Android 10",
"sound": "AI Sound (Virtual 5.1 Up-mix)",
"size": "M",
"screen_size": "1,47\"",
"technology": "4G LTE",
"battery_charge_time": "90 min (auricular) – 120 min (estuche con cable, sin los auriculares)",
"hard_drive_type": "SSD",
"sim_type": "Nano SIM + MicroSD",
"download_speed": "Descarga inalámbrica hasta 550 Mbps; 1 Gbps si es con cable",
"wifi": "Wi-Fi 802.11a/b/g/n/ac/ax",
"comments": "Además de ser ultra ligero y fino, cuenta con 8GB de RAM, para que ejecutes tanto tus juegos, como la multitarea de forma eficiente, con un aumento del rendimiento gracias a su mayor ancho de banda. Todo esto, con el sistema operativo Windows 11 Home 64. Gracias a su pantalla de 15,6” FHD proporciona una imagen detallada, clarísima y con los colores más vivos que nunca. Su disco duro SSD tiene una capacidad de 256 GB por lo que podrás guardar infinidad de archivos sin preocuparte por el espacio.",
"promotional_info": {
"trade_in_description": "Trade-in 200€: Desde el 11 de julio de 2024 hasta el 30 de marzo 2025. Más info disponible en timón.",
"trade_in_value": 100,
"additional_info": "Como promoción durante el periodo de preventa, los clientes podrán adquirir un smartphone de rango más alto de memoria por el mismo precio que uno de gama baja."
},
"energy_label": "B",
"esim_only": false,
"ean_code": "1234567890123",
"category_group": "MOBILE",
"reverse_logistic_method": "POST_OFFICE",
"charger_included": true,
"charger_label": "USB-C 25W"
}
]| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||
generic_code | string | |||||||||||||||||||||||
brand | string | |||||||||||||||||||||||
model | string | |||||||||||||||||||||||
name | string | |||||||||||||||||||||||
description | string | |||||||||||||||||||||||
category | string | |||||||||||||||||||||||
colour | string | |||||||||||||||||||||||
is_available | boolean | based on this attribute we know if a device is active or not | ||||||||||||||||||||||
include_preinstalled_sim | boolean | if the device has a built-in sim card | ||||||||||||||||||||||
image_url | string (url) | null | url to device image | ||||||||||||||||||||||
category_web | string | |||||||||||||||||||||||
model_web | string | |||||||||||||||||||||||
colour_name | string | |||||||||||||||||||||||
hexadecimal_colour | string | |||||||||||||||||||||||
brand_colour | boolean | |||||||||||||||||||||||
specifications | string | |||||||||||||||||||||||
control_app | boolean | |||||||||||||||||||||||
battery | string | |||||||||||||||||||||||
bluetooth_version | string | |||||||||||||||||||||||
frontal_camera | string | |||||||||||||||||||||||
back_camera | string | |||||||||||||||||||||||
storage | string | |||||||||||||||||||||||
wireless_charging | boolean | |||||||||||||||||||||||
fast_charge | boolean | |||||||||||||||||||||||
fast_charge_speed | string | |||||||||||||||||||||||
box_content | string | |||||||||||||||||||||||
telecare_compatible | boolean | |||||||||||||||||||||||
connectivity | string | |||||||||||||||||||||||
control_voice_assitant | boolean | |||||||||||||||||||||||
dimensions | string | |||||||||||||||||||||||
hard_drive | string | |||||||||||||||||||||||
dual_sim | boolean | |||||||||||||||||||||||
battery_duration | string | |||||||||||||||||||||||
esim | boolean | |||||||||||||||||||||||
flash | boolean | |||||||||||||||||||||||
functions | string | |||||||||||||||||||||||
touch_id | boolean | |||||||||||||||||||||||
max_speed | string | |||||||||||||||||||||||
memory | string | |||||||||||||||||||||||
memory_expandable_to | string | |||||||||||||||||||||||
ram_memory | string | |||||||||||||||||||||||
microphone | boolean | |||||||||||||||||||||||
nfc | boolean | |||||||||||||||||||||||
user_number | string | |||||||||||||||||||||||
mapping_allowed | boolean | |||||||||||||||||||||||
weight | string | |||||||||||||||||||||||
power | string | |||||||||||||||||||||||
gaming_capabilities | string | |||||||||||||||||||||||
processor | string | |||||||||||||||||||||||
ports | string | |||||||||||||||||||||||
weight_range | string | |||||||||||||||||||||||
network | string | |||||||||||||||||||||||
system_requirements | string | |||||||||||||||||||||||
water_resistant | boolean | |||||||||||||||||||||||
resolution | string | |||||||||||||||||||||||
output | string | |||||||||||||||||||||||
noise_cancelling | boolean | |||||||||||||||||||||||
sensors | string | |||||||||||||||||||||||
digital_tuner | string | |||||||||||||||||||||||
os | string | |||||||||||||||||||||||
sound | string | |||||||||||||||||||||||
size | string | |||||||||||||||||||||||
screen_size | string | |||||||||||||||||||||||
technology | string | |||||||||||||||||||||||
battery_charge_time | string | |||||||||||||||||||||||
hard_drive_type | string | |||||||||||||||||||||||
sim_type | string | |||||||||||||||||||||||
download_speed | string | |||||||||||||||||||||||
wifi | string | |||||||||||||||||||||||
comments | string | |||||||||||||||||||||||
promotional_info | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
energy_label | string | |||||||||||||||||||||||
esim_only | boolean | |||||||||||||||||||||||
ean_code | string | |||||||||||||||||||||||
category_group | string | |||||||||||||||||||||||
reverse_logistic_method | string | Indicates the method to return a device in case of withdrawal. POST_OFFICE means the customer must bring the device to a post office, HOME_PICKUP means a courier will pick up the device at home. | ||||||||||||||||||||||
charger_included | boolean | Indicates whether a charger is included in the device box. Required by EU Directive 2022/2380 on common chargers (legal obligation). | ||||||||||||||||||||||
charger_label | string | Descriptive label of the charger type or standard associated with the device (e.g. USB-C 25W). Required by EU Directive 2022/2380 on common chargers (legal obligation). | ||||||||||||||||||||||
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
Content-Languageunknowncurl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/devices/sellable?commercial_profile_name=perfil_comercial.postpago_ventas_pos&device_brand=SAMSUNG&generic_code=P062P63' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept-Language: es' \
-H 'Accept: application/json'Get a list with all the information of devices related with the {org_id} specified
PATH PARAMETERS
organization name
device identifier
HEADER PARAMETERS
Flag to indicate the text language, relies on ISO-639-1
OK OK
{
"id": "P045A1SNC",
"generic_code": "P045A1S",
"brand": "ALCATEL",
"model": "ALCATEL 1S NEGRO",
"name": "ALCATEL 1S NEGRO",
"description": "string",
"category": "SMARTPHONE",
"colour": "NEGRO",
"is_available": true,
"include_preinstalled_sim": false,
"image_url": "https://cdn.masmovil.com/Resources/broadband-phones/deviceid/deviceid.png",
"category_web": "LAPTOP",
"model_web": "ALCATEL 1S",
"colour_name": "Midnight",
"hexadecimal_colour": "#FF0000",
"brand_colour": true,
"specifications": "256GB / 6,1' / 5G 128GB / 6,2'",
"control_app": false,
"battery": "1530 mAh",
"bluetooth_version": "5.0",
"frontal_camera": "1 MP cámara recesiva",
"back_camera": "1,3 MP",
"storage": "2L",
"wireless_charging": false,
"fast_charge": false,
"fast_charge_speed": "20W",
"box_content": "Cargador Auriculares Fundas",
"telecare_compatible": false,
"connectivity": "WIFI y Bluetooth 5.0",
"control_voice_assitant": false,
"dimensions": "243,2 x 162,2 x 9,55 mm",
"hard_drive": "256 GB",
"dual_sim": false,
"battery_duration": "Hasta 5 h de música; hasta 3 h en conversación; más de 24 h de música con el estuche de carga ",
"esim": false,
"flash": false,
"functions": "Peso, BMI, grasa corporal, masa muscular, agua, proteína, grasa visceral, metabolismo basal, masa ósea, edad física, peso ideal, tipo de cuerpo y puntuación de salud",
"touch_id": false,
"max_speed": "25 km/h",
"memory": "128 MB",
"memory_expandable_to": "32GB (MicroSD)",
"ram_memory": "128 MB",
"microphone": true,
"nfc": true,
"user_number": "Hasta 16",
"mapping_allowed": false,
"weight": "200 g",
"power": "20W",
"gaming_capabilities": "HDR GiG, ALLM, Cloud Gaming Stadia y GeForce",
"processor": "Procesador Inteligente α5 AI Processor 4K Gen6",
"ports": "1 x HDMI, 1 x USB - C, 1 x USB 3.0, 2 x USB 2.0",
"weight_range": "100 g - 150 kg",
"network": "5G",
"system_requirements": "iPad Pro de 11 pulgadas (1.ª, 2.ª o 3.ª generación) o iPad Air (4.ª generación) con iPadOS 14.5 o posterior",
"water_resistant": false,
"resolution": "HDR",
"output": "2 HDMI y 1 USB",
"noise_cancelling": false,
"sensors": "Acelerómetro de 3 ejes, giroscopio de 3 ejes y sensor de frecuencia cardíaca PPG",
"digital_tuner": "DVB-T2C",
"os": "Android 10",
"sound": "AI Sound (Virtual 5.1 Up-mix)",
"size": "M",
"screen_size": "1,47\"",
"technology": "4G LTE",
"battery_charge_time": "90 min (auricular) – 120 min (estuche con cable, sin los auriculares)",
"hard_drive_type": "SSD",
"sim_type": "Nano SIM + MicroSD",
"download_speed": "Descarga inalámbrica hasta 550 Mbps; 1 Gbps si es con cable",
"wifi": "Wi-Fi 802.11a/b/g/n/ac/ax",
"comments": "Además de ser ultra ligero y fino, cuenta con 8GB de RAM, para que ejecutes tanto tus juegos, como la multitarea de forma eficiente, con un aumento del rendimiento gracias a su mayor ancho de banda. Todo esto, con el sistema operativo Windows 11 Home 64. Gracias a su pantalla de 15,6” FHD proporciona una imagen detallada, clarísima y con los colores más vivos que nunca. Su disco duro SSD tiene una capacidad de 256 GB por lo que podrás guardar infinidad de archivos sin preocuparte por el espacio.",
"promotional_info": {
"trade_in_description": "Trade-in 200€: Desde el 11 de julio de 2024 hasta el 30 de marzo 2025. Más info disponible en timón.",
"trade_in_value": 100,
"additional_info": "Como promoción durante el periodo de preventa, los clientes podrán adquirir un smartphone de rango más alto de memoria por el mismo precio que uno de gama baja."
},
"energy_label": "B",
"esim_only": false,
"ean_code": "1234567890123",
"category_group": "MOBILE",
"reverse_logistic_method": "POST_OFFICE",
"charger_included": true,
"charger_label": "USB-C 25W"
}| Property | Type | Description | Constraints | Default | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | |||||||||||||||||||||||
generic_code | string | |||||||||||||||||||||||
brand | string | |||||||||||||||||||||||
model | string | |||||||||||||||||||||||
name | string | |||||||||||||||||||||||
description | string | |||||||||||||||||||||||
category | string | |||||||||||||||||||||||
colour | string | |||||||||||||||||||||||
is_available | boolean | based on this attribute we know if a device is active or not | ||||||||||||||||||||||
include_preinstalled_sim | boolean | if the device has a built-in sim card | ||||||||||||||||||||||
image_url | string (url) | null | url to device image | ||||||||||||||||||||||
category_web | string | |||||||||||||||||||||||
model_web | string | |||||||||||||||||||||||
colour_name | string | |||||||||||||||||||||||
hexadecimal_colour | string | |||||||||||||||||||||||
brand_colour | boolean | |||||||||||||||||||||||
specifications | string | |||||||||||||||||||||||
control_app | boolean | |||||||||||||||||||||||
battery | string | |||||||||||||||||||||||
bluetooth_version | string | |||||||||||||||||||||||
frontal_camera | string | |||||||||||||||||||||||
back_camera | string | |||||||||||||||||||||||
storage | string | |||||||||||||||||||||||
wireless_charging | boolean | |||||||||||||||||||||||
fast_charge | boolean | |||||||||||||||||||||||
fast_charge_speed | string | |||||||||||||||||||||||
box_content | string | |||||||||||||||||||||||
telecare_compatible | boolean | |||||||||||||||||||||||
connectivity | string | |||||||||||||||||||||||
control_voice_assitant | boolean | |||||||||||||||||||||||
dimensions | string | |||||||||||||||||||||||
hard_drive | string | |||||||||||||||||||||||
dual_sim | boolean | |||||||||||||||||||||||
battery_duration | string | |||||||||||||||||||||||
esim | boolean | |||||||||||||||||||||||
flash | boolean | |||||||||||||||||||||||
functions | string | |||||||||||||||||||||||
touch_id | boolean | |||||||||||||||||||||||
max_speed | string | |||||||||||||||||||||||
memory | string | |||||||||||||||||||||||
memory_expandable_to | string | |||||||||||||||||||||||
ram_memory | string | |||||||||||||||||||||||
microphone | boolean | |||||||||||||||||||||||
nfc | boolean | |||||||||||||||||||||||
user_number | string | |||||||||||||||||||||||
mapping_allowed | boolean | |||||||||||||||||||||||
weight | string | |||||||||||||||||||||||
power | string | |||||||||||||||||||||||
gaming_capabilities | string | |||||||||||||||||||||||
processor | string | |||||||||||||||||||||||
ports | string | |||||||||||||||||||||||
weight_range | string | |||||||||||||||||||||||
network | string | |||||||||||||||||||||||
system_requirements | string | |||||||||||||||||||||||
water_resistant | boolean | |||||||||||||||||||||||
resolution | string | |||||||||||||||||||||||
output | string | |||||||||||||||||||||||
noise_cancelling | boolean | |||||||||||||||||||||||
sensors | string | |||||||||||||||||||||||
digital_tuner | string | |||||||||||||||||||||||
os | string | |||||||||||||||||||||||
sound | string | |||||||||||||||||||||||
size | string | |||||||||||||||||||||||
screen_size | string | |||||||||||||||||||||||
technology | string | |||||||||||||||||||||||
battery_charge_time | string | |||||||||||||||||||||||
hard_drive_type | string | |||||||||||||||||||||||
sim_type | string | |||||||||||||||||||||||
download_speed | string | |||||||||||||||||||||||
wifi | string | |||||||||||||||||||||||
comments | string | |||||||||||||||||||||||
promotional_info | object | |||||||||||||||||||||||
| ||||||||||||||||||||||||
energy_label | string | |||||||||||||||||||||||
esim_only | boolean | |||||||||||||||||||||||
ean_code | string | |||||||||||||||||||||||
category_group | string | |||||||||||||||||||||||
reverse_logistic_method | string | Indicates the method to return a device in case of withdrawal. POST_OFFICE means the customer must bring the device to a post office, HOME_PICKUP means a courier will pick up the device at home. | ||||||||||||||||||||||
charger_included | boolean | Indicates whether a charger is included in the device box. Required by EU Directive 2022/2380 on common chargers (legal obligation). | ||||||||||||||||||||||
charger_label | string | Descriptive label of the charger type or standard associated with the device (e.g. USB-C 25W). Required by EU Directive 2022/2380 on common chargers (legal obligation). | ||||||||||||||||||||||
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
Content-Languageunknowncurl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/devices/P045A1SNC' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept-Language: es' \
-H 'Accept: application/json'Get a list with all the commercial profiles related with the {org_id} specified
PATH PARAMETERS
organization name
QUERY PARAMETERS
visibility type
OK OK
[
{
"id": 4,
"name": "perfil_comercial.postpago_ventas_pos",
"visibility_type": "POSITIVE"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
visibility_type | string |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of commercial products availables for a particular commercial profile and tenant
PATH PARAMETERS
organization name
commercial profile id
OK OK
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_commercial_product_id": "770",
"data_sharing_compatible": true,
"penalty_reference": 6.9043,
"min_devices": 1,
"max_devices": 1,
"max_concurrent_views": 2,
"insurance_type": "GLOBAL",
"from": "2022-10-03T22:00:00Z",
"to": "2080-10-03T22:00:00Z"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
marketing_name | string | |||
digital_channels_name | string | name used within digital channels | ||
invoice_name | string | |||
invoice_description | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
mysim_commercial_product_id | string | internal id used within MySim | ||
data_sharing_compatible | boolean | |||
penalty_reference | number (double) | it is the reference price of the fee to take in account when a penalty is applied to the terminal | ||
min_devices | integer | Minimum number of devices that must be purchased for this tariff. | ||
max_devices | integer | Maximum number of devices that can be purchased for this tariff. | ||
max_concurrent_views | integer | Maximum number of concurrent views allowed for the TV tariff. | ||
insurance_type | string | Type of insurance product. Possible values: - GLOBAL - MULTIMEDIA - null: When CommercialProduct is not a Zurich insurance tariff | ||
from | string (date-time) | date when the commercial product starts to be included within the commercial profile | ||
to | string (date-time) | date when the commercial product starts to be included within the commercial profile |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/commercial_products' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of free units packages availables for a particular commercial profile and tenant
PATH PARAMETERS
organization name
commercial profile id
OK OK
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"mysim_free_units_package_id": "469",
"unit_amount": 10737418240,
"volume_home_sl0": 10737418240,
"volume_home_sl1": 10737418240,
"volume_rlah_sl0": 10737418240,
"volume_rlah_sl1": 10737418240,
"volume_nr_sl0": 10737418240,
"volume_nr_sl1": 10737418240,
"unlimited": false,
"max_grants": 0,
"is_recurring_package": true,
"applicability_priority": 1,
"used_for_policy_rule_change": false,
"sharing_compatible": true,
"from": "2022-10-03T22:00:00Z",
"to": "2080-10-03T22:00:00Z"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
marketing_name | string | |||
digital_channels_name | string | name used within digital channels | ||
invoice_name | string | |||
invoice_description | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
mysim_free_units_package_id | string | internal id used within Mysim, null for 'dummy' unlimited voice free units packages | ||
unit_amount | number (int64) | 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) | Data volume in bytes navigable at maximum speed | ||
volume_home_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) | ||
volume_rlah_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with roaming like at home | ||
volume_rlah_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with roaming like at home | ||
volume_nr_sl0 | number (int64) | Data volume in bytes navigable at maximum speed with national roaming | ||
volume_nr_sl1 | number (int64) | Data volume in bytes navigable at intermediate speed level (3 Mbps) with national roaming | ||
unlimited | boolean | indicates if the free units is sold as an unlimited package | ||
max_grants | number (int32) | 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 | indicates if the free units package is a periodical package. Currently, if it is periodical, monthly schedule will be assigned | ||
applicability_priority | number (int32) | priority of the free units package when consuming | ||
used_for_policy_rule_change | boolean | indicates if the free units package is used for policy rules changes (for changing the download speed when limits are reached) | ||
sharing_compatible | boolean | |||
from | string (date-time) | date when the free units package starts to be included within the commercial profile | ||
to | string (date-time) | date when the free units package starts to be included within the commercial profile |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/free_units_packages' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of promotions availables for a particular commercial profile and tenant
PATH PARAMETERS
organization name
commercial profile id
OK OK
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"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
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
marketing_name | string | |||
digital_channels_name | string | name used within digital channels | ||
invoice_name | string | |||
invoice_description | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
need_promotion_code | boolean | boolean to indicate if the promotion requires capturing a code for being applied | ||
need_existent_MSISDN | boolean | boolean to indicate if the promotion requires an existent MSISDN (i,e for M2M campaign) | ||
applicability_model | string | it defines how the promotion is applied in terms of calculation phase and application model. FeeGeneraton (for promotions that should be applied when generating one time or recurring fees), Billing (for promotions that should be applied during billing phase), | ||
restrictions_applicability_rule | string | rule used for obtaining the discount value (% value or fixed value) or top-up amount to be applied. Not used currently because the discount value (% value or fixed value) is fixed, not dependent on restrictions | ||
target_applicability_rule | string | rule used for determining the charges on which the discount is applied. PreviousInvoiceTotalAmount (used for Billing discounts that must be applied to the previous invoice total amount), CurrentInvoiceTotalAmount (used for Billing discounts that must be applied to the current invoice total amount), FeeSubtype (discounts that must be applied to fees with specific subtype) | ||
fee_subtypes | string | used for promotions with targetApplicabilityRule = FeeSubType, for indicating fee subtypes to which the promotion must be applied | ||
calculation_model | string | used for obtaining the discount % value/fixed value/top-up amount to be applied. Flat (fixed %/fixed discount value/top-up amount), Bulk (%/fixed discount value/top-up amount depends on the total amount of restrictions. Currently not used) | ||
discount_type | string | it defines if the discount value is a % or a fixed amount | ||
duration | number (int32) | promotion duration indicated in number of months | ||
unlimited_duration | boolean | Used to indicate if the promotion is valid for an unlimited period of time | ||
keep_on_upgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a higher cost | ||
keep_on_downgrade | boolean | used to indicate if the campaign is maintained when it is currently active and there is a product/bundled product migration to a product/bundled product which is also compatible with the promotion and which has a lower cost | ||
priority | number (int32) | promotion applicability priority (lower value = higher priority). Currently always 1 | ||
is_mandatory | boolean | |||
xsell_permit | boolean | |||
reduced_fee_amount | boolean | |||
value | number (double) | |||
currency | string | null for values associated to promotion with discountTYpe=percentage. euro for rest | ||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||
to | string (date-time) | date when the promotion starts to be included within the commercial profile | ||
skip_first_period | boolean | it indicates if the first period of billing is skipped | ||
reduce_penalty_threshold | boolean | it indicates if the reference value has to be decreased |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/promotions' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of bundled products availables for a particular commercial profile and tenant
PATH PARAMETERS
organization name
commercial profile id
OK OK
[
{
"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": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z",
"category": "string",
"category_id": "2",
"download_speed": "300",
"upload_speed": "300",
"from": "2022-10-03T22:00:00Z",
"to": "2080-10-03T22:00:00Z"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
marketing_name | string | |||
digital_channels_name | string | name used within digital channels | ||
bundled_segment | string | |||
invoice_name | string | |||
invoice_description | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) | |||
category | string | |||
category_id | string | |||
download_speed | string | 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 | used for filtering purpose within API consumers, fo bundled product with category (‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or 'Fixed+Broadband+Mobile+TV') and with technology = 2 (FTTH). Null for bundled products with category ((‘Fixed+Broadband' or ‘Fixed+Broadband+Mobile’ or 'Fixed+Broadband+Mobile+TV') and with technology = 1 (ADSL)) or bundled products with category ‘Fixed+Mobile’ | ||
from | string (date-time) | date when the promotion starts to be included within the commercial profile | ||
to | string (date-time) | date when the promotion starts to be included within the commercial profile |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/commercial_profiles/4/bundled_products' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of available subscription types
PATH PARAMETERS
organization name
OK OK
[
{
"name": "POST-PAGO",
"description": "ADSL",
"id": "5"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name | string | subscription type name | ||
description | string | subscription type description | ||
id | string | subscription type id |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/subs_types' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a particular subscription type
PATH PARAMETERS
organization name
subscription type identifier
OK OK
{
"name": "POST-PAGO",
"description": "ADSL",
"id": "5"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
name | string | subscription type name | ||
description | string | subscription type description | ||
id | string | subscription type id |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/subs_types/1' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a list of available territory owners
PATH PARAMETERS
organization name
OK OK
[
{
"id": "FIBMM02",
"name": "FIBRA PROPIA MM2",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z"
}
]| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/territory_owners' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Get a particular territory owner
PATH PARAMETERS
organization name
territory owner identifier
OK OK
{
"id": "FIBMM02",
"name": "FIBRA PROPIA MM2",
"in_catalogue_since": "2025-01-15T10:30:00Z",
"in_catalogue_until": "2025-01-15T10:30:00Z"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
id | string | |||
name | string | |||
in_catalogue_since | string (date-time) | |||
in_catalogue_until | string (date-time) |
Bad Request Bad request
"Bad Request"Unauthorized Unauthorized
"Origin authentication failed."Not Found Item not found
{
"error": "Item not found",
"message": "Item not found",
"code": "0200XX"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
error | string | |||
message | string | |||
code | string |
curl -X GET 'https://catalogue.masstack.com/v2/orgs/masmovil/territory_owners/FIBMM02' \
-H 'Authorization: Bearer {access-token}' \
-H 'Accept: application/json'Returns information about system status
OK The response for success health check
{
"status": "ok"
}| Property | Type | Description | Constraints | Default |
|---|---|---|---|---|
status | string |
curl -X GET 'https://catalogue.masstack.com/v2/health' \
-H 'Accept: application/json'