PATCH suppliers/{supplierid}

Partially update a Supplier. Leave any fields null which you do not wish to update.

Request Information

URI Parameters

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

Body Parameters

The Supplier object

SupplierPatchModel
NameDescriptionTypeAdditional information
SupplierID The ID for the supplier. integer Required
Name The supplier name. string None.
SupplierGUID The Guid for the Supplier. This cannot be updated globally unique identifier None.
SupplierAddress The Suppliers Address. AddressModel 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: 
{
  "SupplierID": 0,
  "Name": "Supplier 1",
  "SupplierGUID": "00000000-0000-0000-0000-000000000000",
  "SupplierAddress": {
    "FirstName": "John",
    "LastName": "Smith",
    "Company": "Supplier 1",
    "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: 
<SupplierPatchModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SupplierID>0</SupplierID>
  <Name>Supplier 1</Name>
  <SupplierGUID>00000000-0000-0000-0000-000000000000</SupplierGUID>
  <SupplierAddress>
    <FirstName>John</FirstName>
    <LastName>Smith</LastName>
    <Company>Supplier 1</Company>
    <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>
</SupplierPatchModel>

Response Information

Resource Description

Partially update a Supplier. Leave any fields null which you do not wish to update.

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.