[{"label":"Latest (1.0)","version":"latest"}]
cloud-partner-navigator

Get Reseller Redemptions

Description

For a specified Reseller organization, retrieves all redemption data against a specified discount contract. The redemption list is paginated. Filtration of the redemption list can be done using appropriate parameters in request body.

  • Default Filter: REDEEMED_DATE BETWEEN (Previous Quarter)
  • Default Sorting Order: REDEEMED_DATE (Descending)

Request

Request

URL

URL


post
https://{api_host}/resellers/{orgId}/discount-contracts/{billingEngineDiscountContractId}/redemptions/search
Copy

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


string
billingEngineDiscountContractId Required

Billing Engine Discount Contract ID


Query Parameters

Query Parameters

integer
pageLimit Optional

Number of results to be fetched per page


integer
pageStart Optional

Result number to be first on the page


Request Body

Request Body

RedemptionRequest of mimetype application/json Optional

Redemption data filters for Reseller

{
	"filters": [
		{
			"key": "SUBSCRIPTION_ID",
			"operator": "EQUALS",
			"value": "M0353803413"
		},
		{
			"key": "CUSTOMER_NAME",
			"operator": "LIKE",
			"value": "Coke Inc"
		},
		{
			"end": "2023-09-15T06:07:50.000Z",
			"key": "REDEEMED_DATE",
			"operator": "BETWEEN",
			"start": "2022-09-15T06:07:51.000Z"
		}
	]
}
array of object
filters Optional

Redemption filters such as SUBSCRIPTION_ID or CUSTOMER_NAME

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ResellerRedemptionPage of type application/json
{
	"current": 1,
	"next": 3,
	"results": [
		{
			"arInvoiceNumber": "4900001337",
			"billDocNumber": "1318566905",
			"billingFrequency": "PREPAID",
			"billingTerm": "12",
			"currency": "USD",
			"customerName": "IQVIA",
			"extendedPrice": 265133.7,
			"offerType": "COMMIT",
			"orgId": "3e46b5fb-de5d-4fbb-9d69-e6a08b5af88b",
			"orgName": "jxlygmpq",
			"quantity": 6,
			"redeemedDate": "2021-11-11 00:00:00",
			"sku": "VMC_AWS_I3_CP",
			"skuDescription": "VMware Cloud on AWS - Per i3 Host - Commitment",
			"subscriptionId": "M1823001248"
		}
	],
	"totalResultsCount": 100
}
integer as int32
current Optional

First result on the current page


integer as int32
next Optional

First result on the next page


results Optional

Redemption data for a reseller. The data is paginated.


integer as int32
totalResultsCount Optional

The total number of results

Errors

Errors

ErrorResponse
400

Bad Request - The request is either incomplete or incorrect


ErrorResponse
401

Unauthorized - The request requires user authentication


ErrorResponse
403

Forbidden - User does not have permission for this operation


ErrorResponse
404

Not Found - The requested resource does not exist


ErrorResponse
500

Internal Server Error - Please contact support

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"filters":[{"key":"SUBSCRIPTION_ID","operator":"EQUALS","value":"M0353803413"},{"key":"CUSTOMER_NAME","operator":"LIKE","value":"Coke Inc"},{"end":"2023-09-15T06:07:50.000Z","key":"REDEEMED_DATE","operator":"BETWEEN","start":"2022-09-15T06:07:51.000Z"}]}' https://{api_host}/resellers/{orgId}/discount-contracts/{billingEngineDiscountContractId}/redemptions/search


Feedback

Was this page helpful?