PUT suppliers/{supplierid}

Update a Supplier by ID

Request Information

URI Parameters

NameDescriptionTypeAdditional information
supplierid The ID of the Supplier to update integer Required

Body Parameters

The Supplier object

SupplierUpdateModel
NameDescriptionTypeAdditional information
Name The supplier name. string None.
SupplierAddress The Suppliers Address. SupplierAddressModel None.
SupplierCode The code for the Supplier. string Max length: 20
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.
RecalculateSupplierCost Setting true when updating the currency will convert the currency values boolean None.
SuppliersReference The suppliers reference for you. string Max length: 20

Request Formats

application/json, text/json

Sample: 
{
  "Name": "Supplier 1",
  "SupplierAddress": {
    "FirstName": "John",
    "LastName": "Smith",
    "Address1": "123 Example Street",
    "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",
  "CurrencyCode": "GBP",
  "RecalculateSupplierCost": false,
  "SuppliersReference": "suppliersReference"
}

application/xml, text/xml

Sample: 
<SupplierUpdateModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>Supplier 1</Name>
  <SupplierAddress>
    <FirstName>John</FirstName>
    <LastName>Smith</LastName>
    <Address1>123 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>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>
  <CurrencyCode>GBP</CurrencyCode>
  <RecalculateSupplierCost>false</RecalculateSupplierCost>
  <SuppliersReference>suppliersReference</SuppliersReference>
</SupplierUpdateModel>

Response Information

Resource Description

Update a Supplier by ID

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.