GET suppliers/{supplierId}

Gets a supplier.

Request Information

» Parameters

Name Description Additional information
supplierId The ID of the supplier.

Define this parameter in the request URI.

» Expands

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

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.

  "Supplier": {
    "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
  "ErrorCode": null,
  "ErrorMessage": null,
  "HasError": false