POST suppliers

Create a new Supplier

Request Information

URI Parameters

None.

Body Parameters

The supplier object that you want to create.

SupplierModel
NameDescriptionTypeAdditional information
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.
SupplierID The ID for the supplier. integer Required
Name The supplier name. string None.
Url The URL to access the object. string None.

Request Formats

application/json, text/json

Sample:
{
  "SupplierGUID": "7d7818a5-9e31-4715-a1ae-6ff491a3268c",
  "SupplierAddress": {
    "FirstName": "John",
    "LastName": "Smith",
    "Company": "Supplier 1",
    "Address1": "123 Example Street",
    "Address2": "Example borough",
    "Department": "Sales",
    "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"
}

application/xml, text/xml

Sample:
<SupplierModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SupplierID>1</SupplierID>
  <Name>Supplier 1</Name>
  <SupplierGUID>7d7818a5-9e31-4715-a1ae-6ff491a3268c</SupplierGUID>
  <SupplierAddress>
    <FirstName>John</FirstName>
    <LastName>Smith</LastName>
    <Company>Supplier 1</Company>
    <Address1>123 Example Street</Address1>
    <Address2>Example borough</Address2>
    <Department>Sales</Department>
    <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>

Response Information

Resource Description

Create a new Supplier

Collection of SupplierModel
NameDescriptionTypeAdditional information
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.
SupplierID The ID for the supplier. integer Required
Name The supplier name. string None.
Url The URL to access the object. string None.

Response Formats

application/json, text/json

Sample:
{
  "SupplierGUID": "7d7818a5-9e31-4715-a1ae-6ff491a3268c",
  "SupplierAddress": {
    "FirstName": "John",
    "LastName": "Smith",
    "Company": "Supplier 1",
    "Address1": "123 Example Street",
    "Address2": "Example borough",
    "Department": "Sales",
    "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"
}

application/xml, text/xml

Sample:
<SupplierModel xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SupplierID>1</SupplierID>
  <Name>Supplier 1</Name>
  <SupplierGUID>7d7818a5-9e31-4715-a1ae-6ff491a3268c</SupplierGUID>
  <SupplierAddress>
    <FirstName>John</FirstName>
    <LastName>Smith</LastName>
    <Company>Supplier 1</Company>
    <Address1>123 Example Street</Address1>
    <Address2>Example borough</Address2>
    <Department>Sales</Department>
    <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>