Supplier_Get Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
DeviceID
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
string
Minimum length: 0
Maximum length: 100
SubmissionNumber
string
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Authentication
Account number, and an MD5 hash "Account number, API Key and Submission Number"
AccNumber
MD5Value
ApplicationID
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
string
Minimum length: 1
Maximum length: 100
Body
SearchParameters
ReturnCount
How many records would you like the API to return.
int
Minimum inclusive value: 1
Maximum inclusive value: 50
Offset
int
Page offset. Zero (0) would show results from the begining of the record set. Offset can be used for paging functions.
DateFrom
date
Issued date range from
DateTo
date
Issued date range to
Retrieve supplier details
Header
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
DeviceID
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
string
Minimum length: 0
Maximum length: 100
SubmissionNumber
string
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Authentication
Account number, and an MD5 hash "Account number, API Key and Submission Number"
AccNumber
MD5Value
ApplicationID
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
string
Minimum length: 1
Maximum length: 100
Body
SupplierID
int
Endpoint: https://api.quickfile.co.uk/1_2/supplier/get
Example Request:
We had a problem retrieving a JSON sample for this method, please retry later
Example Response:
Example Request:
We had a problem retrieving an XML sample for this method, please retry later
Example Response:
| Other Supplier Methods |
|---|
|
Create a new supplier record
|
|
Delete a supplier record
|
|
Retrieve supplier and contact data
|
|
Retrieve supplier records based on a set of search parameters
|