Promotions

Get sellable promotions

Returns the promotions with ApplicabilityModel=Billing and which are commercially active for the correspondent Service Provider

GET /orgs/{org_id}/promotions/sellable

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name
target_applicability_rule	query	TargetApplicabilityRule	false	target applicability rule

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]
target_applicability_rule	one of [PreviousInvoiceTotalAmount, CurrentInvoiceTotalAmount, FeeSubtype, NOT_APPLICABLE]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/promotions/sellable?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos'&target_applicability_rule='FeeSubtype' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get promotions for commercial product

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.

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

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	commercial product identifier
commercial_profile_name	query	string	false	commercial profile name
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/promotions?commercial_profile_name='perfil_comercial.postpago_ventas_pos'&sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable promotions for commercial product

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.

GET /orgs/{org_id}/commercial_products/{id}/promotions/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
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/promotions/sellable?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get promotions for bundled product

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.

GET /orgs/{org_id}/bundled_products/{id}/promotions

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	bundled product identifier
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/promotions?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable promotions for bundled product

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.

GET /orgs/{org_id}/bundled_products/{id}/promotions/sellable

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	bundled product identifier
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_products/609/promotions/sellable?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get promotions for bundled commercial product

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.

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

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	bundled commercial product identifier
commercial_profile_name	query	string	false	commercial profile name
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



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'&sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable promotions for bundled commercial product

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.

GET /orgs/{org_id}/bundled_commercial_products/{id}/promotions/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
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/promotions/sellable?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get promotions for value added service

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.

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

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	value added service identifier
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/promotions?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get sellable promotions for value added service

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.

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

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	value added service identifier
sale_type_name	query	SaleTypeName	false	sale type name
customer_type_name	query	CustomerTypeName	false	customer type name
numeration_type_name	query	NumerationTypeName	false	numeration type name
commercial_profile_name	query	string	false	commercial profile name

Enumerated Values

Property	Values
sale_type_name	one of [Venta, Migración, Añadir Línea, Cross Sell, Cartera]
customer_type_name	one of [Nuevo, Existente]
numeration_type_name	one of [Nuevo numero, Numero portado, Numero entre marcas]

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/value_added_services/VAS_14_BP_600/promotions/sellable?sale_type_name='Venta'&customer_type_name='Nuevo'&numeration_type_name='Nuevonumero'&commercial_profile_name='perfil_comercial.postpago_ventas_pos' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

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

200 - instance of PromotionDetail_Response

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79


[
  {
    "id": "174",
    "name": "MM_DTO 3EUR DURANTE 12 MESES",
    "marketing_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "digital_channels_name": "MM_DTO 3EUR DURANTE 12 MESES",
    "invoice_name": "TARIFA MAS 10GB",
    "invoice_description": "TARIFA MAS 10GB",
    "in_catalogue_since": "2019-08-24T14:15:22Z",
    "in_catalogue_until": "2019-08-24T14:15:22Z",
    "need_promotion_code": false,
    "need_existent_MSISDN": false,
    "applicability_model": "FeeGeneration",
    "restrictions_applicability_rule": "string",
    "target_applicability_rule": "FeeSubtype",
    "fee_subtypes": "ServiceFee",
    "calculation_model": "Flat",
    "discount_type": "Fixed",
    "duration": 12,
    "unlimited_duration": false,
    "keep_on_upgrade": true,
    "keep_on_downgrade": false,
    "priority": 1,
    "is_mandatory": false,
    "xsell_permit": true,
    "reduced_fee_amount": true,
    "value": 8.264463,
    "currency": "euro",
    "from": "2022-10-03T22:00:00Z",
    "to": "2080-10-03T22:00:00Z",
    "skip_first_period": false,
    "reduce_penalty_threshold": true,
    "category_name": "captación",
    "type_name": "PERMANENCIA",
    "terms": [
      {
        "id": "5138_promotion",
        "name": "12 MESES-36E",
        "type": "PermanenceContract",
        "commitment_duration": 12,
        "unlimited_duration": false,
        "penalty_prorated": true,
        "value": 8.264463,
        "currency": "euro",
        "permanence_type": "MAIN",
        "transaction_type": {
          "id": "121",
          "name": "DEVOLUCION AT. AL CLIENTE",
          "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
          "is_active": true,
          "is_external": false,
          "tax_rate": "generic",
          "transaction_type": "Credit",
          "refund_transaction_type_id": "121"
        },
        "binding_type_id": 1
      }
    ],
    "transaction_type": {
      "id": "121",
      "name": "DEVOLUCION AT. AL CLIENTE",
      "description": "DEVOLUCIÓN AT. AL CLIENTE PRE",
      "is_active": true,
      "is_external": false,
      "tax_rate": "generic",
      "transaction_type": "Credit",
      "refund_transaction_type_id": "121"
    },
    "commercial_profiles": [
      {
        "id": 4,
        "name": "perfil_comercial.postpago_ventas_pos",
        "visibility_type": "POSITIVE",
        "from": "2022-10-03T22:00:00Z",
        "to": "2080-10-03T22:00:00Z"
      }
    ]
  }
]

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

401 - JsonObject

Custom schema example

1

"Origin authentication failed."

Name	Type	Required	Description
anonymous	getPromoByComProfile_Response	false	none

Name	Type	Required	Description
anonymous	object	false	none
» terms	[TermsPromotion_Response]	false	none
» transaction_type	TransactionType	false	none
» commercial_profiles	[CommercialProfile_Response]	false	none

404 - instance of KOGenericResponse

Custom schema example

1
2
3
4
5


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

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

Get promotion detail by id

This endpoint returns the promotion information by a given id

GET /orgs/{org_id}/promotions/{id}

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
id	path	string	true	promotion identifier

Request example

1
2
3
4
5



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

Responses

Code	Meaning	Description	Schema
200	OK	Promotion	PromotionDetail_Response
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

Get incompatible promotions in the context of a commercial_product

Returns a paginated list of incompatible promotions for the given promotion if any or an empty list if there are no incompatibilities

GET /orgs/{org_id}/commercial_products/{commercial_product_id}/promotions/{promotion_id}/incompatibilities

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
commercial_product_id	path	string	true	Unique commercial_product identifier
promotion_id	path	string	true	promotion identifier
offset	query	integer(int32)	false	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.
limit	query	integer(int32)	false	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.

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/commercial_products/2311/promotions/234/incompatibilities?offset='0'&limit='20' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	List of incompatible promotions	PromotionIncompatibilityPaginatedList
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse

Get incompatible promotions in the context of a bundled_commercial_product

Returns a paginated list of incompatible promotions for the given promotion if any or an empty list if there are no incompatibilities

GET /orgs/{org_id}/bundled_commercial_products/{bcp_id}/promotions/{promotion_id}/incompatibilities

Parameters

Name	In	Type	Required	Description
org_id	path	string	true	organization name
bcp_id	path	string	true	bundled commercial product identifier
promotion_id	path	string	true	promotion identifier
offset	query	integer(int32)	false	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.
limit	query	integer(int32)	false	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.

Request example

1
2
3
4
5



curl -X GET https://catalogue.masstack.com/v2/orgs/masmovil/bundled_commercial_products/3009_BUNDLED_3P/promotions/234/incompatibilities?offset='0'&limit='20' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code	Meaning	Description	Schema
200	OK	List of incompatible promotions	PromotionIncompatibilityPaginatedList
401	Unauthorized	Unauthorized	string
404	Not Found	Item not found	KOGenericResponse