All URIs are relative to https://api.ordercloud.io/v1
Method | HTTP request | Description |
---|---|---|
Create | POST /suppliers | |
Delete | DELETE /suppliers/{supplierID} | |
Get | GET /suppliers/{supplierID} | |
List | GET /suppliers | |
Patch | PATCH /suppliers/{supplierID} | |
Save | PUT /suppliers/{supplierID} |
Supplier Create(supplier)
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new OrderCloud.Suppliers();
var supplier = new OrderCloud.Supplier(); // Supplier |
apiInstance.Create(supplier).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
supplier | Supplier |
- Content-Type: application/json, text/plain; charset=utf-8
- Accept: application/json
Delete(supplierID)
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new OrderCloud.Suppliers();
var supplierID = "supplierID_example"; // String | ID of the supplier.
apiInstance.Delete(supplierID).then(function() {
console.log('API called successfully.');
}, function(error) {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
supplierID | String | ID of the supplier. |
null (empty response body)
- Content-Type: application/json, text/plain; charset=utf-8
- Accept: application/json
Supplier Get(supplierID)
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new OrderCloud.Suppliers();
var supplierID = "supplierID_example"; // String | ID of the supplier.
apiInstance.Get(supplierID).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
supplierID | String | ID of the supplier. |
- Content-Type: application/json, text/plain; charset=utf-8
- Accept: application/json
ListSupplier List(opts)
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new OrderCloud.Suppliers();
var opts = {
'search': "search_example", // String | Word or phrase to search for.
'searchOn': "searchOn_example", // String | Comma-delimited list of fields to search on.
'sortBy': "sortBy_example", // String | Comma-delimited list of fields to sort by.
'page': 56, // Number | Page of results to return. Default: 1
'pageSize': 56, // Number | Number of results to return per page. Default: 20, max: 100.
'filters': {key: "filters_example"} // {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???'
};
apiInstance.List(opts).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
search | String | Word or phrase to search for. | [optional] |
searchOn | String | Comma-delimited list of fields to search on. | [optional] |
sortBy | String | Comma-delimited list of fields to sort by. | [optional] |
page | Number | Page of results to return. Default: 1 | [optional] |
pageSize | Number | Number of results to return per page. Default: 20, max: 100. | [optional] |
filters | {String: String} | Any additional key/value pairs passed in the query string are interpretted as filters. Valid keys are top-level properties of the returned model or 'xp.???' | [optional] |
- Content-Type: application/json, text/plain; charset=utf-8
- Accept: application/json
Supplier Patch(supplierID, partialSupplier)
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new OrderCloud.Suppliers();
var supplierID = "supplierID_example"; // String | ID of the supplier.
var partialSupplier = new OrderCloud.Supplier(); // Supplier |
apiInstance.Patch(supplierID, partialSupplier).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
supplierID | String | ID of the supplier. | |
partialSupplier | Supplier |
- Content-Type: application/json, text/plain; charset=utf-8
- Accept: application/json
Supplier Save(supplierID, supplier)
var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;
// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';
var apiInstance = new OrderCloud.Suppliers();
var supplierID = "supplierID_example"; // String | ID of the supplier.
var supplier = new OrderCloud.Supplier(); // Supplier |
apiInstance.Save(supplierID, supplier).then(function(data) {
console.log('API called successfully. Returned data: ' + data);
}, function(error) {
console.error(error);
});
Name | Type | Description | Notes |
---|---|---|---|
supplierID | String | ID of the supplier. | |
supplier | Supplier |
- Content-Type: application/json, text/plain; charset=utf-8
- Accept: application/json