Get active Offers
    • 26 Oct 2024
    • 2 Minutes to read
    • Dark
      Light
    • PDF

    Get active Offers

    • Dark
      Light
    • PDF

    Article summary

    Get a list of all active Offers in C3

    URL

    GET https://contoso-prod-api.azurewebsites.net/api/ActiveOffers

    Request headers

    Key

    Value

    Authorization

    Bearer <access_token>

    Content-Type

    Application/json

    Request body

    The request doesn’t require any parameters / body

    Response body

    An example response for the request to get active customers is as follows:

    {
        "OperationType": null,
        "Status": "Success",
        "RequestCorrelationID": "e7c14348-5d4a-473f-91d5-27503c93923f",
        "ErrorMessage": null,
        "ErrorDetail": null,
        "Data": [
            {
                "ProductName": "Dynamics 365 Field Service (Non-Profit Pricing)",
                "ProviderOfferId": "NL:CFQ7TTC0LFNL:0015:P1M:Monthly",
                "CategoryName": "OnlineServicesNCE",
                "ProviderName": "Microsoft",
                "BillingCycleName": "Monthly",
                "CurrencyCode": "EUR",
                "PriceforPartner": 26.5700,
                "ProviderSellingPrice": 29.5200,
                "Validity": 1,
                "ValidityType": "Month(s)",
                "ProviderCategory": "nonprofit",
                "ProductSKUId": "c7d15985-e746-4f01-b113-20b575898250",
                "UniqueProviderOfferId": "NL:CFQ7TTC0LFNL:0015:P1M:Monthly:nonprofit",
                "MinimumQuantity": 1,
                "MaximumQuantity": 10000000,
                "PromotionalId": "39NFJQT1VD5M:004H:39NFJQT1Q5PC",
                "PromotionDescription": "16.67% discount on nonprofit MTM offers for new customers and new subscriptions for existing customers ",
                "PromotionStartDate": "2024-03-18T00:00:00",
                "PromotionEndDate": "2024-12-31T00:00:00",
                "PromotionAutoApplicable": true,
                "PromotionDiscountType": "PercentDiscount",
                "PromotionDiscount": 16.6700,
                "MarketCode": "NL",
                "EffectiveStartDate": "2024-10-01T00:00:00",
                "EffectiveEndDate": "9999-11-30T00:00:00",
                "ChangeType": "CHG",
                "IsLatest": true,
                "IsTrialOffer": false
            },

    Here is the explanation for the properties in the response (JSON) 

    Property

    Description

    OperationType

    Can be ignored

    Status

    Indicates the status of the request. Possible values – Success / Error

    RequestCorrelationID

    Internal ID generated by C3 for correspondence for troubleshooting issues, if any.

    ErrorMessage

    Message in case the request runs into an error during processing

    ErrorDetail

    Additional detail related to the error in case there is an error while processing the request

    Data

    Contains a list of customer objects represented by the following attributes:

    Attribute

    Description

    ProductName

    name of the product/offer

    ProviderOfferId

    offer id of the product;Syntax : Market : Product ID : SKU ID : Term Duration : Billing Plan

    CategoryName

    category of the product like Online Service/Azure Plan/New Commerce Experience/Perpetual

    ProviderName

    Company publishing the offer

    BillingCycleName

    billing cycle of the offer like monthly/annual/onetime

    CurrencyCode

    Currency of the offer

    PriceforPartner

    Cost to partner/List Price

    ProviderSellingPrice

    Retail price of the offer/ERP Price

    Validity

    validity of the offer

    ValidityType

    months/years

    ProviderCategory

    Category of the product like Corporate/Academic/Non-profit/educational/Commercial

    ProductSKUId

    Unique Identifier for an offer in MS

    UniqueProviderOfferId
    Combined value of Provider Offer id and Provider Category to make it unique with syntax as: Market : Product ID : SKU ID : Term Duration : Billing Plan : ProviderCategory
    MinimumQuantity
    Minimum number of licenses that can be purchased
    MaximumQuantity
    Maximum number of licenses that can be purchased
    PromotionalId
    It includes the product, SKU, and availability ID for the promotion
    PromotionDescription
    Explanation about the price change
    PromotionStartDate
    Day when promotion becomes applicable
    PromotionEndDate
    Day when promotion is not applicable anymore
    PromotionAutoApplicable
    Whether promotions get applied to offer automatically or not represented by true/false
    PromotionDiscountType
    Type of discount whether percentage based or fixed amount based
    PromotionDiscount
    The percentage discount for the promotion. The discount is applied to the partner price (not estimated retail price(ERP))
    MarketCode
    Market for the item
    EffectiveStartDate
    The day and time a change to product metadata becomes valid. May be an actual date (example: 2024) or placeholder year (example: 1753).
    EffectiveEndDateThe day and time a change to product metadata ceases to be valid. May be an actual date (example: 2024) or placeholder year (example: 9999).
    ChangeType
    Change Indicator to offer from MS as per latest pricing sheet with possible values as below
    ADD
    A new item to the price list.
    CHG
    Changes in list price from month to month. Other changes not related to list price might occur, partners should compare price lists between months to determine changes to other properties .
    DEL
    An item removed from the price list.
    UNC
    List price unchanged from the previous month's price list.
    DEPR
    Offer is no longer purchasable in legacy commerce. Partner must purchase the new commerce equivalent.
    IsLatest
    True/False
    IsTrialOffer
    True/False

    Was this article helpful?