Search Deals

Search all deals or specific deal with no line specifications. This call will only bring back header level details of the deal.

Headers

Property	Value
Request Type	POST
Content Type	application-json
URL	{{EnvironmentURL}}/api/services/app/Deals/SearchDeals

Please see Environments under Getting Started for test and production environment URLs.

Request Parameters

Property	Type	Description	Required
Filter Text	string	Can be left blank to find all deals or populated for a specific deal to find.
Deal Type	enum	Type of deal that is being searched for. List of deal types is provided below.	✓
Expiry Date From	dateTime	Field to specify start date for expiration date.
Expiry Date To	dateTime	Field to specify end date for expiration date.
Created Date From	dateTime	Field to specify start date for created date.
Created Date To	dateTime	Field to specify end date for created date.
Skip Count	int	Specify how many deals to skip. Used for indexing and retrieving batches of deals. If left blank, all deals are returned.	✓
Max Result Count	int	Specify max deals to bring back. If left blank, all deals are returned.
Market	enum	Market Enum that is set to 17 by default. (See Constants for all market Enums)	✓

Sample Request

{
  "filterText": "",
  "tenantFilter": [
  ],
  "customerFilter": [
  ],
  "expiryDateFrom": null,
  "expiryDateTo": null,
  "createdDateFrom": null,
  "createdDateTo": null,
  "skipCaching": true,
  "statusFilter": [
  ],
  "brandFilter": [
  ],
  "Market": 17,
  "dealType": 6,
  "input": null,
  "skipCount": 0,
  "maxResultCount": 100
}

Response Parameters

Property	Type	Description
Deal Identifier	string	Can be left blank to find all deals or populated for specific deal to find.
Deal Type	enum	See Constants (Enums) for available deal types.
Name	string
Description	string
Brand	enum	See Constants (Enums) for available brands.
Status	bool	Boolean flag to indicate status of deal.
Market	enum	Market which deal is associated with.
Created Date	dateTime	The date the deal was created.
Expiry Date	dateTime	Expiry date of the deal.
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.
Tenant Id	int	Partner ID associated with the deal.
Customer Id	int	Internal ID associated with the customer.
Sell Currency	bool	Boolean flag to indicate if the deal is active.
Total Inc	bool	Deal value including VAT.
Total Exc	bool	Deal value excluding VAT.
Items
Is Active	bool	Boolean flag to indicate if the deal is active.
Additional Info	Dictionary	Additional information for the deal in key value pair format.
Contact Person
Full Name	string	Deal contact person full name.
Email	string	Deal contact person email Address.
Phone Number	string	Deal contact person phone number.

Sample Response

  {
    "totalCount": 1,
    "items": [
      {
        "dealIdentifier": "43",
        "dealType": 0,
        "name": "Ava Deal",
        "description": "Ava Deal",
        "brand": 7,
        "status": "Approved",
        "market": 14,
        "createdDate": "2023-02-20T20:22:16",
        "expiryDate": "2023-02-23T20:22:16",
        "tenant": {
          "tenantId": 1379,
          "accountNumbers": null,
          "isActive": false,
          "name": "Axiz Demo",
          "registrationNumber": null,
          "vatNumber": null,
          "tenantAddresses": null
        },
        "customer": {
          "customerId": 3344,
          "name": "Company 1",
          "description": null,
          "accountNumber": "76543",
          "customerAddresses": null,
          "contactPerson": null,
          "tenantId": 1379
        },
        "tenantId": 1379,
        "customerId": 3344,
        "sellCurrency": null,
        "totalInc": 250.8150,
        "totalExc": 218.10,
        "items": null,
        "additionalInfo": {
          "DealId": "43",
          "DealReference": "TestDealAdd12345"
        },
        "contactPerson": {
          "fullName": "John Doe",
          "email": "[email protected]",
          "phoneNumber": "1234567890"
        }
      }
    ]
  }