GET suppliers

Get all suppliers.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Get all suppliers.

Collection of SupplierGetModel
NameDescriptionTypeAdditional information
Currency The Currency in which the supplier sells in. CurrencyBaseModel None.
SupplierGUID The Guid for the Supplier. globally unique identifier None.
SupplierAddress The Suppliers Address. AddressModel None.
SupplierCode The code for the Supplier. string None.
Email The Suppliers Email Address. string None.
MinimumOrderValue The minimum order value allowed for the supplier. decimal number None.
SendBelowReorderLevelEmail This determines whether automatic emails are sent when a product goes below the reorder level. boolean None.
BelowReorderLevelReportRecipientEmailAddress A list of emails that will the Reorder level report will be sent to. Collection of string None.
Reference Your reference for the supplier. string None.
AccountNumber Your account number with the supplier. string None.
CurrencyCode The ISO 4217 Currency Code string None.
SupplierID The ID for the supplier. integer Required
Name The supplier name. string None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SupplierGUID": "78a81111-2310-451b-9963-e1ac94328e79",
    "SupplierAddress": {
      "FirstName": "John",
      "LastName": "Smith",
      "Company": "Supplier 1",
      "Address1": "123 Example Stress",
      "Address2": "Example borough",
      "Suite": "Suite Name",
      "City": "Example City",
      "State": "State",
      "Postcode": "NG7 2RR",
      "Country": "United Kingdom",
      "PhoneNumber": "01234123456"
    },
    "SupplierCode": "sup1",
    "Email": "orders@supplier.com",
    "MinimumOrderValue": 100.0,
    "SendBelowReorderLevelEmail": true,
    "BelowReorderLevelReportRecipientEmailAddress": [
      "john@yourcompany.com",
      "sarah@yourcompany.com"
    ],
    "Reference": "sf1",
    "AccountNumber": "yourCompany1",
    "SupplierID": 1,
    "Name": "Supplier 1"
  },
  {
    "SupplierGUID": "1d1603cf-0e7a-4e26-8339-5daed7b5f1cb",
    "SupplierAddress": {
      "FirstName": "John",
      "LastName": "Smith",
      "Company": "Supplier 2",
      "Address1": "124 Example Street",
      "Address2": "Example borough",
      "Suite": "Suite Name",
      "City": "Example City",
      "State": "State",
      "Postcode": "NG7 2RR",
      "Country": "United Kingdom",
      "PhoneNumber": "01234123456"
    },
    "SupplierCode": "sup2",
    "Email": "orders@supplier2.com",
    "MinimumOrderValue": 200.0,
    "SendBelowReorderLevelEmail": false,
    "Reference": "sf2",
    "AccountNumber": "yourCompany1",
    "SupplierID": 2,
    "Name": "Supplier 2"
  }
]

application/xml, text/xml

Sample:
<ArrayOfSupplierModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SupplierModel>
    <SupplierID>1</SupplierID>
    <Name>Supplier 1</Name>
    <SupplierGUID>78a81111-2310-451b-9963-e1ac94328e79</SupplierGUID>
    <SupplierAddress>
      <FirstName>John</FirstName>
      <LastName>Smith</LastName>
      <Company>Supplier 1</Company>
      <Address1>123 Example Stress</Address1>
      <Address2>Example borough</Address2>
      <Suite>Suite Name</Suite>
      <City>Example City</City>
      <State>State</State>
      <Postcode>NG7 2RR</Postcode>
      <Country>United Kingdom</Country>
      <PhoneNumber>01234123456</PhoneNumber>
    </SupplierAddress>
    <SupplierCode>sup1</SupplierCode>
    <Email>orders@supplier.com</Email>
    <MinimumOrderValue>100</MinimumOrderValue>
    <SendBelowReorderLevelEmail>true</SendBelowReorderLevelEmail>
    <BelowReorderLevelReportRecipientEmailAddress>
      <string>john@yourcompany.com</string>
      <string>sarah@yourcompany.com</string>
    </BelowReorderLevelReportRecipientEmailAddress>
    <Reference>sf1</Reference>
    <AccountNumber>yourCompany1</AccountNumber>
  </SupplierModel>
  <SupplierModel>
    <SupplierID>2</SupplierID>
    <Name>Supplier 2</Name>
    <SupplierGUID>1d1603cf-0e7a-4e26-8339-5daed7b5f1cb</SupplierGUID>
    <SupplierAddress>
      <FirstName>John</FirstName>
      <LastName>Smith</LastName>
      <Company>Supplier 2</Company>
      <Address1>124 Example Street</Address1>
      <Address2>Example borough</Address2>
      <Suite>Suite Name</Suite>
      <City>Example City</City>
      <State>State</State>
      <Postcode>NG7 2RR</Postcode>
      <Country>United Kingdom</Country>
      <PhoneNumber>01234123456</PhoneNumber>
    </SupplierAddress>
    <SupplierCode>sup2</SupplierCode>
    <Email>orders@supplier2.com</Email>
    <MinimumOrderValue>200</MinimumOrderValue>
    <SendBelowReorderLevelEmail>false</SendBelowReorderLevelEmail>
    <Reference>sf2</Reference>
    <AccountNumber>yourCompany1</AccountNumber>
  </SupplierModel>
</ArrayOfSupplierModel>