Find Deal
Find a specific deal and the priced line items.
Headers
| Property | Value |
|---|---|
| Request Type | POST |
| Content Type | application-json |
| URL | {{EnvironmentURL}}/api/services/app/Deals/FindDeal |
Please see Environments under Getting Started for test and production environment URLs.
Request Parameters
| Property | Type | Description | Required |
|---|---|---|---|
| Deal Type | int | Type of deal that is being searched for. List of deal types: (MarketplaceQuote = 1, CCWQuote = 2, CCWEstimate = 3, HPEIQouteBasket = 4, CCWRenewal = 5). | ✓ |
| Deal Identifier | string | Unique deal identifier. | ✓ |
| Market | int | Market the deal is related to. See Constants (Enums) for available markets. | ✓ |
Sample Request
{
"dealIdentifier": "AVA-D-00000000000J",
"dealType": 1,
"Market":14
}
Response Parameters
| Property | Type | Description |
|---|---|---|
| Deal Identifier | int | Unique identifier for the deal. |
| Market | enum | Market the deal is related to. See Constants (Enums) for available markets. |
| Deal Type | enum | Type of deal that is being searched for. See Constants (Enums) for available deal types. |
| Tenant ID | int | Partner ID associated with the deal. |
| Customer ID | int | Customer ID associated with the deal. |
| Created Date | dateTime | Date deal was created. |
| Expiry Date | dateTime | Date the deal is expiring. |
| Is IsActive | bool | Boolean flag to indicate if the deal is active. |
| Status | enum | Status of the deal values can be as follow (Approved, Saved, Approval in Progress, Ordered, Draft). |
| Total Inc | decimal | Deal total including VAT. |
| Total Exc | decimal | Deal total excluding VAT. |
| Sell Currency | string | Deal currency. |
| Description | string | Description of the deal. |
| Estimated Time of Delivery | dateTime | Estimate date for the delivery. |
| Tenant | dateTime | Estimate date for the delivery. |
| Tenant Object Start | ||
| - Tenant ID | int | Internal ID associated with the partner. |
| - Account Number | string | Partner account number. |
| - Is Active | string | Indicates whether partner is active or not on Axiz Digital. |
| - Name | string | Partner Name |
| - Registration Number | string | Partner registration number. |
| - VAT Number | string | Partner VAT number. |
| - Tenant Address | string | Partner address information. |
| Customer Object Start | ||
| - Customer ID | int | Internal ID associated with the customer. |
| - Name | string | |
| - Description | string | |
| - accountNumber | string | |
| - customerAddress | string | Customer address information. |
| - Tenant Id | int | Partner ID associated with the customer. |
| Items | Collection(AvaDealLineItemDto) | List of deal line items. |
| Services | Collection(AvaDealServiceDto) | Extra added services. |
| Additional Info | Dictionary | Additional information for the deal in key value pair format. |
| Contact Person | ||
| Full Name | string | Deal contact person full name. |
string | Deal contact person email Address. | |
| Phone Number | string | Deal contact person phone number. |
Sample Response
{
"name": null,
"description": "Ava Deal",
"Items": [
{
"lineNumber": null,
"estimatedTimeOfArrival": "0001-01-01T00:00:00",
"services": null,
"childLineItems": [],
"purchaseDecision": {
"tenantId": null,
"customerId": null,
"product": {
"imageUrl": null,
"brandInfo": null,
"category": null,
"availableToSell": 0,
"estimatedTimeOfArrival": null,
"discount": 0.0,
"discountPercentage": 0.0,
"price": 17507.02,
"currencyCode": null,
"promotions": null,
"tags": [],
"isDeal": false,
"productIdentifier": "QUAKEN16_RPLP_2401_2802_E_M2CH",
"name": "Dell Insp 5630/Core i7-1360P/16GB/512GB SSD/16\" FHD+/Intel Iris Xe/FgrPr/Cam & Mic/WLAN + BT/Backlit Kb/4 Cell/W11Home/1Y Basic Onsite",
"description": "Dell Insp 5630/Core i7-1360P/16GB/512GB SSD/16\" FHD+/Intel Iris Xe/FgrPr/Cam & Mic/WLAN + BT/Backlit Kb/4 Cell/W11Home/1Y Basic Onsite",
"brand": 4,
"market": 14,
"itemType": 0,
"additionalInfo": {
"ParentProductId": ""
},
"vendorId": null,
"dealType": null
},
"productConfigurationId": null,
"purchaseOptionId": 0,
"purchaseOptionDescription": null,
"autoRenew": null,
"quantity": 1,
"addOns": null,
"billing": null,
"billingFrequencyType": null,
"term": null,
"termUnitOfMeasure": null,
"offerId": null,
"parentOfferId": null
},
"pricingSummary": {
"discount": 0.0,
"discountPercentage": 0.0,
"unitPriceInc": 0.0,
"unitPriceExc": 17507.02,
"sellPriceInc": 20133.07,
"sellPriceExc": 17507.02,
"quantity": 0,
"inStock": true,
"currencyCode": "ZAR",
"splitIndicator": "NORMAL",
"roeUsed": 1.0,
"duties": 0.0,
"resellerOriginalSellPrice": 17507.02,
"availableToSell": 11.0,
"unitListPrice": 0.0,
"extendedListPrice": 0.0,
"tags": null,
"exception": null,
"upliftSum": 0.0,
"margin": 1050.42,
"roEConvertedListPrice": 0.0,
"additionalInfo": null
},
"splitPricing": [
{
"discount": 0.0,
"discountPercentage": 0.0,
"unitPriceInc": 0.0,
"unitPriceExc": 17507.02,
"sellPriceInc": 20133.07,
"sellPriceExc": 17507.02,
"quantity": 0,
"inStock": true,
"currencyCode": "ZAR",
"splitIndicator": "NORMAL",
"roeUsed": 1.0,
"duties": 0.0,
"resellerOriginalSellPrice": 17507.02,
"availableToSell": 11.0,
"unitListPrice": 0.0,
"extendedListPrice": 0.0,
"tags": null,
"exception": null,
"upliftSum": 0.0,
"margin": 1050.42,
"roEConvertedListPrice": 0.0,
"additionalInfo": null
}
],
"additionalInfo": {
"DealId": "0"
}
}
],
"estimatedTimeOfDelivery": "0001-01-01T00:00:00",
"services": null,
"exception": "",
"dealIdentifier": "55",
"dealType": 1,
"brand": 0,
"status": "Draft",
"market": 14,
"createdDate": "2023-09-11T07:20:41.923",
"expiryDate": "2023-09-11T07:20:41.923",
"tenant": null,
"customer": null,
"tenantId": 5197,
"customerId": 778,
"sellCurrency": null,
"totalInc": 20133.0730,
"totalExc": 17507.02,
"additionalInfo": {
"IsActive": "True",
"ExportMessage": null,
"DealId": "55",
"DealReference": "Test Uat 1",
"TicketNumber": "Test Uat 1",
"PartnerAccount": "SJKO9921"
},
"contactPerson": {
"fullName": "John Doe",
"email": "[email protected]",
"phoneNumber": "1234567890"
}
}