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.suppliermanager - Scope:
Entity - Suppliers - Class:
Entity - Required Privilege Level:
user - Required Rights: Group A - canCreateSuppliers; Group B - canCreateSupplierPermissions
Description
This flowcode operation creates a new supplier.
Request Parameters
The addSupplier API takes the following input parameters. It is important to note that the parameters must satisfy the requirement of the input validation checks.
| Name | Type | Required | Description |
|---|---|---|---|
name |
xs:string |
No | The name of the new supplier. |
nickname |
xs:string |
No | The nickname of the new supplier. |
status |
xs:string |
No | The status of the new supplier. Accepted values are (status.active, status.preferred, status.barred, status.archived). If no value is provided, status.active will be used. |
status |
xs:string |
No | The status of the new supplier. Accepted values are (status.active, status.preferred, status.barred, status.archived). If no value is provided, status.active will be used. |
supplierStatus |
xs:string |
No | The supplier status of the new supplier. Accepted values are provided from a simple list. |
industry |
xs:string |
No | The industry in which the new supplier is based. |
emailAddressAccounts |
xs:string |
No | The accounts email address of the new supplier. |
emailAddressSales |
xs:string |
No | The sales email address of the new supplier. |
emailAddressSupport |
xs:string |
No | The support email address of the new supplier. |
address |
xs:string |
No | The mailing address of the new supplier. |
city |
xs:string |
No | The city where the new supplier is based. |
state |
xs:string |
No | The state where the new supplier is based. |
postalCode |
xs:string |
No | This is the postal code of the new supplier. |
country |
xs:string |
No | The country where the new supplier is based. |
timezone |
xs:string |
No | The timezone where the new supplier is based. |
phoneNumber |
xs:string |
No | This is the primary phone number of the new supplier. |
website |
xs:string |
No | The new supplier's website. |
notes |
xs:string |
No | Any additional notes for the new supplier. |
custom0 |
xs:string |
No | Custom data held against the new supplier. |
custom1 |
xs:string |
No | Custom data held against the new supplier. |
custom2 |
xs:string |
No | Custom data held against the new supplier. |
custom3 |
xs:string |
No | Custom data held against the new supplier. |
custom4 |
xs:string |
No | Custom data held against the new supplier. |
custom5 |
xs:string |
No | Custom data held against the new supplier. |
custom6 |
xs:string |
No | Custom data held against the new supplier. |
custom7 |
xs:string |
No | Custom data held against the new supplier. |
custom8 |
xs:string |
No | Custom data held against the new supplier. |
custom9 |
xs:string |
No | Custom data held against the new supplier. |
Response Parameters
| Name | Type | Description |
|---|---|---|
outcome |
xs:string |
The outcome of the flowcode operation. |
supplierId |
xs:integer |
The id of the new supplier. |
supplierName |
xs:string |
The name of the new supplier. |
Code Examples
curl -X POST 'https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/Suppliers' \
-H 'Authorization: ESP-APIKEY yourHornbillAPIKey' \
-H 'Content-Type: application/json' \
-d '{"@service":"apps/com.hornbill.suppliermanager/Suppliers","@method":"addSupplier","params":{"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","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("name", "xs:string")
hornbillAPI.SetParam("nickname", "xs:string")
hornbillAPI.SetParam("status", "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("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.suppliermanager/Suppliers", "addSupplier")
if apiError != nil {
fmt.Println(apiError)
return
}
fmt.Println(responseBody)
}
const endpoint = "https://api.hornbill.com/yourinstanceid/xmlmc/apps/com.hornbill.suppliermanager/Suppliers";
const payload = {
"@service": "apps/com.hornbill.suppliermanager/Suppliers",
"@method": "addSupplier",
"params": {
"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",
"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.suppliermanager/Suppliers";
const payload = {
"@service": "apps/com.hornbill.suppliermanager/Suppliers",
"@method": "addSupplier",
"params": {
"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",
"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.suppliermanager/Suppliers";
$payload = (object) [
'@service' => 'apps/com.hornbill.suppliermanager/Suppliers',
'@method' => 'addSupplier',
'params' => (object) [
'name' => 'xs:string',
'nickname' => 'xs:string',
'status' => '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',
'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.suppliermanager/Suppliers"
$Body = @{
"@service" = "apps/com.hornbill.suppliermanager/Suppliers"
"@method" = "addSupplier"
params = @{
name = "xs:string"
nickname = "xs:string"
status = "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"
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.suppliermanager/Suppliers"
headers = {
"Authorization": "ESP-APIKEY yourHornbillAPIKey"
}
payload={
"@service":"apps/com.hornbill.suppliermanager/Suppliers",
"@method":"addSupplier",
"params":{
"name":"xs:string",
"nickname":"xs:string",
"status":"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",
"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