GET suppliers
Get all suppliers.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Get all suppliers.
Collection of SupplierGetModelName | Description | Type | Additional 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. | SupplierAddressModel | None. |
SupplierCode | The code for the Supplier. | string | Max length: 20 |
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. |
SuppliersReference | The suppliers reference for you. | string | Max length: 20 |
SupplierID | The ID for the supplier. | integer | Required |
Name | The supplier name. | string | None. |
Response Formats
application/json, text/json
Sample:
[ { "SupplierGUID": "7c0cd898-5d27-40b5-a381-7cecdf3d2394", "SupplierAddress": { "FirstName": "John", "LastName": "Smith", "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", "SuppliersReference": "suppliersReference", "SupplierID": 1, "Name": "Supplier 1" }, { "SupplierGUID": "2dba03d2-65bd-4d55-9998-f052db451840", "SupplierAddress": { "FirstName": "John", "LastName": "Smith", "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", "SuppliersReference": "suppliersReference1", "SupplierID": 2, "Name": "Supplier 2" } ]
application/xml, text/xml
Sample:
<ArrayOfSupplierModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <SupplierModel> <SupplierID>1</SupplierID> <Name>Supplier 1</Name> <SupplierGUID>7c0cd898-5d27-40b5-a381-7cecdf3d2394</SupplierGUID> <SupplierAddress> <FirstName>John</FirstName> <LastName>Smith</LastName> <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> <SuppliersReference>suppliersReference</SuppliersReference> </SupplierModel> <SupplierModel> <SupplierID>2</SupplierID> <Name>Supplier 2</Name> <SupplierGUID>2dba03d2-65bd-4d55-9998-f052db451840</SupplierGUID> <SupplierAddress> <FirstName>John</FirstName> <LastName>Smith</LastName> <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> <SuppliersReference>suppliersReference1</SuppliersReference> </SupplierModel> </ArrayOfSupplierModel>