Build Version:

GET suppliers

Gets a list of suppliers.

Request Information

» Expands

Name	Description	Usage
supplierType	This will retrieve the related supplier type.	GET suppliers?expand=suppliertype

» Filters

Name	Description	Usage
externalId	This will filter the request by external ID.	GET suppliers?filter=externalid~{operator}~{value}
externalSupplierNumber	This will filter the request by external supplier number.	GET suppliers?filter=externalsuppliernumber~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET suppliers?filter=isactive~{operator}~{value}
name	This will filter the request by name.	GET suppliers?filter=name~{operator}~{value}
portalId	This will filter the request by portal ID.	GET suppliers?filter=portalid~{operator}~{value}
supplierTypeId	This will filter the request by supplier type ID.	GET suppliers?filter=suppliertypeid~{operator}~{value}

» Sorting

Name	Description	Usage
displayOrder	This will sort the response by display order.	GET suppliers?sort=displayorder
name	This will sort the response by name.	GET suppliers?sort=name
supplierId	This will sort the response by supplier ID.	GET suppliers?sort=supplierid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET suppliers?page=index~{value}
size	The size of the page when retrieving paged results.	GET suppliers?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "Suppliers": [
    {
      "ContactEmail": "john@smith.com",
      "ContactFirstName": "John",
      "ContactLastName": "Smith",
      "ContactPhone": "111-222-3333",
      "Custom1": "",
      "Custom2": "",
      "Custom3": "",
      "Custom4": "",
      "Custom5": "",
      "Description": "This is a supplier",
      "DisplayOrder": 1,
      "EmailNotificationTemplate": "",
      "EnableEmailNotification": true,
      "ExternalId": "",
      "ExternalSupplierNumber": "ABC123",
      "IsActive": true,
      "Name": "Supplier",
      "NotificationEmail": "supplier@supplier.com",
      "PortalId": null,
      "SupplierId": 1,
      "SupplierType": {
        "ClassName": "ZnodeSupplierEmail",
        "Description": "Sends an email receipt of the order to the supplier.",
        "IsActive": true,
        "Name": "Email",
        "SupplierTypeId": 1
      },
      "SupplierTypeId": 1,
      "Address": null,
      "Account": null,
      "ClassName": null
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}