POST suppliers
Create a new Supplier
Request Information
URI Parameters
None.
Body Parameters
The supplier object that you want to create.
SupplierUpdateModel
| Name | Description | Type | Additional information |
|---|---|---|---|
| Name | The supplier name. | string | 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. |
| 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
Create a new Supplier
Collection of SupplierGetModel| Name | 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": "02545a79-43e7-4ddb-9244-8674971b3615",
"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",
"SuppliersReference": "suppliersReference",
"SupplierID": 1,
"Name": "Supplier 1"
}
application/xml, text/xml
Sample:
<SupplierModel xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SupplierID>1</SupplierID>
<Name>Supplier 1</Name>
<SupplierGUID>02545a79-43e7-4ddb-9244-8674971b3615</SupplierGUID>
<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>
<SuppliersReference>suppliersReference</SuppliersReference>
</SupplierModel>