Get a list of available suppliers

get/suppliers
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
name
string (StringFilterParam)

Filter by name

Example: name=xyz | in:x,y | like:xyz
accountNumber
string (StringFilterParam)

Filter by supplier account number

Example: accountNumber=xyz | in:x,y | like:xyz
supplierAccountId
string (IdFilterParam)

Filter by supplier account identifier

Example: supplierAccountId=0
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Not Found

412

Precondition Failed

500

Internal Server Error

501

Not Implemented Yet

Response samples
application/json
[
  • {
    • "id": 1,
    • "name": "string",
    • "ftpDownloadEnabled": false,
    • "supplierAccounts": [
      • {
        • "id": 1,
        • "accountNumber": "string",
        • "lastSuccessfulConnection": "2019-08-24T14:15:22Z",
        • "lastSuccessfulDownload": "2019-08-24T14:15:22Z",
        • "lastSuccessfulCDRDownload": "2019-08-24T14:15:22Z",
        • "lastSuccessfulSDRDownload": "2019-08-24T14:15:22Z",
        • "ftpDownloadEnabled": false
        }
      ]
    }
]