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

Update a promotion

patch

https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotionManagement/v4/promotion/{id}

Updates the promotion that matches the specified ID using the supplied request payload.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : PromotionOracle
Title: PromotionOracle
Match All
Show Source
  • Promotion
    Title: Promotion
    Discriminator: { "propertyName":"@type", "mapping":{ "Promotion":"#/components/schemas/Promotion", "PromotionOracle":"#/components/schemas/PromotionOracle" } }
    Promotion Resource provides 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.
  • type
Nested Schema : Promotion
Type: object
Title: Promotion
Discriminator: @type

Discriminator Values

Promotion Resource provides 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 : type
Type: object
Show Source
Nested Schema : agreement
Type: array
A list of agreements associated with the promotion.
Show Source
  • AgreementRef
    Title: AgreementRef
    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 : category
Type: array
A list of categories associated with the promotion.
Show Source
  • CategoryRef
    Title: CategoryRef
    The category reference. The category resource groups product offerings, service candidates, and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource candidates, or service candidates.
Nested Schema : customProfileSpec
Type: array
A list of custom profile specifications associated with the promotion.
Show Source
Nested Schema : customProfSpecCharValueUse
Type: array
A list of custom prof specification characteristic value uses associated with the promotion.
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 for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
Nested Schema : priceList
Type: array
A list of price lists associated with the promotion.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : AgreementRef
Type: object
Title: AgreementRef
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 : CategoryRef
Type: object
Title: CategoryRef
The category reference. The category resource groups product offerings, service candidates, and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource candidates, or service candidates.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
The 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 for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
Show Source
Nested Schema : customProfileSpecCharValue
Type: array
A list of custom profile specification characteristic values associated with the custom prof specification characteristic value use.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : CustomProfileSpecCharValue
Type: object
Title: CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
Show Source
  • The base type of the custom profile specification characteristic value.
  • The URI of the schema that defines the custom profile specification characteristic value.
  • The class type of the custom profile specification characteristic value.
  • A string. A word, term, or phrase by which can be displyed for user experience.
  • Whether the custom profile specification characteristic value has enabled.
  • Whether the custom profile specification characteristic value is default.
  • 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". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.
  • The regular expression to define constraint on the allowed value.
  • The 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" ]
    The unit can be minutes or GB.
  • TimePeriodOracle
    Title: TimePeriodOracle
    The validity period of the related party.
  • value
    A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
  • The low range value that a characteristic can take on.
  • The ID of the value reference associated with the custom profile specification characteristic value.
  • Allowed Values: [ "SERVICE_SPEC" ]
    The type or classification of the custom profile specification characteristic value. Valid values are SERVICE_SPEC.
  • 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", "SPEC_CHAR" ]
    The type or classification of the custom profile specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_SPEC, PRODUCT_LINE, and SPEC_CHAR.
Nested Schema : value
A discrete value that the characteristic can take on. The value type is defined by the 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
The pricelist reference.
Show Source
Back to Top

Response

Supported Media Types

200 Response

The promotion was updated successfully.
Body ()
Root Schema : PromotionOracle
Title: PromotionOracle
Match All
Show Source
  • Promotion
    Title: Promotion
    Discriminator: { "propertyName":"@type", "mapping":{ "Promotion":"#/components/schemas/Promotion", "PromotionOracle":"#/components/schemas/PromotionOracle" } }
    Promotion Resource provides 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.
  • type
Nested Schema : Promotion
Type: object
Title: Promotion
Discriminator: @type

Discriminator Values

Promotion Resource provides 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 : type
Type: object
Show Source
Nested Schema : agreement
Type: array
A list of agreements associated with the promotion.
Show Source
  • AgreementRef
    Title: AgreementRef
    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 : category
Type: array
A list of categories associated with the promotion.
Show Source
  • CategoryRef
    Title: CategoryRef
    The category reference. The category resource groups product offerings, service candidates, and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource candidates, or service candidates.
Nested Schema : customProfileSpec
Type: array
A list of custom profile specifications associated with the promotion.
Show Source
Nested Schema : customProfSpecCharValueUse
Type: array
A list of custom prof specification characteristic value uses associated with the promotion.
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 for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
Nested Schema : priceList
Type: array
A list of price lists associated with the promotion.
Show Source
Nested Schema : ProjectRef
Type: object
Title: ProjectRef
The project reference resource.
Show Source
Nested Schema : AgreementRef
Type: object
Title: AgreementRef
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 : CategoryRef
Type: object
Title: CategoryRef
The category reference. The category resource groups product offerings, service candidates, and resource candidates in logical containers. Categories can contain other categories and/or product offerings, resource candidates, or service candidates.
Show Source
Nested Schema : CustomProfileSpecRefOracle
Type: object
Title: CustomProfileSpecRefOracle
The 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 for example White and Blue in an associated product offering. It should be noted that the list of values in 'ProductSpecificationCharacteristicValueUse' is a strict subset of the list of values as defined in the corresponding product specification characteristics.
Show Source
Nested Schema : customProfileSpecCharValue
Type: array
A list of custom profile specification characteristic values associated with the custom prof specification characteristic value use.
Show Source
Nested Schema : TimePeriodOracle
Type: object
Title: TimePeriodOracle
The validity period of the related party.
Show Source
Nested Schema : CustomProfileSpecCharValue
Type: object
Title: CustomProfileSpecCharValue
A number or text that can be assigned to a CustomProfileSpecCharacteristic.
Show Source
  • The base type of the custom profile specification characteristic value.
  • The URI of the schema that defines the custom profile specification characteristic value.
  • The class type of the custom profile specification characteristic value.
  • A string. A word, term, or phrase by which can be displyed for user experience.
  • Whether the custom profile specification characteristic value has enabled.
  • Whether the custom profile specification characteristic value is default.
  • 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". Valid values are OPEN, CLOSED, CLOSED_BOTTOM, and CLOSED_TOP.
  • The regular expression to define constraint on the allowed value.
  • The 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" ]
    The unit can be minutes or GB.
  • TimePeriodOracle
    Title: TimePeriodOracle
    The validity period of the related party.
  • value
    A discrete value that the characteristic can take on. The value type is defined by the valueType characteristic.
  • The low range value that a characteristic can take on.
  • The ID of the value reference associated with the custom profile specification characteristic value.
  • Allowed Values: [ "SERVICE_SPEC" ]
    The type or classification of the custom profile specification characteristic value. Valid values are SERVICE_SPEC.
  • 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", "SPEC_CHAR" ]
    The type or classification of the custom profile specification characteristic value. Valid values are STRING, NUMBER, OBJECT, ARRAY, DECIMAL, BOOLEAN, DATE, DATETIME, PRODUCT_OFFER, PRODUCT_SPEC, PRODUCT_LINE, and SPEC_CHAR.
Nested Schema : value
A discrete value that the characteristic can take on. The value type is defined by the 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
The 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
The error resource.
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
The error resource.
Show Source

404 Response

The resource with the specified URI couldn't be found.
Body ()
Root Schema : Error
Type: object
Title: Error
The error resource.
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
The error resource.
Show Source

500 Response

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

Examples

The following example shows how to update a promotion by submitting a patch request on the REST resource using cURL. 

curl  -H 'Authorization: Bearer <accessToken> -H PATCH https://{FusionAppsHost}/crmRestApi/actProductCatalog/11.13.18.05/tmf-api/promotion/v4/promotion/{id} -H "Content-Type: application/json" -D @update_promotion.json | json_pp

Example of Request Header

The following shows an example of the request header.

{
    "description" : "Promotion for Maximo",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
}

Example of Response Body

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

{
    "lastUpdate": "2025-02-17T13:17:45.452Z",
    "lastUpdatedBy": "booth",
    "created": "2025-01-06T11:48:59.000Z",
    "createdBy": "booth",
    "id": "PR-375956038-1736163967522",
    "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/tmf-api/promotionManagement/v4/promotion/PR-375956038-1736163967522",
    "name": "MaximPromo",
    "@type": "PromotionOracle",
    "version": "1.0",
    "description" : "Promotion for Maximo",
    "validFor": {
        "startDateTime": "2024-08-09T00:00:00.000Z",
        "endDateTime": "2028-08-09T00:00:00.000Z"
    }
    "project": {
        "id": "P-187012819-1736135169885",
        "name": "Maxim25BRevise",
        "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogManagement/v1/project/P-187012819-1736135169885",
        "version": "1.0",
        "@referredType": "ProjectOracle",
        "@type": "ProjectRef"
    },
    "lifecycleStatus": "In design",
    "promotionType": "DISCOUNT",
    "pattern": [
        {
            "id": "pattern-3497866394-17361641333",
            "name": "MaximEvent",
            "@type": "PromotionPatternOracle",
            "validFor": {
                "startDateTime": "2025-01-06T00:00:00.000Z"
            },
            "isRoot": true,
            "priority": 1,
            "criteriaGroupLogicalRelationship": "AND",
            "criteriaGroup": [
                {
                    "id": "CG-391486807-1736163999769",
                    "groupName": "Mcg1",
                    "@type": "PromotionCriteriaGroupOracle",
                    "criteriaLogicalRelationship": "AND",
                    "criteria": [
                        {
                            "id": "criteria-1474770635-1736164028",
                            "@type": "PromotionCriteriaOracle",
                            "valueType": "STRING",
                            "criteriaValue": "BC",
                            "criteriaOperator": "EQUALS",
                            "criteriaParameter": "PROVINCE"
                        },
                        {
                            "id": "criteria-2866709542-1736163999",
                            "@type": "PromotionCriteriaOracle",
                            "valueType": "STRING",
                            "criteriaValue": "CA",
                            "criteriaOperator": "EQUALS",
                            "criteriaParameter": "COUNTRY"
                        },
                        {
                            "id": "criteria-3639632569-1736164091",
                            "@type": "PromotionCriteriaOracle",
                            "valueType": "STRING",
                            "criteriaValue": "Aldergrove",
                            "criteriaOperator": "EQUALS",
                            "criteriaParameter": "CITY"
                        }
                    ]
                }
            ],
            "action": [
                {
                    "id": "action-3463403600-173616412981",
                    "@type": "PromotionActionOracle",
                    "actionType": [
                        "DISCOUNT"
                    ],
                    "actionValue": "0.01",
                    "actionValueObj": [
                        {
                            "versionState": 0,
                            "id": "PRICEALT-3671965284-1736164106",
                            "name": "ALtermaxim",
                            "actionObjectType": "PRODUCT_OFFERING_PRICE",
                            "@referredType": "ProductOfferPricePlanOracle",
                            "@type": "ActionObjectRefOracle",
                            "appliesTo": "ALL",
                            "maxQuantity": 1
                        }
                    ],
                    "eligibility": [
                        {
                            "versionState": 0,
                            "id": "ID-2602795941-1736134584060",
                            "name": "MaximPkgOffer",
                            "actionObjectType": "PRODUCT_OFFERING",
                            "@referredType": "ProductOfferingOracle",
                            "@type": "ActionObjectRefOracle"
                        }
                    ]
                }
            ],
            "patternRelationship": [
                {
                    "relationshipType": "TRUE_STATE",
                    "@type": "PatternRelationshipOracle"
                },
                {
                    "relationshipType": "FALSE_STATE",
                    "@type": "PatternRelationshipOracle"
                }
            ],
            "active": true
        }
    ],
    "priceList": [
        {
            "id": "DBE_NA_PL",
            "name": "DBE NA Pricelist",
            "href": "https://{FusionAppsHost}/crmRestApi/atcProductCatalog/11.13.18.05/productCatalogReferenceManagement/v1/pricelist/DBE_NA_PL",
            "version": "1.0",
            "@referredType": "PricelistOracle",
            "@type": "PriceListRefOracle"
        }
    ],
    "active": true
}
Back to Top