All URIs are relative to https://secure.ultracart.com/rest/v2
Method | HTTP request | Description |
---|---|---|
deleteGroup | DELETE /user/groups/{group_oid} | Delete a group |
deleteUser | DELETE /user/users/{user_id} | Delete a user |
getGroup | GET /user/groups/{group_oid} | Retrieve a group |
getGroups | GET /user/groups | Get groups |
getUser | GET /user/users/{user_id} | Retrieve a user |
getUserLogins | GET /user/users/{user_id}/logins | Retrieve a user's login history |
getUsers | GET /user/users | Get users |
insertGroup | POST /user/groups | Insert a group |
insertUser | POST /user/users | Insert a user |
updateGroup | PUT /user/groups/{group_oid} | Update a group |
updateUser | PUT /user/users/{user_id} | Update a user |
deleteGroup(group_oid)
Delete a group
Delete a group on the UltraCart account.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var group_oid = 56; // Number | The group_oid to delete.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteGroup(group_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
group_oid | Number | The group_oid to delete. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
deleteUser(user_id)
Delete a user
Delete a user on the UltraCart account.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var user_id = 56; // Number | The user_id to delete.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteUser(user_id, callback);
Name | Type | Description | Notes |
---|---|---|---|
user_id | Number | The user_id to delete. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
getGroup(group_oid)
Retrieve a group
Retrieves a single group using the specified group id.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var group_oid = 56; // Number | The group id to retrieve.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.getGroup(group_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
group_oid | Number | The group id to retrieve. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
GroupsResponse getGroups()
Get groups
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getGroups(callback);
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
UserResponse getUser(user_id)
Retrieve a user
Retrieves a single user using the specified user id.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var user_id = 56; // Number | The user id to retrieve.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getUser(user_id, callback);
Name | Type | Description | Notes |
---|---|---|---|
user_id | Number | The user id to retrieve. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
UserLoginsResponse getUserLogins(user_id)
Retrieve a user's login history
Retrieves logins for a single user using the specified user id.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var user_id = 56; // Number | The user id to retrieve.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getUserLogins(user_id, callback);
Name | Type | Description | Notes |
---|---|---|---|
user_id | Number | The user id to retrieve. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
UsersResponse getUsers()
Get users
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getUsers(callback);
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
GroupResponse insertGroup(group)
Insert a group
Insert a group on the UltraCart account.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var group = new UltraCartRestApiV2.Group(); // Group | Group to insert
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.insertGroup(group, callback);
Name | Type | Description | Notes |
---|---|---|---|
group | Group | Group to insert |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
UserResponse insertUser(user)
Insert a user
Insert a user on the UltraCart account.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var user = new UltraCartRestApiV2.User(); // User | User to insert
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.insertUser(user, callback);
Name | Type | Description | Notes |
---|---|---|---|
user | User | User to insert |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
GroupResponse updateGroup(group, group_oid)
Update a group
Update a group on the UltraCart account.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var group = new UltraCartRestApiV2.Group(); // Group | Group to update
var group_oid = 56; // Number | The group_oid to update.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateGroup(group, group_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
group | Group | Group to update | |
group_oid | Number | The group_oid to update. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
UserResponse updateUser(user, user_id)
Update a user
Update a user on the UltraCart account.
var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
var apiInstance = new UltraCartRestApiV2.UserApi();
var user = new UltraCartRestApiV2.User(); // User | User to update
var user_id = 56; // Number | The user_id to update.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateUser(user, user_id, callback);
Name | Type | Description | Notes |
---|---|---|---|
user | User | User to update | |
user_id | Number | The user_id to update. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json