1. REST API Reference for Launch Cloud Service
  2. Tasks
  3. Promotion

Get all promotions
get

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2/promotion

Request

Query Parameters
  • The description of the resource.
  • Project Id
  • The comma-separated field names that are returned in the response. The field names are the names that you specify when you create or retrieve a resource.
  • The unique identifier of the resource item.
  • The current lifecycle status of the resource.
  • The number of resources to be returned in the response. The minimum value that can be specified is 1, and the maximum value that can be specified is 100,000. If the specified value is greater than 100,000, then it defaults to 100,000.
  • The name of the resource.
  • The record number from which the retrieval starts. The default value is zero. If no value is specified, then it defaults to zero. The value zero indicates that the retrieval will start from the beginning of the collection.
  • Promotion Type
  • enrich objects with usedBy information

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : PromotionV2Oracle
Title: PromotionV2Oracle
Match All
Show Source
  • PromotionV2
    Title: PromotionV2
    Discriminator: { "propertyName":"@type", "mapping":{ "Promotion":"#/components/schemas/PromotionV2", "PromotionOracle":"#/components/schemas/PromotionV2Oracle" } }
    Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.
  • PromotionV2Oracle-allOf[1]
Nested Schema : PromotionV2
Type: object
Title: PromotionV2
Discriminator: @type

Discriminator Values

Promotion Resource is used to provide the additional discount, voucher, bonus or gift to the customer who meets the pre-defined criteria. Using promotion, the enterprise is able to attract the users and encourage more consumption, especially continuous purchases. Normally Promotion is not regarded as one type of product or product offering. It is often applied when the customer buys the product offerings with the price or amount surpassing the certain limit.
Show Source
Nested Schema : PromotionV2Oracle-allOf[1]
Type: object
Show Source
Nested Schema : agreement
Type: array
Show Source
  • Agreement
    Title: Agreement
    Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.
Nested Schema : attachment
Type: array
Show Source
Nested Schema : category
Type: array
Show Source
  • CategoryRef
    Title: CategoryRef
    Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Nested Schema : customProfileSpec
Type: array
Show Source
Nested Schema : customProfSpecCharValueUse
Type: array
Show Source
  • CustomProfSpecCharValueUse
    Title: CustomProfSpecCharValueUse
    A use of the CustomProfSpecCharValue by an entity to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProdSpecCharValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
Nested Schema : priceList
Type: array
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
Project Reference
Show Source
Nested Schema : Agreement
Type: object
Title: Agreement
Agreement reference. An agreement represents a contract or arrangement, either written or verbal and sometimes enforceable by law, such as a service level agreement or a customer price agreement. An agreement involves a number of other business entities, such as products, services, and resources and/or their specifications.
Show Source
Nested Schema : AttachmentRefOrValue
Type: object
Title: AttachmentRefOrValue
Complements the description of an element (for instance a product) through video, pictures...
Show Source
Nested Schema : Quantity
Type: object
Title: Quantity
A number and unit representing how many of an ProductOffering is available at the offered price.
Show Source
  • A quantity of something, typically the total of a thing or things in number, size, value, extent, or money.
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    The unit of measure for the quantity, such as meters, cubic yards, kilograms [ISO 80000], and the currency referring to [ISO 4217].
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
Validity period of the related party
Show Source
Nested Schema : CategoryRef
Type: object
Title: CategoryRef
Category reference. The category resource is used to group product offerings, service and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource or service candidates.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
Custom Profile specification reference.
Show Source
Nested Schema : CustomProfSpecCharValueUse
Type: object
Title: CustomProfSpecCharValueUse
A use of the CustomProfSpecCharValue by an entity to which additional properties (attributes) apply or override the properties of similar properties contained in ProdSpecCharacteristicValue. It should be noted that characteristics which their value(s) addressed by this object must exist in corresponding product specification. The available characteristic values for a ProductSpecCharacteristic in a Product specification can be modified at the ProductOffering level. For example, a characteristic 'Color' might have values White, Blue, Green, and Red. But, the list of values can be restricted to e.g. White and Blue in an associated product offering. It should be noted that the list of values in 'ProdSpecCharValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
Show Source
Nested Schema : customProfileSpecCharValue
Type: array
Show Source
Nested Schema : CustomProfileSpecCharValue
Type: object
Title: CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
Show Source
  • base class type (immediate parent) of the ProductSpecCharacteristic
  • Hyperlink reference to schema describing this object
  • The class type of the characteristic value
  • A string. A word, term, or phrase by which can be displyed for user experience.
  • A field which used to enable or disable the value selection
  • Indicates if the value is the default value for a characteristic
  • Allowed Values: [ "OPEN", "CLOSED", "CLOSED_BOTTOM", "CLOSED_TOP" ]
    An indicator that specifies the inclusion or exclusion of the valueFrom and valueTo attributes. If applicable, possible values are "open", "closed", "closedBottom" and "closedTop".
  • Regular expression to define constraint on the allowed value
  • Order sequence for the values input
  • Allowed Values: [ "NONE", "SECOND", "MINUTE", "HOUR", "DAY", "MONTH", "BYTE", "KILOBYTE", "MEGABYTE", "GIGABYTE", "PAGES", "MOVIES", "TIME_INTERVAL", "QUANTITY", "MBPS", "GBPS" ]
    Could be minutes, GB...
  • TimePeriodOracle
    Title: TimePeriodOracle
    Validity period of the related party
  • value
    A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
  • The low range value that a characteristic can take on
  • Id of the resource referenced in the specification
  • Allowed Values: [ "SERVICE_SPEC" ]
    Type of the resource referenced in the specification
  • The upper range value that a characteristic can take on
  • Allowed Values: [ "STRING", "NUMBER", "OBJECT", "ARRAY", "DECIMAL", "BOOLEAN", "DATE", "DATETIME", "PRODUCT_OFFER", "PRODUCT_SPEC", "PRODUCT_LINE" ]
    A kind of value that the characteristic can take on, such as numeric, text, and so forth
Nested Schema : value
A discrete value that the characteristic can take on. the value type is defined by 'valueType' characteristic
Match One Schema
Show Source
Nested Schema : value-oneOf[1]
Type: object
Nested Schema : value-oneOf[4]
Type: array
Nested Schema : PriceListRefOracle
Type: object
Title: PriceListRefOracle
Pricelist reference.
Show Source

400 Response

Your request couldn't be processed because it contains missing or invalid information, such as a validation error on an input field, a missing required value, and so forth.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

401 Response

Your request isn't authorized. The authentication credentials included with this request are missing or invalid.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

404 Response

Your request includes a resource URI that doesn't exist.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

405 Response

HTTP action specified in the request (DELETE, GET, POST, PUT) isn't supported for this request URI.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source

500 Response

The server encountered something unexpected that prevented it from completing the request.
Body ()
Root Schema : Error
Type: object
Title: Error
Show Source
Back to Top

Examples

The following example shows how to retrieve all promotions by submitting a get request on the REST resource using cURL.

curl -u username:password -X GET https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2/promotion

Example of Response Body

The following example shows the contents of the response body in JSON format.

[
    {
        "@type": "PromotionOracle",
        "customProfileSpec": [
            {
                "id": "TestGripen001",
                "name": "TestGripen001",
                "version": "1.0",
                "@referredType": "CustomProfileSpecificationOracle"
            }
        ],
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2/promotion/ProductPromotion2021",
        "lastUpdate": "2021-03-31T10:27:48.000Z",
        "priceList": [
            {
                "id": "PriceList2001",
                "name": "PriceList2001",
                "version": "3.0",
                "@referredType": "priceListOracle"
            },
            {
                "id": "PriceList2002",
                "name": "PriceList2002",
                "version": "3.0",
                "@referredType": "priceListOracle"
            }
        ],
        "lastUpdatedBy": "booth",
        "createdBy": "booth",
        "validFor": {
            "startDateTime": "2020-09-14T00:00:00.000Z",
            "endDateTime": "2021-09-14T00:00:00.000Z"
        },
        "promotionType": "Reduction",
        "created": "2021-03-29T09:49:30.000Z",
        "lifecycleStatus": "In design",
        "project": {
            "id": "MyProject3000",
            "name": "MyProject3000"
        },
        "description": "VIP Customer can get additional bonus as gift on the birthday if the customer recharges over $75 or the same customer purchase $100 monthly fee in one order.",
        "version": "1.0",
        "pattern": [
            {
                "validFor": {
                    "startDateTime": "2020-09-14T00:00:00.000Z",
                    "endDateTime": "2020-09-14T00:00:00.000Z"
                },
                "criteriaGroup": [
                    {
                        "relationTypeInGroup": "AND",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.2"
                            }
                        ],
                        "groupName": "birthday as conditio001",
                        "id": "PromoEvent001"
                    },
                    {
                        "relationTypeInGroup": "OR",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "50",
                                "criteriaPara": "5.1",
                                "id": "Group.B.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "100",
                                "criteriaPara": "2.4",
                                "id": "Group.B.2"
                            }
                        ],
                        "groupName": "birthday as condition",
                        "id": "PromoEvent002"
                    }
                ],
                "relationTypeAmongGroup": "AND",
                "description": "Gift is effective when the customer is on birthday, and buys offerings with total price over $100 or recharge over $50",
                "action": [
                    {
                        "actionValue": 1,
                        "actionObjectId": "2002",
                        "actionValueObj": [
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer001",
                                "id": "ProductOffer001"
                            },
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer002",
                                "id": "ProductOffer002"
                            }
                        ],
                        "eligibility": [
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0011"
                            },
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0012"
                            }
                        ],
                        "actionType": "GIFT",
                        "id": "2209"
                    }
                ],
                "name": "Gift for recharge or purchase on birthday",
                "id": "1109",
                "priority": 0
            }
        ],
        "name": "ProductPromotion2021",
        "id": "ProductPromotion2021"
    },
    {
        "@type": "PromotionOracle",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2/promotion/ProductPromotion2025",
        "lastUpdate": "2021-03-30T07:27:12.000Z",
        "lastUpdatedBy": "booth",
        "createdBy": "booth",
        "validFor": {
            "startDateTime": "2020-09-14T00:00:00.000Z",
            "endDateTime": "2021-09-14T00:00:00.000Z"
        },
        "promotionType": "Reduction",
        "created": "2021-03-30T07:27:12.000Z",
        "lifecycleStatus": "In design",
        "description": "VIP Customer can get gift on the birthday if the customer recharges over $50 or the same customer purchase $100 monthly fee in one order",
        "version": "1.0",
        "pattern": [
            {
                "validFor": {
                    "startDateTime": "2020-09-14T00:00:00.000Z",
                    "endDateTime": "2020-09-14T00:00:00.000Z"
                },
                "criteriaGroup": [
                    {
                        "relationTypeInGroup": "AND",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.2"
                            }
                        ],
                        "groupName": "birthday as conditio001",
                        "id": "PromoEvent001"
                    },
                    {
                        "relationTypeInGroup": "OR",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "50",
                                "criteriaPara": "5.1",
                                "id": "Group.B.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "100",
                                "criteriaPara": "2.4",
                                "id": "Group.B.2"
                            }
                        ],
                        "groupName": "birthday as condition",
                        "id": "PromoEvent002"
                    }
                ],
                "relationTypeAmongGroup": "AND",
                "description": "Gift is effective when the customer is on birthday, and buys offerings with total price over $100 or recharge over $50",
                "action": [
                    {
                        "actionValue": 1,
                        "actionObjectId": "2002",
                        "actionValueObj": [
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer001",
                                "id": "ProductOffer001"
                            },
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer002",
                                "id": "ProductOffer002"
                            }
                        ],
                        "eligibility": [
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0011"
                            },
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0012"
                            }
                        ],
                        "actionType": "GIFT",
                        "id": "2209"
                    }
                ],
                "name": "Gift for recharge or purchase on birthday",
                "id": "1109",
                "priority": 0
            }
        ],
        "name": "ProductPromotion2021",
        "id": "ProductPromotion2025"
    },
    {
        "@type": "PromotionOracle",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2/promotion/ProductPromotion2222",
        "lastUpdate": "2021-03-30T08:14:34.000Z",
        "lastUpdatedBy": "booth",
        "createdBy": "booth",
        "validFor": {
            "startDateTime": "2020-09-14T00:00:00.000Z",
            "endDateTime": "2021-09-14T00:00:00.000Z"
        },
        "promotionType": "Bonus",
        "created": "2021-03-30T07:41:29.000Z",
        "lifecycleStatus": "In design",
        "description": "VIP Customer can get bonus on the birthday if the customer recharges over $50 or the same customer purchase $100 monthly fee in one order",
        "version": "1.0",
        "pattern": [
            {
                "validFor": {
                    "startDateTime": "2020-09-14T00:00:00.000Z",
                    "endDateTime": "2020-09-14T00:00:00.000Z"
                },
                "criteriaGroup": [
                    {
                        "relationTypeInGroup": "AND",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.2"
                            }
                        ],
                        "groupName": "birthday as conditio001",
                        "id": "PromoEvent001"
                    },
                    {
                        "relationTypeInGroup": "OR",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "50",
                                "criteriaPara": "5.1",
                                "id": "Group.B.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "100",
                                "criteriaPara": "2.4",
                                "id": "Group.B.2"
                            }
                        ],
                        "groupName": "birthday as condition",
                        "id": "PromoEvent002"
                    }
                ],
                "relationTypeAmongGroup": "AND",
                "description": "Additional bonus is effective when the customer is on birthday, and buys offerings with total price over $100 or recharge over $50",
                "action": [
                    {
                        "actionValue": 1,
                        "actionObjectId": "2002",
                        "actionValueObj": [
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer001",
                                "id": "ProductOffer001"
                            },
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer002",
                                "id": "ProductOffer002"
                            }
                        ],
                        "eligibility": [
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0011"
                            },
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0012"
                            }
                        ],
                        "actionType": "GIFT",
                        "id": "2209"
                    }
                ],
                "name": "Additional bonus for recharge or purchase on birthday",
                "id": "1109",
                "priority": 0
            }
        ],
        "name": "ProductPromotion2222",
        "id": "ProductPromotion2222"
    },
    {
        "@type": "PromotionOracle",
        "customProfileSpec": [
            {
                "id": "TestGripen001",
                "name": "TestGripen001",
                "version": "1.0",
                "@referredType": "CustomProfileSpecificationOracle"
            }
        ],
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotion/v2/promotion/ProductPromotion2022",
        "lastUpdate": "2021-03-31T07:00:29.000Z",
        "priceList": [
            {
                "id": "PriceList2001",
                "name": "PriceList2001",
                "version": "3.0",
                "@referredType": "priceListOracle"
            },
            {
                "id": "PriceList2002",
                "name": "PriceList2002",
                "version": "3.0",
                "@referredType": "priceListOracle"
            }
        ],
        "lastUpdatedBy": "booth",
        "createdBy": "booth",
        "validFor": {
            "startDateTime": "2020-09-14T00:00:00.000Z",
            "endDateTime": "2021-09-14T00:00:00.000Z"
        },
        "promotionType": "Reduction",
        "created": "2021-03-31T07:00:29.000Z",
        "lifecycleStatus": "In design",
        "project": {
            "id": "MyProject3000",
            "name": "MyProject3000"
        },
        "description": "VIP Customer can get gift on the birthday if the customer recharges over $50 or the same customer purchase $100 monthly fee in one order",
        "version": "1.0",
        "pattern": [
            {
                "validFor": {
                    "startDateTime": "2020-09-14T00:00:00.000Z",
                    "endDateTime": "2020-09-14T00:00:00.000Z"
                },
                "criteriaGroup": [
                    {
                        "relationTypeInGroup": "AND",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "2020-11-03",
                                "criteriaPara": "1.3",
                                "id": "Group.A.2"
                            }
                        ],
                        "groupName": "birthday as conditio001",
                        "id": "PromoEvent001"
                    },
                    {
                        "relationTypeInGroup": "OR",
                        "criteria": [
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "50",
                                "criteriaPara": "5.1",
                                "id": "Group.B.1"
                            },
                            {
                                "criteriaOperator": "EQUALS",
                                "criteriaValue": "100",
                                "criteriaPara": "2.4",
                                "id": "Group.B.2"
                            }
                        ],
                        "groupName": "birthday as condition",
                        "id": "PromoEvent002"
                    }
                ],
                "relationTypeAmongGroup": "AND",
                "description": "Gift is effective when the customer is on birthday, and buys offerings with total price over $100 or recharge over $50",
                "action": [
                    {
                        "actionValue": 1,
                        "actionObjectId": "2002",
                        "actionValueObj": [
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer001",
                                "id": "ProductOffer001"
                            },
                            {
                                "actionObjectType": "PRODUCT_OFFERING",
                                "name": "ProductOffer002",
                                "id": "ProductOffer002"
                            }
                        ],
                        "eligibility": [
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0011"
                            },
                            {
                                "actionObjectType": "productOffering",
                                "name": "action.Name",
                                "id": "action 0012"
                            }
                        ],
                        "actionType": "GIFT",
                        "id": "2209"
                    }
                ],
                "name": "Gift for recharge or purchase on birthday",
                "id": "1109",
                "priority": 0
            }
        ],
        "name": "ProductPromotion2022",
        "id": "ProductPromotion2022"
    }
]
Back to Top