Value Added Services

Get value added services for commercial product

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.

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

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name
mysim_service_id	query	string	false	internal service id used within mySim

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/value_added_services?sale_type_name='Venta'&mysim_service_id='1' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Value Added Service	[ValueAddedService]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of ValueAddedService

Custom schema example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140


[
  {
    "id": "261",
    "mysim_id": "21",
    "marketing_name": "IP FIJA",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "digital_channels_name": "IP FIJA",
    "invoice_name": "IP FIJA",
    "invoice_description": "IP FIJA DESCRIPTION",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "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": "2019-08-24T14:15:22Z",
        "in_catalogue_until": "2019-08-24T14:15:22Z",
        "digital_channels_name": "IP FIJA",
        "invoice_name": "IP FIJA",
        "invoice_description": "IP FIJA DESCRIPTION",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "fees": [
          {
            "id": "1",
            "description": "TARIFA MAS 10GB cuotamensual",
            "type": "RecurringCharge",
            "subtype": "ServiceFee",
            "recurrence_scheme": "BoundToBillCycle",
            "recurrence_interval_type": "Monthly",
            "recurrence_interval": 30,
            "paid_in_advance": false,
            "prorated_on_activation": true,
            "prorated_on_deactivation": true,
            "is_external": false,
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "value": 8.264463,
            "currency": "euro",
            "terms": [
              {
                "id": "5138_promotion",
                "name": "12 MESES-36E",
                "type": "PermanenceContract",
                "commitment_duration": 12,
                "unlimited_duration": false,
                "penalty_prorated": true,
                "value": 8.264463,
                "currency": "euro",
                "permanence_type": "MAIN",
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                },
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z"
              }
            ],
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            }
          }
        ]
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable value added services for commercial product

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.

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

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/value_added_services/sellable?sale_type_name='Venta' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	ValueAddedServices	[ValueAddedService]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of ValueAddedService

Custom schema example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140


[
  {
    "id": "261",
    "mysim_id": "21",
    "marketing_name": "IP FIJA",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "digital_channels_name": "IP FIJA",
    "invoice_name": "IP FIJA",
    "invoice_description": "IP FIJA DESCRIPTION",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "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": "2019-08-24T14:15:22Z",
        "in_catalogue_until": "2019-08-24T14:15:22Z",
        "digital_channels_name": "IP FIJA",
        "invoice_name": "IP FIJA",
        "invoice_description": "IP FIJA DESCRIPTION",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "fees": [
          {
            "id": "1",
            "description": "TARIFA MAS 10GB cuotamensual",
            "type": "RecurringCharge",
            "subtype": "ServiceFee",
            "recurrence_scheme": "BoundToBillCycle",
            "recurrence_interval_type": "Monthly",
            "recurrence_interval": 30,
            "paid_in_advance": false,
            "prorated_on_activation": true,
            "prorated_on_deactivation": true,
            "is_external": false,
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "value": 8.264463,
            "currency": "euro",
            "terms": [
              {
                "id": "5138_promotion",
                "name": "12 MESES-36E",
                "type": "PermanenceContract",
                "commitment_duration": 12,
                "unlimited_duration": false,
                "penalty_prorated": true,
                "value": 8.264463,
                "currency": "euro",
                "permanence_type": "MAIN",
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                },
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z"
              }
            ],
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            }
          }
        ]
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get value added services for bundled commercial product

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.

GET /orgs/{org_id}/bundled_commercial_products/{id}/value_added_services

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	bundled commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name
mysim_service_id	query	string	false	internal service id used within mySim

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/value_added_services?sale_type_name='Venta'&mysim_service_id='1' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	Value Added Service	[ValueAddedService]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of ValueAddedService

Custom schema example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140


[
  {
    "id": "261",
    "mysim_id": "21",
    "marketing_name": "IP FIJA",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "digital_channels_name": "IP FIJA",
    "invoice_name": "IP FIJA",
    "invoice_description": "IP FIJA DESCRIPTION",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "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": "2019-08-24T14:15:22Z",
        "in_catalogue_until": "2019-08-24T14:15:22Z",
        "digital_channels_name": "IP FIJA",
        "invoice_name": "IP FIJA",
        "invoice_description": "IP FIJA DESCRIPTION",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "fees": [
          {
            "id": "1",
            "description": "TARIFA MAS 10GB cuotamensual",
            "type": "RecurringCharge",
            "subtype": "ServiceFee",
            "recurrence_scheme": "BoundToBillCycle",
            "recurrence_interval_type": "Monthly",
            "recurrence_interval": 30,
            "paid_in_advance": false,
            "prorated_on_activation": true,
            "prorated_on_deactivation": true,
            "is_external": false,
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "value": 8.264463,
            "currency": "euro",
            "terms": [
              {
                "id": "5138_promotion",
                "name": "12 MESES-36E",
                "type": "PermanenceContract",
                "commitment_duration": 12,
                "unlimited_duration": false,
                "penalty_prorated": true,
                "value": 8.264463,
                "currency": "euro",
                "permanence_type": "MAIN",
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                },
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z"
              }
            ],
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            }
          }
        ]
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable value added services for bundled commercial product

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.

GET /orgs/{org_id}/bundled_commercial_products/{id}/value_added_services/sellable

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	bundled commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/value_added_services/sellable?sale_type_name='Venta' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	ValueAddedServices	[ValueAddedService]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of ValueAddedService

Custom schema example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140


[
  {
    "id": "261",
    "mysim_id": "21",
    "marketing_name": "IP FIJA",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "digital_channels_name": "IP FIJA",
    "invoice_name": "IP FIJA",
    "invoice_description": "IP FIJA DESCRIPTION",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "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": "2019-08-24T14:15:22Z",
        "in_catalogue_until": "2019-08-24T14:15:22Z",
        "digital_channels_name": "IP FIJA",
        "invoice_name": "IP FIJA",
        "invoice_description": "IP FIJA DESCRIPTION",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "fees": [
          {
            "id": "1",
            "description": "TARIFA MAS 10GB cuotamensual",
            "type": "RecurringCharge",
            "subtype": "ServiceFee",
            "recurrence_scheme": "BoundToBillCycle",
            "recurrence_interval_type": "Monthly",
            "recurrence_interval": 30,
            "paid_in_advance": false,
            "prorated_on_activation": true,
            "prorated_on_deactivation": true,
            "is_external": false,
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "value": 8.264463,
            "currency": "euro",
            "terms": [
              {
                "id": "5138_promotion",
                "name": "12 MESES-36E",
                "type": "PermanenceContract",
                "commitment_duration": 12,
                "unlimited_duration": false,
                "penalty_prorated": true,
                "value": 8.264463,
                "currency": "euro",
                "permanence_type": "MAIN",
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                },
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z"
              }
            ],
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            }
          }
        ]
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable value added services for bundled commercial product in a particular bundled product

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.

GET

/orgs/{org_id}/bundled_products/{bp_id}/bundled_product_subs_types/{bpst_id}/bundled_commercial_products/{bcp_id}/value_added_services/sellable

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
bp_id	path	string	true	bundled product identifier
bpst_id	path	string	true	bundled product subscription type identifier
bcp_id	path	string	true	bundled commercial product identifier
sale_type_name	query	SaleTypeName	false	sale type name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/bundled_product_subs_types/{bpst_id}/bundled_commercial_products/3009_BUNDLED_3P/value_added_services/sellable?sale_type_name='Venta' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	ValueAddedServices	[ValueAddedService]
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

200 - instance of ValueAddedService

Custom schema example

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140


[
  {
    "id": "261",
    "mysim_id": "21",
    "marketing_name": "IP FIJA",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "digital_channels_name": "IP FIJA",
    "invoice_name": "IP FIJA",
    "invoice_description": "IP FIJA DESCRIPTION",
    "from": "2019-08-24T14:15:22Z",
    "to": "2019-08-24T14:15:22Z",
    "fees": [
      {
        "id": "1",
        "description": "TARIFA MAS 10GB cuotamensual",
        "type": "RecurringCharge",
        "subtype": "ServiceFee",
        "recurrence_scheme": "BoundToBillCycle",
        "recurrence_interval_type": "Monthly",
        "recurrence_interval": 30,
        "paid_in_advance": false,
        "prorated_on_activation": true,
        "prorated_on_deactivation": true,
        "is_external": false,
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "value": 8.264463,
        "currency": "euro",
        "terms": [
          {
            "id": "5138_promotion",
            "name": "12 MESES-36E",
            "type": "PermanenceContract",
            "commitment_duration": 12,
            "unlimited_duration": false,
            "penalty_prorated": true,
            "value": 8.264463,
            "currency": "euro",
            "permanence_type": "MAIN",
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            },
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z"
          }
        ],
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        }
      }
    ],
    "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": "2019-08-24T14:15:22Z",
        "in_catalogue_until": "2019-08-24T14:15:22Z",
        "digital_channels_name": "IP FIJA",
        "invoice_name": "IP FIJA",
        "invoice_description": "IP FIJA DESCRIPTION",
        "from": "2019-08-24T14:15:22Z",
        "to": "2019-08-24T14:15:22Z",
        "fees": [
          {
            "id": "1",
            "description": "TARIFA MAS 10GB cuotamensual",
            "type": "RecurringCharge",
            "subtype": "ServiceFee",
            "recurrence_scheme": "BoundToBillCycle",
            "recurrence_interval_type": "Monthly",
            "recurrence_interval": 30,
            "paid_in_advance": false,
            "prorated_on_activation": true,
            "prorated_on_deactivation": true,
            "is_external": false,
            "from": "2019-08-24T14:15:22Z",
            "to": "2019-08-24T14:15:22Z",
            "value": 8.264463,
            "currency": "euro",
            "terms": [
              {
                "id": "5138_promotion",
                "name": "12 MESES-36E",
                "type": "PermanenceContract",
                "commitment_duration": 12,
                "unlimited_duration": false,
                "penalty_prorated": true,
                "value": 8.264463,
                "currency": "euro",
                "permanence_type": "MAIN",
                "transaction_type": {
                  "id": "121",
                  "name": "DEVOLUCION AT. AL CLIENTE",
                  "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
                  "is_active": true,
                  "is_external": false,
                  "tax_rate": "generic",
                  "transaction_type": "Credit",
                  "refund_transaction_type_id": "121"
                },
                "from": "2019-08-24T14:15:22Z",
                "to": "2019-08-24T14:15:22Z"
              }
            ],
            "transaction_type": {
              "id": "121",
              "name": "DEVOLUCION AT. AL CLIENTE",
              "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
              "is_active": true,
              "is_external": false,
              "tax_rate": "generic",
              "transaction_type": "Credit",
              "refund_transaction_type_id": "121"
            }
          }
        ]
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	ValueAddedServiceDetail	false	none

Name	Type	Required	Description
anonymous	object	false	none
» is_mandatory	boolean	false	none
» max_cardinality	string	false	Represents the same as max_quantity but typed as string. Deprecated in favor of max_quantity.
» max_quantity	integer	false	Maximum number of instances of this value_added_service that can be hired with a [bundled_]commercial_product.
» related_bundled_product_id	string	false	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	[ValueAddedServiceDetail]	false	Required value_added_services that need to be hired with the parent value_added_service.

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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