Get Resellers Plans
    • 27 Oct 2024
    • 1 Minute to read
    • Dark
      Light
    • PDF

    Get Resellers Plans

    • Dark
      Light
    • PDF

    Article summary

    Get a list of active plans in C3 instance

    URL

    GET https://contoso-prod-api.azurewebsites.net/api/resellerplans/downloadDetails

    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": "c76d5caf-226d-4784-b5ab-7ffd42dc68e0",
        "ErrorMessage": null,
        "ErrorDetail": null,
        "Data": [
            {
                "Name": "No markup Plan for Reseller",
                "Description": "1No margin on Microsoft list price, cos to cost",
                "InternalPlanId": "CC6615BC-78DD-4015-A007-22780F23CD9A",
                "CurrencyCode": "USD",
                "PlanStatus": "Success",
                "MacroDetails": "Copy Partner Price",
                "MacroValue": 0.0000,
                "Attributes": "{\"CanPriceLead\":false,\"CanPriceLag\":false}",
                "MarketCode": "US"
            },

    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

    Name

    Name of plan defined in C3

    Description

    Description of the plan created

    InternalPlanId

    Unique identifier for the Plan in C3

    CurrencyCode
    Currency in which offer is available for end customer

    PlanStatus

    Current Status of plan

    Possible Values are

    MacroDetails

    Macro applied on the plan (if any)

    MacroValue

    Value of the Macro (if applied on the plan)

    Attributes

    Currency in which plan is created and offers will be shown to reseller in their product catalogue

    MarketCode
    Market for the plan

    Was this article helpful?