MasCatalogue API save_alt

Release Notes

• 2.86.0

  • Add new field refound_transaction_type_id to TransactionType schema

• 2.85.1

  • Fix wrong BillingType enum value: “PREPAGO AUTOMATICO” -> “RECARGA AUTOMATICA”

• 2.85.0

  • Define new endpoints to get promotion incompatibilities by commercial_product or bundled_commercial_product:
    • /orgs/{org_id}/commercial_products/{commercial_product_id}/promotions/{promotion_id}/incompatibilities
    • /orgs/{org_id}/bundled_commercial_products/{bcp_id}/promotions/{promotion_id}/incompatibilities

• 2.84.0

  • Add new field promotional_info to Device_Response schema

• 2.83.0

  • Add new subtype ExcessFee to Fee_Response schema

• 2.82.0

  • Update enum values of BundleCategory and SubsTypeName for ORANGE_TV_LIBRE

• 2.81.0

  • Add query param mandatory to endpoints:
    • /orgs/{org_id}/bundled_commercial_products/{id}/commercial_devices/sellable
    • /orgs/{org_id}/commercial_devices

• 2.80.0

  • Add store_delivery_allowed field in CommercialProfile schema

• 2.79.1

  • Fix ValueAddedServiceDetail and ValueAddedService schemas by adding max_quantity field and deprecating max_cardinality

• 2.79.0

  • Add TV subscription type
  • Add new fields in CommercialProduct schema:
    • max_devices
    • max_concurrent_views

• 2.78.0

  • Add permanence_type to Terms_alone_Response

• 2.77.0

  • Add new fields in FUP responses:
    • volume_home_sl0
    • volume_home_sl1
    • volume_rlah_sl0
    • volume_rlah_sl1
    • volume_nr_sl0
    • volume_nr_sl1

• 2.76.0

  • Add NOT_APPLICABLE to target_applicability_rule and applicability_model extensible enums

• 2.75.0

  • Add query param mysim_service_id to endpoints:
    • /orgs/{org_id}/commercial_products/{id}/value_added_services
    • /orgs/{org_id}/bundled_commercial_products/{id}/value_added_services

• 2.74.0

  • Add binding_type_id to TermsPromotion_Response

• 2.73.0

  • Remove designer endpoints.

• 2.72.0

  • Modify number formats in BundledProduct and FreeUnitsPackage schemas
  • Add type[in] and category[in] query params in GET /commercial_profiles/{commercial_profile_id}/free_units_packages endpoint

• 2.71.0

  • Add new endpoint GET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/free_units_packages

• 2.70.2

  • Remove FeeGeneration and add FeeSubtype from target_applicability_rule enum in getPromoByComProfile_Response schema
  • Remove FEE_GENERATION and add FEE_SUBTYPE from target_applicability_rule enum in Promotion schema

• 2.70.1

  • Rename provisioning_id as external_provisioning_id in CommercialProduct schema

• 2.70.0

  • Add endpoints for CRUD operations of promotion categories:
    • /orgs/{org_id}/designer/promotion_categories
    • /orgs/{org_id}/designer/promotion_category/{promotion_category_id}

• 2.69.0

  • Modify type of rate_plan and billing_type fields in CommercialProduct schema
  • Add provisioning_id, service_class, external_offer_id, external_charging_id and manual_renewal fields in CommercialProduct schema

• 2.68.0

  • Add base_profile query filters in GET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/commercial_products endpoint
  • Add promotion_category_name[in] and promotion_type_name[in] query filters in GET
/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/promotions endpoint
  • Add type[in] query filter in GET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/bundled_products endpoint

• 2.67.1

  • Remove prefix is_ on params of transaction_type schema

• 2.67.0

  • Add new endpoint GET /orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/bundled_products
  • Add BundledProductType, CustomerSegment, BillingType, Technology and SubscriptionType enums

• 2.66.2

  • Remove refound_transaction_type_id from fields required in transaction_types create

• 2.66.1

  • Remove iso_language from Promotion and CommercialProduct schemas

• 2.66.0

  • Adding new endpoints for CRUD operations of transaction types:
    • /orgs/{org_id}/designer/transaction_types
    • /orgs/{org_id}/designer/transaction_types/{transaction_type_id}

• 2.65.0

  • Add promotion_type_id and promotion_category_id query params in GET
/orgs/{org_id}/designer/commercial_profiles/{commercial_profile_id}/promotions endpoint

• 2.64.0

  • Add new endpoint /bundled_products/{bp_id}/bundled_commercial_products

• 2.63.1

  • Add 409 status code in response of POST 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}

• 2.63.0

  • Add endpoints for CRUD operations of free units package:
    • /orgs/{org_id}/designer/free_units_package
    • /orgs/{org_id}/designer/free_units_package/{free_units_package_id}

• 2.62.0

  • Adapting designer to masstack url convention

• 2.61.0

  • Deleting bundle_category_id and bundle_type_name from PromotionCanSwitchPromotion

• 2.60.0

  • Rename rate_plan_id field in CommercialProduct schema as rate_plan
  • Rename billing_type_id field in CommercialProduct schema as billing_type
  • Add endpoints for CRUD operations of bundled products:
    • /designer/orgs/{org_id}/bundled_products
    • /designer/orgs/{org_id}/bundled_products/{bundled_product_id}

• 2.59.0

  • Deleting unused endpoint promotions can-switch
    • /orgs/{org_id}/promotions/{existent_promotion_id}/can-switch/{new_promotion_id}

• 2.58.0

  • Include new SubsType value for Max subscriptions: MAX

• 2.57.5

  • Rename id[contains] query param to device_id[contains] for the /commercial_devices endpoint

• 2.57.4

  • Adding customer_type to Promotion schema
  • Adding customer_type query param in GET /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions endpoint

• 2.57.3

  • Update description of DELETE /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id} endpoint
  • Update description of DELETE /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id} endpoint
  • Update description of DELETE /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/commercial_products/{commercial_product_id}
    endpoint

• 2.57.2

  • Update description of DELETE /designer/orgs/{org_id}/sale_types/{sale_type_id} endpoint

• 2.57.1

  • Update description of DELETE /designer/orgs/{org_id}/promotion_types/{promotion_type_id} endpoint

• 2.57.0

  • Add endpoints for commercial products related to commercial profiles:
    • /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}

• 2.56.0

  • Rename PromotionRelatedRaw and PromotionRelatedRawList schemas as PromotionRelatedWithDatesRaw and PromotionRelatedWithDatesRawList
    respectively
  • Create PromotionSoldByCommercialProfileRawList and PromotionSoldByCommercialProfileRaw schemas

• 2.55.0

  • Adding category_name to getPromoByComProfile_Response

• 2.54.1

  • Change type of duration field in Promotion schema as integer
  • Rename term_id fields in Promotion schema as commitment_id and set as nullable
  • Remove external_market_id field from Promotion schema and added as field in PromotionRaw schema

• 2.54.0

  • Adding query params sort, deviceName, deviceModel and deviceColour for paginated commercial devices:
    • /orgs/{org_id}/commercial_devices

• 2.53.0

  • Adding new endpoints for CRUD operations of sale types:
    • /designer/orgs/{org_id}/sale_types
    • /designer/orgs/{org_id}/sale_types/{sale_type_id}

• 2.52.0

  • Adding new endpoints for CRUD operations of promotion types:
    • /designer/orgs/{org_id}/promotion_types
    • /designer/orgs/{org_id}/promotion_types/{promotion_type_id}

• 2.51.0

  • Add endpoint to get promotions sold by commercial profile:
    • GET /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions

• 2.50.0

  • Return 201 status code in response of endpoint:
    • POST /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id}

• 2.49.0

  • Add category_name to promotions response for endpoint:
    • /orgs/{org_id}/promotion/{id}

• 2.48.0

  • Add paginated endpoint for commercial devices /orgs/{org_id}/commercial_devices

• 2.47.0

  • Add endpoints for promotions related to commercial profiles:
    • /designer/orgs/{org_id}/promotions/{promotion_id}/commercial_profiles
    • /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}/promotions/{promotion_id}

• 2.46.0

  • Add penalty_reference field in the response of CommercialProduct

• 2.45.2

  • Add query params in GET /commercial_profiles enpoint:
    • name
    • start_date[gt]
    • start_date[gte]
    • start_date[lt]
    • start_date[lte]
    • end_date[gt]
    • end_date[gte]
    • end_date[lt]
    • end_date[lte]
  • Return CommercialProfileRawList schema in GET /commercial_profiles endpoint.

• 2.45.1

  • Change query parameter language_code to header parameter

• 2.45.0

  • Add reduce_penalty_threshold field in the response of Promotions

• 2.44.1

  • Add consolidated and updated_at fields in the response body of commercial profile by id.

• 2.44.0

  • Add skip_first_period field in the response body of Promotions

• 2.43.2

  • Add start_date and end_date fields in the response body of commercial profile getters.

• 2.43.1

  • Add start_date and end_date fields in the request body of commercial profile operations.

• 2.43.0

  • Adding bundled_type to bundled product schemas:
    • BundledProduct_Response
    • SwitchBundledProduct_Response
    • BundledProductBasic_Response
  • Endpoints affected:
    • /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}

• 2.42.2

  • Include new SubsType value for Amazon subscriptions: AMAZONPRIME.
  • Include missing property mysim_id in ValueAddedService schemas.

• 2.42.1

  • Remove wrong encoding in /designer/orgs/{org_id}/upload_file endpoint.

• 2.42.0

  • Add new query parameter language_code

• 2.41.1

  • Update /designer/orgs/{org_id}/download/{file_name} to return a ResponseBody

• 2.41.0

  • Removing values node from all responses

• 2.40.0

  • Adding new endpoints for CRUD operations of commercial profiles:
    • /designer/orgs/{org_id}/commercial_profiles
    • /designer/orgs/{org_id}/commercial_profiles/{commercial_profile_id}

• 2.39.2

  • Changed /designer/orgs/{org_id}/upload_file content from csv to multipart/form-data

• 2.39.1

  • Split swagger difinition into modules (one swagger file for each service)
  • Removing unused schemas: Tax and TaxValue
  • Removing ofc-manager API (it must be used through designer)
  • Refactoring several descriptions

• 2.39.0

  • Adding is_bundled to bundled commercial product schemas:
    • BundledCommercialProductBasic
    • BundledCommercialProductDetail
    • BundledCommercialProductCanSwitch
    • BundledCommercialProduct

• 2.38.0

  • Adding retail_price and discount properties to commercial device schemas CommercialDevice and CommercialDeviceAlone

• 2.37.0

  • Adding new endpoint to download file from storage
    • /designer/orgs/{org_id}/download/{fileName}

• 2.36.0

  • Adding new query param 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

• 2.35.0

  • Adding new endpoint to upload file to storage
    • /designer/orgs/{org_id}/upload_file

• 2.34.0

  • Adding used_for_automatic_orphan_subscription_change to BundledProductSubsTypeDetail and BundledProductSubsTypeBasic. Affected endpoints:
    • /orgs/{org_id}/bundled_products/{id}
    • /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types

• 2.33.0

  • Adding model_web property to device schema CommercialDevice_device_Response

• 2.32.0

  • Example added for endpoint (successful response with promotions) :
    • /orgs/{org_id}/commercial_devices/sellable

• 2.31.0

  • Add new optional query param permanence 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

• 2.30.0

  • Add promotions array to response endpoint : /orgs/{org_id}/commercial_devices/sellable
  • Add new LoadType mandatory_commercial_devices

• 2.29.0

  • Remove values array from endpoint : /orgs/{org_id}/commercial_devices/refinance

• 2.28.0

  • Remove mandatory query param commercial_profile_name for endpoint /orgs/{org_id}/devices

• 2.27.0

  • Including new query params for
    endpoint /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products
    • numeration_type_name
    • sale_type_name
    • commercial_profile_name
    • insured_amount
    • Including new query params for endpoint /orgs/{org_id}/commercial_products/{id}/free_units_packages
      • sale_type_name
    • Including new query params for endpoint /orgs/{org_id}/commercial_products/{id}/promotions
      • customer_type_name
      • sale_type_name
      • numeration_type_name
    • Including new query params for endpoint /orgs/{org_id}/bundled_commercial_products/{id}/promotions
      • customer_type_name
      • sale_type_name
      • numeration_type_name

• 2.26.0

  • Include new substype APPLEWATCH

• 2.25.0

  • Including new query param promotional_renew for endpoint /orgs/{org_id}/commercial_devices/sellable

• 2.24.1

  • Minor corrections to endpoint /orgs/{org_id}/commercial_devices/refinance descriptions

• 2.24.0

  • New endpoint /orgs/{org_id}/commercial_devices/refinance to cover commercial device refinancing functionality

• 2.23.0

  • Including ofc-manager endpoints /manager/orgs/{org_id}/validationand /manager/orgs/{org_id}/execution/{load_id}

• 2.22.0

  • Changes in endpoint /orgs/{org_id}/bundled_products/{bundled_product_id}/bundled_commercial_products/{id}/can-switch
    • Include new query param used_for_automatic_orphan_subscription_change
    • Fix response by creating new schema BundledCommercialProductCanSwitch
  • Fix BundledCommercialProduct, BundledCommercialProductDetail and BundledCommercialProductBasic schema by adding invoice_name missing
    attribute

• 2.21.1

  • Include external_id in BundledProductBasic_Response schema

• 2.21.0

  • Add endpoint : /orgs/{org_id}/free_units_packages
  • new value in LoadSegment schema

• 2.20.0

  • Remove endpoint : /orgs/{org_id}/value_added_services/{id}/commercial_infos

• 2.19.0

  • Add in_catalogue_since and in_catalogue_until from CommercialDevice_device_Response
  • New schema Device_Response for extended device characteristics
  • New values in schema `LoadType'

• 2.18.1

  • Include is_external attribute in CommercialDevice_fees_Response y FeeInstallmentPlan_Response
  • Remove in_catalogue_since and in_catalogue_until from CommercialDevice_device_Response

• 2.18.0

  • Add new schema Terms_alone_Response
  • Remove attributes from and to in CommercialDevicesTerms_Response schema updating terms response

• 2.17.0

  • New endpoint: /orgs/{org_id}/free_units_packages/{id}
  • New attribute event_type in FreeUnitsPackage_Response schema
  • Remove FreeUnitsPackageDetail schema

• 2.16.0

  • Remove endpoint : /orgs/{org_id}/commercial_devices/{id}/commercial_infos

• 2.15.0

  • Include new attibute used_for_automatic_orphan_subscription_change in BundledProductSubsType Schema
  • New query params used_for_automatic_changes
    • /orgs/{org_id}/bundled_products/{id}/can-switch (and subs_removed )
    • /orgs/{org_id}/bundled_products/{id}/can-switch/{target_id}
  • New attribute subs_removed in schema SwitchBundledProduct_Response
  • Include payment_type in commercial_devices endpoints response, CommercialDevice and CommercialDeviceAlone schemas
  • New attribute generic_code :
    • Include in CommercialDevice_device_Response Schema
    • Include as query param in:
      • /orgs/{org_id}/devices/sellable
      • /orgs/{org_id}/devices
      • /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/sellable
  • New endpoint /orgs/{org_id}/bundled_products/{id}/bundled_commercial_products/can-migrate
  • Include sale_type_name query param in:
    • /orgs/{org_id}/bundled_commercial_products/{id}/value_added_services
    • /orgs/{org_id}/commercial_products/{id}/value_added_services

• 2.14.1

  • Include new properties value and currency in Fee, Term and Promotion in CommercialDevice_fees_Response schema
  • Remove unsed query param channel_name
  • commercial_devices endpoints:
    • new query params:
      • payment_type
      • device_category
      • device_brand
  • fix wrong query params in
    • /orgs/{org_id}/bundled_products/{id}/promotions
    • /orgs/{org_id}/bundled_products/{bp_id}/bundled_commercial_products/{bcp_id}/value_added_services/sellable
    • /orgs/{org_id}/value_added_services/{id}/commercial_devices/sellable
    • /orgs/{org_id}/bundled_commercial_products/{id}/value_added_services/sellable
    • /orgs/{org_id}/commercial_products/{id}/value_added_services/sellable
    • /orgs/{org_id}/bundled_products/{bp_id}/bundled_product_subs_types/{bpst_id}/bundled_commercial_products/{bcp_id}/value_added_services/sellable
  • Replace Promotion_Response by PromotionDetail_Response schema

• 2.14.0

  • Fix invoice_ name by invoice_name
  • New endpoints:
    • /orgs/{org_id}/base_profiles
    • /orgs/{org_id}/base_profiles/{id}
    • /orgs/{org_id}/base_profiles/{id}/services
    • /orgs/{org_id}/subs_type
    • /orgs/{org_id}/subs_type/{id}
    • /orgs/{org_id}/territory_owners
    • /orgs/{org_id}/territory_owners/{id}

• 2.13.7

  • Include ‘Fixed+Broadband+Mobile+Netflix’ in BundleCategory and BundleCategory_Response schemas
  • Include ‘NETFLIX’ in SubsTypeName and SubsTypeName_Response
  • Remove query param restricted_to_user_profile
  • Include internet_speed attribute in BundledProductBasic_Response Schema
  • Include query params in /orgs/{org_id}/value_added_services/{id}/promotions

• 2.13.6

  • Commercial profile endpoints:
    • /orgs/{org_id}/commercial_profiles
    • /orgs/{org_id}/commercial_profiles/{com_profile_id}/commercial_products
    • /orgs/{org_id}/commercial_profiles/{com_profile_id}/free_units_packages
    • /orgs/{org_id}/commercial_profiles/{com_profile_id}/bundled_products
    • /orgs/{org_id}/commercial_profiles/{com_profile_id}/promotions
  • Endpoint /{org_id}/promotions/sellable include query param commercial_profile_name and remove unused query param channel_name
  • Endpoint /orgs/{org_id}/bundled_commercial_products/{id}/commercial_devices/sellable remove channels in response schema and remove query params
    • channel_name unused
    • renewal_category not sense in this endpoint
    • subs_offer_segment not sense in this endpoint
  • Endpoint /{org_id}/commercial_devices/sellable remove channels in response schema
  • Endpoint /{org_id}/commercial_products/{id}/commercial_devices/sellable remove query params
    • channel_name unused
    • renewal_category not sense in this endpoint
    • subs_offer_segment not sense in this endpoint

• 2.13.5

  • Adapt error codes from int to string due to openapi version update

• 2.13.4

  • Include new property internet_speed in following schemas:
    • BundledProduct_Response
    • BaseProfile

• 2.13.3

  • Remove query param restricted_to_user_profile for the /orgs/{org_id}/bundled_products/{id}/can-switch endpoint
  • Remove query param include_optional_bundled_commercial_products for the /orgs/{org_id}/bundled_products/sellable endpoint

• 2.13.2

  • Fix /orgs/{org_id}/devices:
    • add mandatory query param commercial_profile_name
  • Fix /orgs/{org_id}/devices/sellable:
    • add mandatory query param commercial_profile_name

• 2.13.1

  • Change CommercialDevice_fees_Response by remove type

• 2.13.0

  • Include new properties value and currency in Fee, Term and Promotion
  • Include TransactionType in commercialDevice fee and term response
  • New endpoints
    • /orgs/{org_id}/commercial_products/sellable
    • /orgs/{org_id}/bundled_products/sellable
    • /orgs/{org_id}/devices/sellable
    • /orgs/{org_id}/devices/{id}
    • /orgs/{org_id}/devices
    • /orgs/{org_id}/transaction_types/{id}
    • /orgs/{org_id}/bundled_products/{bp_id}/bundled_commercial_products/{bcp_id}/value_added_services/sellable
    • /orgs/{org_id}/bundled_products/{bp_id}/bundled_product_subs_types/{bpst_id}/bundled_commercial_products/{bcp_id}/value_added_services/sellable

• 2.12.2

  • Define getCommercialProducts and getCommercialProductsCanSwitch operationId

• 2.12.1

  • Fix /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products:
    • remove optional query params
    • create schema BundledCommercialProductBasic for its response
  • Update DonorNumerationType_Response schema

• 2.12.0

  • New subscription type DEVICEINSURANCE in SubsTypeName and SubsTypeName_Response schemas
  • Include new query param ‘insured_amount’ in
    /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/sellable

• 2.11.2

  • Fix postOFCupdates, defining request body instead of query param
  • Change subs_offer_segment_name from enum to string
  • Fix CommercialDevice Schema by changing donor_numeration_type_name by donor_numeration_types
  • New CommercialDeviceAlone schema for /commercial_devices/sellable response removing from, to and is_mandatory properties

• 2.11.1

  • Include body definition in POST /designer/orgs/{org_id}/catalogue_updates

• 2.11.0

  • Include new endpoints for Designer service to request an update of commercial offer
    • /designer/orgs/{org_id}/catalogue_updates
    • /designer/orgs/{org_id}/catalogue_updates/{update_id}
  • Include new SubsOfferSegment values
  • Include insured_amount property in CommercialDevice
  • Include Fee at bundled product level:
    • /bundled_products
    • /bundled_products/{id}

• 2.10.2

  • Include new property ‘available_networks’ in BaseProfile_services schema
  • Fix /commercial_devices/sellable:
    • remove channel_name as query param not in use
    • add commercial_profile_name as query param

• 2.10.1

  • Fix subs_type as object in /commercial_products

• 2.10.0

  • Fix to include from and to in ValueFT schema
  • Fix CommercialProduct_SubsTypeName_Response schema
  • Fix customer_offer_segment_name by subs_offer_segment_name, query param not in use by today
  • New Schema InstallationType_Response included as optional in Commercial Devices Endpoints
  • New endpoint /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types
  • New endpoint /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products
  • New endpoint /orgs/{org_id}/bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/{bcp_id}

• 2.9.1

  • Fix remove is_recurring_package property from Change FreeUnitsPackage_free_units_package_template_Response to FreeUnitsPackage_Response and
    FreeUnitsPackageDetail

• 2.9.0

  • New property commission_percentage in CommercialDevice_installment_plan schema
  • fix response /orgs/{org_id}/promotions/{existent_promotion_id}/can-switch/{new_promotion_id}

• 2.8.0

  • New value ‘Cross Sell’ in query param sale_type_name and new value in response to identify Cross Sell promotions, schema SaleTypeName
    SaleTypeName_Response
  • Include commercial_profile_name as queryparam in request and in response
  • New property ‘duo_type’ in BundledCommercialProductDetail and BundledCommercialProduct schema

• 2.7.0

  • New commercial profile visibility functionality, implies:
    • new query param commercial_profile_name
      • /commercial_products
      • /bundled_products
      • /bundled_products/{id}/bundled_product_subs_types/{subs_type_id}/bundled_commercial_products/sellable
      • /commercial_products/{id}/free_units_packages/sellable
      • /bundled_products/{id}/can-switch
      • /bundled_products/{id}/can-switch/{target_id}
      • /bundled_products/{bundled_product_id}/bundled_commercial_products/{id}/can-switch
      • /commercial_products/{id}/can-switch
    • remove center and user query param (not in use)

• 2.6.2

  • Fix TransactionType schema changing transaction_type attribute values to Credit and Debit instead lowercase

• 2.6.1

  • Include bundled_segment attribute in bundled_products node
    • BundledProductBasic_Response
    • BundledProduct_Response
    • SwitchCommercialProduct_Response

• 2.6.0

  • Include response codes information
  • New endpoints:
    • /orgs/{org_id}/transaction_types
    • /orgs/{org_id}/promotions/id
  • Include following attributes in promotions:
    • xsell_permit
    • reduced_fee_amount
  • New query param donor_numeration_type_name to cover commercial devices definition for new subscriptions in following endpoints:
    • /orgs/{org_id}/bundled_commercial_products/{id}/commercial_devices/sellable
    • /orgs/{org_id}/commercial_devices/sellable

• 2.5.0

  • Fix BundledCommercialProduct Schema by adding Fee structure
  • Tax definition functionality by creating TransactionType schema and include it in Fee, Terms and Promotion Response Schemas
  • Compatibility promotions functionality new endpoint /orgs/{org_id}/promotions/{existent_promotion_id}/can-switch/{new_promotion_id}

• 2.4.0

  • Filter FreeUnitsPackages by CommercialProfile
    • new query param commercial_profile_name in endpoint /orgs/{org_id}/commercial_products/{id}/free_units_packages/sellable
  • Include multilanguage invoice name and invoice description info in the following schemas:
    • CommercialInfo
    • CommercialProduct_Response
    • CommercialProductBasic
    • FreeUnitsPackageDetail
    • FreeUnitsPackage_Response
    • PromotionDetail_Response
    • Promotion_Response
    • ValueAddedService
    • BundledProductBasic_Response
    • BundledProduct_Response
    • SwitchCommercialProduct_Response
  • Fix schema type response in:
    • /orgs/{org_id}/bundled_products/{id}/can-switch/{target_id}
    • /orgs/{org_id}/commercial_products/{id}/free_units_packages/{fup_id}

• 2.3.1

  • DataSharing funcionality:
    • include sharing_compatible in FreeUnitsPackageDetail

• 2.3.0

  • DataSharing funcionality
    • new endpoint /orgs/{org_id}/commercial_products/{id}/free_units_packages/{fup_id}
    • add SubsTypeName_Response
    • new value in SubsTypeName
  • Adopt API Conventions
    • change all enum in responses to x-extensible-enum to allow new values in future

• 2.2.4

  • Fix is_recurring_package instead of isRecurringPackage in FreeUnitsPackage_free_units_package_template schema
  • BaseProfile_services schema:
    • mantain default_initial_status
    • remove masbarring_code

• 2.2.3

  • Update Designer endpoint including /designer prefix
  • Update CommercialDevice_installment_plan schema including:
    • tin
    • tae
    • commission
  • Modifiy /orgs/{org_id}/commercial_products/{id}/base_profiles to include more info in the services schema BaseProfile_services
    • remove default_initial_status
    • add:
      • network_code
      • masbarring_code
      • is_changeable
  • Modify CommercialDevice_device schema by adding image_url property

• 2.2.1

  • Update FUP endpoints to cover rating requirements
    • change event_type enum to english
    • remove FreeUnitsPackageDetail_free_units_package_template schema

• 2.2.0

  • Update FUP endpoints to cover rating requirements
    • Include new logic to populate applicability_rule attribute
    • Remove following attributes from free units package template:
      • recurrence_scheme
      • recurrence_interval_type
      • recurrence_interval_value
      • prorated
      • carry_over
  • New endpoint /orgs/{org_id}/commercial_devices/terms/sellable

• 2.1.3

  • Change query enum to schema
    • RenewalCategory
    • TechnologyName
  • Designer Endpoints Updated
    • Include new response in execution
    • Include format and example for validation_requested_date and execution_requested_date
    • Include url_file example
    • LoadType schema changed

• 2.1.2

  • Change query enum to schema

• 2.1.1

  • Updated information, no code impact: change BaseProfile_services speed attribute from number to string

Release and compatibility

• Deprecations for current versions whenever a new version is announced is 6 months.
• After 6 months, the deprecated version will no longer be supported but will remain accessible for at least 1 year.
• Our APIs will allow requests only from two versions simultaneously, however we won’t support the older of the two.
• All enum in responses are define as x-extensible-enum, it means they all are susceptible to increase values.

Version criteria

{MAJOR}.{MINOR}.{PATCH}

1. {MAJOR} implies uncompatible changes with the previous {MAJOR} version and also set {MINOR} to 0
2. {MINOR} implies new functionalities or information compatible with previous version and set {PATCH} to 0
3. {PATCH} implies bug fixes compatible with previous version