How can we help?
{{docApp.searchError}}
{{product.name}}
Searching in {{docApp.searchFilterBySpecificBookTitle}}
{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}}
in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.
You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
-
{{resultItem.title}}
{{resultItem.url}}
{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}
{{docApp.libraryHomeViewProduct.description}}
{{group.title || group.id}}
{{group.description}}
Operation Information
- Application Reference:
com.hornbill.servicemanager - Scope:
Entity - Suppliers - Class:
Entity - Required Privilege Level:
user - Required Rights: none
Description
This flowcode operation updates the specified supplier.
Request Parameters
The updateSupplier API takes the following input parameters.
Note
When sending a JSON request payload to the API, the order of parameters is not significant. However, for XML request payloads, parameters must be provided in the exact order specified in this documentation to comply with input validation requirements.
| Name | Type | Required | Description |
|---|---|---|---|
supplierId |
xs:integer |
Yes | The supplier id. |
name |
xs:string |
No | The name of the existing supplier. |
nickname |
xs:string |
No | The nickname of the existing supplier. |
status |
xs:string |
No | The status of the existing supplier. Accepted values are (status.active, status.preferred, status.barred, status.archived). |
supplierStatus |
xs:string |
No | The supplier status of the existing supplier. Accepted values are provided from a simple list. |
industry |
xs:string |
No | The industry in which the existing supplier is based. |
emailAddressAccounts |
xs:string |
No | The accounts email address of the existing supplier. |
emailAddressSales |
xs:string |
No | The sales email address of the existing supplier. |
emailAddressSupport |
xs:string |
No | The support email address of the existing supplier. |
address |
xs:string |
No | The mailing address of the existing supplier. |
city |
xs:string |
No | The city where the existing supplier is based. |
state |
xs:string |
No | The state where the existing supplier is based. |
postalCode |
xs:string |
No | This is the postal code of the existing supplier. |
country |
xs:string |
No | The country where the existing supplier is based. |
timezone |
xs:string |
No | The timezone where the existing supplier is based. |
phoneNumber |
xs:string |
No | This is the primary phone number of the existing supplier. |
website |
xs:string |
No | The existing supplier's website. |
notes |
xs:string |
No | Any additional notes for the existing supplier. |
logo |
xs:string |
No | The company logo of the existing supplier. |
custom0 |
xs:string |
No | Custom data held against the existing supplier. |
custom1 |
xs:string |
No | Custom data held against the existing supplier. |
custom2 |
xs:string |
No | Custom data held against the existing supplier. |
custom3 |
xs:string |
No | Custom data held against the existing supplier. |
custom4 |
xs:string |
No | Custom data held against the existing supplier. |
custom5 |
xs:string |
No | Custom data held against the existing supplier. |
custom6 |
xs:string |
No | Custom data held against the existing supplier. |
custom7 |
xs:string |
No | Custom data held against the existing supplier. |
custom8 |
xs:string |
No | Custom data held against the existing supplier. |
custom9 |
xs:string |
No | Custom data held against the existing supplier. |
Response Parameters
No response parameters are returned.
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.servicemanager/Suppliers","@method":"updateSupplier","params":{"supplierId":1,"name":"xs:string","nickname":"xs:string","status":"xs:string","supplierStatus":"xs:string","industry":"xs:string","emailAddressAccounts":"xs:string","emailAddressSales":"xs:string","emailAddressSupport":"xs:string","address":"xs:string","city":"xs:string","state":"xs:string","postalCode":"xs:string","country":"xs:string","timezone":"xs:string","phoneNumber":"xs:string","website":"xs:string","notes":"xs:string","logo":"xs:string","custom0":"xs:string","custom1":"xs:string","custom2":"xs:string","custom3":"xs:string","custom4":"xs:string","custom5":"xs:string","custom6":"xs:string","custom7":"xs:string","custom8":"xs:string","custom9":"xs:string"}}'
package main
import (
"fmt"
apiLib "github.com/hornbill/goApiLib"
)
func main() {
hornbillAPI := apiLib.NewXmlmcInstance("yourinstanceid")
hornbillAPI.SetAPIKey("yourHornbillAPIKey")
hornbillAPI.SetJSONResponse(true)
hornbillAPI.SetParam("supplierId", "xs:integer")
hornbillAPI.SetParam("name", "xs:string")
hornbillAPI.SetParam("nickname", "xs:string")
hornbillAPI.SetParam("status", "xs:string")
hornbillAPI.SetParam("supplierStatus", "xs:string")
hornbillAPI.SetParam("industry", "xs:string")
hornbillAPI.SetParam("emailAddressAccounts", "xs:string")
hornbillAPI.SetParam("emailAddressSales", "xs:string")
hornbillAPI.SetParam("emailAddressSupport", "xs:string")
hornbillAPI.SetParam("address", "xs:string")
hornbillAPI.SetParam("city", "xs:string")
hornbillAPI.SetParam("state", "xs:string")
hornbillAPI.SetParam("postalCode", "xs:string")
hornbillAPI.SetParam("country", "xs:string")
hornbillAPI.SetParam("timezone", "xs:string")
hornbillAPI.SetParam("phoneNumber", "xs:string")
hornbillAPI.SetParam("website", "xs:string")
hornbillAPI.SetParam("notes", "xs:string")
hornbillAPI.SetParam("logo", "xs:string")
hornbillAPI.SetParam("custom0", "xs:string")
hornbillAPI.SetParam("custom1", "xs:string")
hornbillAPI.SetParam("custom2", "xs:string")
hornbillAPI.SetParam("custom3", "xs:string")
hornbillAPI.SetParam("custom4", "xs:string")
hornbillAPI.SetParam("custom5", "xs:string")
hornbillAPI.SetParam("custom6", "xs:string")
hornbillAPI.SetParam("custom7", "xs:string")
hornbillAPI.SetParam("custom8", "xs:string")
hornbillAPI.SetParam("custom9", "xs:string")
responseBody, apiError := hornbillAPI.Invoke("apps/com.hornbill.servicemanager/Suppliers", "updateSupplier")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Suppliers",
"@method": "updateSupplier",
"params": {
"supplierId": 1,
"name": "xs:string",
"nickname": "xs:string",
"status": "xs:string",
"supplierStatus": "xs:string",
"industry": "xs:string",
"emailAddressAccounts": "xs:string",
"emailAddressSales": "xs:string",
"emailAddressSupport": "xs:string",
"address": "xs:string",
"city": "xs:string",
"state": "xs:string",
"postalCode": "xs:string",
"country": "xs:string",
"timezone": "xs:string",
"phoneNumber": "xs:string",
"website": "xs:string",
"notes": "xs:string",
"logo": "xs:string",
"custom0": "xs:string",
"custom1": "xs:string",
"custom2": "xs:string",
"custom3": "xs:string",
"custom4": "xs:string",
"custom5": "xs:string",
"custom6": "xs:string",
"custom7": "xs:string",
"custom8": "xs:string",
"custom9": "xs:string"
}
};
fetch(endpoint, {
method: 'POST',
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
},
body: JSON.stringify(payload)
}).then(res => res.json())
.then(res => console.log(res));
const axios = require('axios');
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers";
const payload = {
"@service": "apps/com.hornbill.servicemanager/Suppliers",
"@method": "updateSupplier",
"params": {
"supplierId": 1,
"name": "xs:string",
"nickname": "xs:string",
"status": "xs:string",
"supplierStatus": "xs:string",
"industry": "xs:string",
"emailAddressAccounts": "xs:string",
"emailAddressSales": "xs:string",
"emailAddressSupport": "xs:string",
"address": "xs:string",
"city": "xs:string",
"state": "xs:string",
"postalCode": "xs:string",
"country": "xs:string",
"timezone": "xs:string",
"phoneNumber": "xs:string",
"website": "xs:string",
"notes": "xs:string",
"logo": "xs:string",
"custom0": "xs:string",
"custom1": "xs:string",
"custom2": "xs:string",
"custom3": "xs:string",
"custom4": "xs:string",
"custom5": "xs:string",
"custom6": "xs:string",
"custom7": "xs:string",
"custom8": "xs:string",
"custom9": "xs:string"
}
};
const axiosConfig = {
headers: {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
};
axios.post(endpoint, payload, axiosConfig)
.then((res) => {
console.log("RESPONSE RECEIVED: ", res);
})
.catch((err) => {
console.log("AXIOS ERROR: ", err);
})
$endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers";
$payload = (object) [
'@service' => 'apps/com.hornbill.servicemanager/Suppliers',
'@method' => 'updateSupplier',
'params' => (object) [
'supplierId' => 'xs:integer',
'name' => 'xs:string',
'nickname' => 'xs:string',
'status' => 'xs:string',
'supplierStatus' => 'xs:string',
'industry' => 'xs:string',
'emailAddressAccounts' => 'xs:string',
'emailAddressSales' => 'xs:string',
'emailAddressSupport' => 'xs:string',
'address' => 'xs:string',
'city' => 'xs:string',
'state' => 'xs:string',
'postalCode' => 'xs:string',
'country' => 'xs:string',
'timezone' => 'xs:string',
'phoneNumber' => 'xs:string',
'website' => 'xs:string',
'notes' => 'xs:string',
'logo' => 'xs:string',
'custom0' => 'xs:string',
'custom1' => 'xs:string',
'custom2' => 'xs:string',
'custom3' => 'xs:string',
'custom4' => 'xs:string',
'custom5' => 'xs:string',
'custom6' => 'xs:string',
'custom7' => 'xs:string',
'custom8' => 'xs:string',
'custom9' => 'xs:string',
]
];
$headers = [
'Authorization: ESP-APIKEY yourHornbillAPIKey',
'Content-Type: application/json'
];
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $endpoint);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($payload));
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$resp = curl_exec($curl);
curl_close($curl);
echo $resp;
$Endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers"
$Body = @{
"@service" = "apps/com.hornbill.servicemanager/Suppliers"
"@method" = "updateSupplier"
params = @{
supplierId = "xs:integer"
name = "xs:string"
nickname = "xs:string"
status = "xs:string"
supplierStatus = "xs:string"
industry = "xs:string"
emailAddressAccounts = "xs:string"
emailAddressSales = "xs:string"
emailAddressSupport = "xs:string"
address = "xs:string"
city = "xs:string"
state = "xs:string"
postalCode = "xs:string"
country = "xs:string"
timezone = "xs:string"
phoneNumber = "xs:string"
website = "xs:string"
notes = "xs:string"
logo = "xs:string"
custom0 = "xs:string"
custom1 = "xs:string"
custom2 = "xs:string"
custom3 = "xs:string"
custom4 = "xs:string"
custom5 = "xs:string"
custom6 = "xs:string"
custom7 = "xs:string"
custom8 = "xs:string"
custom9 = "xs:string"
}
}
$Header = @{
"Authorization" = "ESP-APIKEY yourHornbillAPIKey"
}
$Parameters = @{
Method = "POST"
Uri = $Endpoint
Headers = $Header
Body = ($Body | ConvertTo-Json)
ContentType = "application/json"
}
Invoke-RestMethod @Parameters
import requests
import json
endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.servicemanager/Suppliers"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.servicemanager/Suppliers",
"@method":"updateSupplier",
"params":{
"supplierId":"xs:integer",
"name":"xs:string",
"nickname":"xs:string",
"status":"xs:string",
"supplierStatus":"xs:string",
"industry":"xs:string",
"emailAddressAccounts":"xs:string",
"emailAddressSales":"xs:string",
"emailAddressSupport":"xs:string",
"address":"xs:string",
"city":"xs:string",
"state":"xs:string",
"postalCode":"xs:string",
"country":"xs:string",
"timezone":"xs:string",
"phoneNumber":"xs:string",
"website":"xs:string",
"notes":"xs:string",
"logo":"xs:string",
"custom0":"xs:string",
"custom1":"xs:string",
"custom2":"xs:string",
"custom3":"xs:string",
"custom4":"xs:string",
"custom5":"xs:string",
"custom6":"xs:string",
"custom7":"xs:string",
"custom8":"xs:string",
"custom9":"xs:string",
},
}
response = requests.request("POST", endpoint, json=payload, headers=headers)
print(response.text)
- Version {{docApp.book.version}}
- Node {{docApp.node}} / {{docApp.build}}
In This Document