Additional Adobe Management Methods

The functions in this section used to be done as Custom Events. We have now replaced Custom Events with the API in a multi-account extension.

Please use the API specifications included below for these activities.

Note: In each case, "environment" is an optional parameter with the following allowed values:

  • development

  • test

  • production

If "environment" is not sent in the payload, the "production" environment will be selected by default.

 

Getting Transfer Offers

GET https://{service_url}/adobe/transfer/preview

Request Body Example

Copy
    
                {
                    "marketplace": "MP-65669",
                    "environment": "test",
                    "membership": "40XZAA4VWTSVSVNT5U6W" 
                }

Response Example

Copy
                {
                    "totalCount": 2,
                    "items": [
                        {
                            "offerId": "65304479CA01A12",
                            "quantity": 10,
                            "renewalDate": "2022-07-16",
                            "adobeProductName": "Adobe Audition for teams - Multiple Platforms - (US/CA)",
                            "connectItemId": "PRD-207-752-513-0014"
                        },
                        {
                            "offerId": "65304479CA02A12",
                            "quantity": 8,
                            "renewalDate": "2022-07-16",
                            "adobeProductName": "Adobe Audition for teams - Multiple Platforms - (US/CA)",
                            "connectItemId": "PRD-207-752-513-0014"
                        }
                ]
            }

Getting an Order Preview

GET https://{service_url}/adobe/order/preview

Request Body Example

Copy
{
                    "marketplace":"MP-00000",   
                    "customer":"P0000000000",
                    "price": false,
                    "items":[      
                      {
                          "offerId":"65304520CA01A12",
                          "quantity": 100
                          "discountcode"
                      }
                    ],
                    "environment": "test"
                 }
Property Type Required Description
marketplace String Yes Marketplace ID. For Example, MP-00000
customer String Yes Customer ID. For example, P0000000000
price String No It can be set to true or false.
environment String Yes Allowed values: test, development or production
items String No

You can specify the offer ID the quantity and a discount code in the request to see the corresponding line items in the response.

  • offerId

String No Offer ID
  • subscriptionId

String No Subscription ID
  • discountcode

String No Discount code

Response Example

Copy
                {
                    "customerId": "P1005027361",
                    "currencyCode": "USD",
                    "creationDate": "2022-06-16T15:15:25.000+00:00",
                    "lineItems": [
                        {
                            "extLineItemNumber": 1,
                            "offerId": "65304520CA04A12",
                            "quantity": 100
                        },
                        {
                            "extLineItemNumber": 2,
                            "offerId": "65304520CA04A12",
                            "quantity": 100
                        }
                    ],
                    "references": []
            }

Getting an Order Renewal Preview

GET https://{service_url}/order/preview_renewal

Request Body Example

Copy
{
  "marketplace": "MP-65669",
  "customer": "P0000000000",
  "price": true,
  "environment": "development"
  "items": {
    [
        {
        "offerId": "80004567EA01A12",
        "subscriptionId": "e0b170437c4e96ac5428364f674dffNA"
        }
    ]
}
}

All the parameters in the request body example above are mandatory, except for Price and Items. If Price is used and set to True, the response will provide the available discounts, if any.

Property Type Required Description
marketplace String Yes Marketplace ID. For Example, MP-00000
customer String Yes Customer ID. For example, P0000000000
price String No It can be set to True or False.
environment String Yes Allowed values: test, development or production
items String No

You can specify the offer ID and subscription ID in the request to see the corresponding line items in the response.

Important: This can only be used during the 30-day period following the renewal date if the subscription was not renewed.

  • offerId

String No Offer ID
  • subscriptionId

String No Subscription ID

Response Examples

The following is an example of the response when 'items' is used in the request body and price is set to false.

Copy
{
    "referenceOrderId": "",
    "externalReferenceId": "",
    "orderId": "",
    "customerId": "P0000000000",
    "currencyCode": "",
    "orderType": "PREVIEW_RENEWAL",
    "status": "",
    "lineItems": [
        {
            "extLineItemNumber": 1,
            "offerId": "65305409CA12A12",
            "quantity": 30,
            "subscriptionId": "cd8ff00af5408745f5e69cda17896fNA",
            "status": "1000",
            "currencyCode": "USD"
        }
    ],
    "creationDate": "2025-10-03T11:22:11Z"

The following response is received when 'items' is used in the request body and Price is set to "true".

Copy
{
    "referenceOrderId": "",
    "externalReferenceId": "",
    "orderId": "",
    "customerId": "P0000000000",
    "currencyCode": "",
    "orderType": "PREVIEW_RENEWAL",
    "status": "",
    "lineItems": [
        {
            "extLineItemNumber": 1,
            "offerId": "65305409CA12A12",
            "quantity": 30,
            "subscriptionId": "cd8ff35af7452585f5e69cda11288fNA",
            "status": "1000",
            "currencyCode": "USD",
            "proratedDays": 365,
            "pricing": {
                "partnerPrice": 394.2,
                "discountedPartnerPrice": 394.2,
                "netPartnerPrice": 394.2,
                "lineItemPartnerPrice": 11826.0
            }
        }
    ],
    "pricingSummary": [
        {
            "totalLineItemPartnerPrice": 11826.0,
            "currencyCode": "USD"
        }
    ],
    "creationDate": "2025-10-03T11:18:41Z"
}

In this case, eligible offers are included in the response because the customer has high-growth offers.

Copy
{

    "referenceOrderId": "",

    "externalReferenceId": "",

    "orderId": "",

    "customerId": "customer_id",

    "currencyCode": "",

    "orderType": "PREVIEW_RENEWAL",

    "status": "",

    "lineItems": [

        {

            "extLineItemNumber": 1,

            "offerId": "65304520CA14X12",

            "quantity": 100,

            "subscriptionId": "subscriptionId",

            "status": "1000",

            "currencyCode": "USD"

        },

        {

            "extLineItemNumber": 2,

            "offerId": "65322651CA14A12",

            "quantity": 100,

            "subscriptionId": "subscriptionId",

            "status": "1000",

            "currencyCode": "USD"

        }

    ],

    "eligibleOffers": [

        {

            "offerId": "65304520CA14Y12",

            "renewalCode": "MOQ_250",

            "eligibilityCriteria": {

                "minQuantity": 250,

                "additionalCriteria": [

                    "THREE_YEAR_COMMIT"

                ],

                "deploymentId": ""

            }

        },

        {

            "offerId": "65304520CA14Z12",

            "renewalCode": "MOQ_500",

            "eligibilityCriteria": {

                "minQuantity": 500,

                "additionalCriteria": [

                    "THREE_YEAR_COMMIT"

                ],

                "deploymentId": ""

            }

        },

        {

            "offerId": "65322651CA14Y12",

            "renewalCode": "MOQ_250",

            "eligibilityCriteria": {

                "minQuantity": 250,

                "additionalCriteria": [

                    "THREE_YEAR_COMMIT"

                ],

                "deploymentId": ""

            }

        },

        {

            "offerId": "65322651CA14Z12",

            "renewalCode": "MOQ_500",

            "eligibilityCriteria": {

                "minQuantity": 500,

                "additionalCriteria": [

                    "THREE_YEAR_COMMIT"

                ],

                "deploymentId": ""

            }

        }

    ],

    "creationDate": "2025-08-20T17:17:19Z"

}

Subscription Auto-Renewal Management

POST https://{service_url}/adobe/subscription/autorenewal

Request Body Example

Copy
                {
                    "asset_id":"AS-2401-7425-8616",
                    "marketplace":"MP-65669",                
                    "environment": "test",
                    "autorenewal": true
                }

Response Example

Copy
                
                {
                    "success": True,
                    "adjustment_request_id": "PR-XX"
                }

Getting Flexible Discounts

GET https://{service_url}/flexible/discounts

Request Body Example

Copy
{
    "tier_id": "TA-2994-0000-8992",
    "country": "US",
    "market_segment": "COM"
    "environment": "development"
}

Parameters

In this table you can find the parameters that can be used in the request.

Property Type Required Description
tier_id String Yes Tier ID. For example: TA-0000-0000-0000
country String Yes The country code must consist of two characters (ISO 3166-1 alpha-2)
market_segment String Yes The market segment options are the following: COM, GOV, EDU
environment String Yes Allowed values: test, development or production
offer_ids String No Comma-separated list of SKUs.
flex_discount_id String No Discount ID on Adobe side.
flex_discount_code String No Discount code on Adobe side.
start_date String No Start date.
end_date String No End date.
limit String No Number of items to be retrieved.
page String No Page to be retrieved.

Response Example

Copy
[
    {
        "id": "55555555-7425-4e8a-9a2f-fb6a6b08f745",
        "name": "Adobe All Flexible Discount",
        "description": "Exclusive 20 fixed off on select products",
        "code": "ADOBE_ALL_PROMOTION",
        "type": "FIXED_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-03-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "FIXED_DISCOUNT",
                "values": [
                    {
                        "discountValue": 20.0,
                        "discountCountry": "US",
                        "discountCurrency": "USD"
                    }
                ]
            }
        ],
        "offerIds": [
            "65322651CA01A12",
            "65322650CA01A12",
            "65304521CA01A12",
            "65304839CA01A12",
            "65304768CA01A12",
            "65322648CA01A12",
            "65322646CA01A12",
            "65304520CA01A12",
            "30008891CA01A12"
        ]
    },
    {
        "id": "555555463-8768-4e8a-9a2f-fb6a6b08f558",
        "name": "Black Friday Flexible Discount - FAILURE - Market Segment",
        "description": "Exclusive 20 fixed off on CC All Apps + Adobe Stock, Acrobat Pro - Enterprise and other select products",
        "code": "BLACK_FRIDAY_20_FAILURE_1",
        "type": "FIXED_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-03-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "FIXED_DISCOUNT",
                "values": [
                    {
                        "discountValue": 20.0,
                        "discountCountry": "US",
                        "discountCurrency": "USD"
                    }
                ]
            }
        ],
        "offerIds": [
            "65322651CA01A12",
            "65322650CA01A12",
            "65304839CA01A12",
            "65322648CA01A12",
            "65322646CA01A12"
        ]
    },
    {
        "id": "55555555-8768-4e8a-9a2f-fb6a6b08f7256",
        "name": "Black Friday Flexible Discount - FAILURE - Customer Segment",
        "description": "Exclusive 20 fixed off on CC All Apps + Adobe Stock, Acrobat Pro - Enterprise and other select products",
        "code": "BLACK_FRIDAY_20_FAILURE_2",
        "type": "FIXED_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-03-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "FIXED_DISCOUNT",
                "values": [
                    {
                        "discountValue": 20.0,
                        "discountCountry": "US",
                        "discountCurrency": "USD"
                    }
                ]
            }
        ],
        "offerIds": [
            "65322651CA01A12",
            "65322650CA01A12",
            "65304839CA01A12",
            "65322648CA01A12",
            "65322646CA01A12"
        ]
    },
    {
        "id": "555745-8768-4e8a-9a2f-fb6a6b08f7485",
        "name": "Easter Flexible Discount",
        "description": "Exclusive 26 fixed off on Adobe Technical Communication Suite",
        "code": "EASTER_26",
        "type": "FIXED_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-06-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "FIXED_DISCOUNT",
                "values": [
                    {
                        "discountValue": 26.0,
                        "discountCountry": "US",
                        "discountCurrency": "USD"
                    }
                ]
            }
        ],
        "offerIds": [
            "65304768CA01A12"
        ]
    },
    {
        "id": "55557455-8768-4e8a-9a2f-fb6a6b08f753",
        "name": "Flexible Discount for COM for all countries - FAILURE",
        "description": "Exclusive 15% off on all products for COM",
        "code": "FLEX_DISC_COM_ALL_COUNTRIES_FAILURE",
        "type": "PERCENTAGE_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-01-01T10:00:48Z",
        "endDate": "2030-12-31T10:16Z",
        "discounts": [
            {
                "type": "PERCENTAGE_DISCOUNT",
                "values": [
                    {
                        "discountValue": 15.0,
                        "discountCountry": "",
                        "discountCurrency": ""
                    }
                ]
            }
        ],
        "offerIds": []
    },
    {
        "id": "74555555-8768-4e8a-9a2f-fb6a6b08f746",
        "name": "Flexible Discount for COM for all countries",
        "description": "Exclusive 15% off on all products for COM",
        "code": "FLEX_DISC_COM_ALL_COUNTRIES",
        "type": "PERCENTAGE_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-01-01T10:00:48Z",
        "endDate": "2030-12-31T10:16Z",
        "discounts": [
            {
                "type": "PERCENTAGE_DISCOUNT",
                "values": [
                    {
                        "discountValue": 15.0,
                        "discountCountry": "",
                        "discountCurrency": ""
                    }
                ]
            }
        ],
        "offerIds": []
    },
    {
        "id": "55557458-8768-4e8a-9a2f-fb6a6b08f756",
        "name": "Black Friday Flexible Discount - FAILURE - Product Arrangement Code",
        "description": "Exclusive 20 fixed off on CC All Apps + Adobe Stock, Acrobat Pro - Enterprise and other select products",
        "code": "BLACK_FRIDAY_20_FAILURE_4",
        "type": "FIXED_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-03-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "FIXED_DISCOUNT",
                "values": [
                    {
                        "discountValue": 20.0,
                        "discountCountry": "US",
                        "discountCurrency": "USD"
                    }
                ]
            }
        ],
        "offerIds": [
            "65322651CA01A12",
            "65322650CA01A12",
            "65304839CA01A12",
            "65322648CA01A12",
            "65322646CA01A12"
        ]
    },
    {
        "id": "55555758-8768-4e8a-9a2f-fb6a6b08f7598",
        "name": "Black Friday Flexible Discount - FAILURE - Country",
        "description": "Exclusive 22% off on Adobe Technical Communication Suite and Adobe Express for Teams",
        "code": "BLACK_FRIDAY_22_FAILURE_3",
        "type": "PERCENTAGE_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-03-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "PERCENTAGE_DISCOUNT",
                "values": [
                    {
                        "discountValue": 22.0,
                        "discountCountry": "",
                        "discountCurrency": ""
                    }
                ]
            }
        ],
        "offerIds": [
            "65304768CA01A12",
            "30008891CA01A12"
        ]
    },
    {
        "id": "55555555-8768-4e8a-9a2f-fb6a6b08f758",
        "name": "Commercial Kickstart Flexible Discount",
        "description": "Exclusive 24% off on Adobe Express for Teams",
        "code": "COMMERCIAL_KICKSTART_24",
        "type": "PERCENTAGE_DISCOUNT",
        "status": "ACTIVE",
        "startDate": "2025-03-12T10:00:48Z",
        "endDate": "2026-03-07T10:16Z",
        "discounts": [
            {
                "type": "PERCENTAGE_DISCOUNT",
                "values": [
                    {
                        "discountValue": 24.0,
                        "discountCountry": "",
                        "discountCurrency": ""
                    }
                ]
            }
        ],
        "offerIds": [
            "30008891CA01A12"
        ]
    }
]