Get reseller sales prices¶

Returns reseller sales prices.

Prerequisites¶

Credentials as described in Authentication

C#¶

To get reseller sales prices, first create an instance of CrayonApiClient and get the token using CrayonApiClient instance.

Then call ResellerSalesPrices.Get() method to get reseller sales prices by passing token and filter.

var filter = new ResellerSalesPriceFilter
{
    ResellerSalesPriceType = /* Filters by the type of reseller sales price. If not set (null), this filter is ignored */,
    ObjectId = /* The ID of the object that the sales price is associated with */,
    ResellerSalesPriceObjectType = /* Indicates the type of object the sales price applies to */,
    FromDate = /* Filters for sales prices that are valid from this specific date onward. If null, no lower bound on the date is applied. */
};

var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var result = client.ResellerSalesPrices.Get(token, filter);

Request¶

Request Syntax:

Method	Request URI
GET	https://api.crayon.com/api/v1/resellersalesprices/?resellerSalesPriceType={resellerSalesPriceType}&objectId={objectId}&resellerSalesPriceObjectType={resellerSalesPriceObjectType}&fromDate={fromDate}

Request Parameters:

Name	Type	Required	Description
resellerSalesPriceType	Enum	No	License = 1, Usage = 2, NCELicense = 3, AzurePlan = 4, AzureReservation = 5, Software = 6
objectId	int	Yes	The ID of the object that the sales price is associated with
resellerSalesPriceObjectType	int	Yes	Organization = 1, CustomerTenant = 2, Subscription = 3, SubscriptionAddon = 4, AzureSubscription = 5, Asset = 6
fromDate	int	No	Pagination, Number of objects to return

Request Headers:

The following HTTP request headers are supported

Header	Type	Description
Authorization	string	Required. The authorization token in the form Bearer <token>.
Accept	string	Specifies the request and response type, “application/json”.
Content-Type	string	Specifies the media type of the resource, “application/json”.

Request Example:

GET $"https://api.crayon.com/api/v1/resellersalesprices/?resellerSalesPriceType={resellerSalesPriceType}&objectId={objectId}&resellerSalesPriceObjectType={resellerSalesPriceObjectType}&fromDate={fromDate}"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response¶

If successful, this method returns a collection of ResellerSalesPrice resource in the response body.

[
    {
        "ObjectId": 1234,
        "ObjectType": 2,
        "Type": 3,
        "PriceType": 2,
        "Value": 15.75,
        "FromDate": "2025-01-15T00:00:00+00:00"
    },
    {
        "ObjectId": 1223,
        "ObjectType": 3,
        "Type": 3,
        "PriceType": 2,
        "Value": 18.75,
        "FromDate": "2025-01-15T00:00:00+00:00"
    }
]

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes	Description
200 Ok	The request has succeeded.
401 Unauthorized	The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.

Get reseller sales prices¶

Prerequisites¶

C#¶

Request¶

Response¶

Was this page helpful?

Was this page helpful?