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

Get Reseller Discount Contracts

Description

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

  • Default Filter: None
  • Default Sorting Order: REMAINING_DURATION (Ascending)

Request

Request

URL

URL


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

Path Parameters

Path Parameters

string
orgId Required

ID of the partner organization in CSP


Query Parameters

Query Parameters

integer
pageLimit Optional

Number of results to be fetched per page


integer
pageStart Optional

Record number to be first on the page


Request Body

Request Body

ResellerDiscountContractRequest of mimetype application/json Optional

Reseller discount contracts summary filters

{
	"filters": [
		{
			"key": "STATUS",
			"operator": "IN",
			"value": [
				"ACTIVE"
			]
		},
		{
			"key": "DISTRIBUTOR_NAME",
			"operator": "LIKE",
			"value": "Ingram"
		},
		{
			"key": "CUSTOMER_NAME",
			"operator": "LIKE",
			"value": "Coke"
		},
		{
			"key": "CBC_CONTRACT_ID",
			"operator": "LIKE",
			"value": "123"
		},
		{
			"key": "CURRENCY",
			"operator": "LIKE",
			"value": "USD"
		}
	],
	"period": "CURRENT",
	"sorter": {
		"key": "CURRENT_REMAINING_DURATION",
		"operator": "ASC"
	}
}
array of object
filters Optional

A list of filters for discount contracts list for Reseller


sorter Optional

A sorter for discount contracts list for Reseller

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns ResellerDiscountContractsMinusPricingPage of type application/json
{
	"aggregates": {
		"currentYear": {
			"expired": 0,
			"total": 3
		},
		"totalYears": {
			"expired": 0,
			"total": 3
		}
	},
	"data": {
		"current": 1,
		"next": 5,
		"results": [
			{
				"billingEngineDiscountContractId": "12345",
				"currency": "USD",
				"currentYear": {
					"endDate": "12/10/2022",
					"startDate": "12/10/2021"
				},
				"customerName": "Coke",
				"distributorName": "Ingram",
				"expiring": false,
				"status": "ACTIVE",
				"totalYears": {
					"endDate": "12/10/2022",
					"startDate": "12/10/2019"
				}
			},
			{
				"billingEngineDiscountContractId": "23456",
				"currency": "USD",
				"currentYear": {
					"endDate": "1/10/2023",
					"startDate": "1/10/2022"
				},
				"customerName": "Mountain Dew",
				"distributorName": "Ingram",
				"expiring": false,
				"status": "ACTIVE",
				"totalYears": {
					"endDate": "3/10/2023",
					"startDate": "3/10/2021"
				}
			},
			{
				"billingEngineDiscountContractId": "34567",
				"currency": "EURO",
				"currentYear": {
					"endDate": "2/15/2023",
					"startDate": "2/15/2022"
				},
				"customerName": "Coke",
				"distributorName": "Ingram",
				"expiring": false,
				"status": "ACTIVE",
				"totalYears": {
					"endDate": "2/15/2025",
					"startDate": "2/15/2020"
				}
			}
		],
		"totalResultsCount": 3
	}
}
aggregates Optional

Current and total years discount contracts aggregates


data Optional

Reseller Discount Contracts minus pricing

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":"STATUS","operator":"IN","value":["ACTIVE"]},{"key":"DISTRIBUTOR_NAME","operator":"LIKE","value":"Ingram"},{"key":"CUSTOMER_NAME","operator":"LIKE","value":"Coke"},{"key":"CBC_CONTRACT_ID","operator":"LIKE","value":"123"},{"key":"CURRENCY","operator":"LIKE","value":"USD"}],"period":"CURRENT","sorter":{"key":"CURRENT_REMAINING_DURATION","operator":"ASC"}}' https://{api_host}/resellers/{orgId}/discount-contracts/search


Feedback

Was this page helpful?