All URIs are relative to https://secure.ultracart.com/rest/v2
Method | HTTP request | Description |
---|---|---|
addCustomerStoreCredit | POST /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer |
adjustInternalCertificate | POST /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed. |
deleteCustomer | DELETE /customer/customers/{customer_profile_oid} | Delete a customer |
deleteWishListItem | DELETE /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Delete a customer wishlist item |
getCustomer | GET /customer/customers/{customer_profile_oid} | Retrieve a customer |
getCustomerByEmail | GET /customer/customers/by_email/{email} | Retrieve a customer by Email |
getCustomerEditorValues | GET /customer/editor_values | Retrieve values needed for a customer profile editor |
getCustomerEmailLists | GET /customer/email_lists | Retrieve all email lists across all storefronts |
getCustomerStoreCredit | GET /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs |
getCustomerWishList | GET /customer/customers/{customer_profile_oid}/wishlist | Retrieve wishlist items for customer |
getCustomerWishListItem | GET /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Retrieve wishlist item for customer |
getCustomers | GET /customer/customers | Retrieve customers |
getCustomersByQuery | POST /customer/customers/query | Retrieve customers by query |
getCustomersForDataTables | POST /customer/customers/dataTables | Retrieve customers for DataTables plugin |
getEmailVerificationToken | POST /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address |
getMagicLink | PUT /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink |
insertCustomer | POST /customer/customers | Insert a customer |
insertWishListItem | POST /customer/customers/{customer_profile_oid}/wishlist | Insert a customer wishlist item |
mergeCustomer | PUT /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer |
searchCustomerProfileValues | POST /customer/search | Searches for all matching values (using POST) |
updateCustomer | PUT /customer/customers/{customer_profile_oid} | Update a customer |
updateCustomerEmailLists | POST /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer |
updateWishListItem | PUT /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item |
validateEmailVerificationToken | POST /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address |
BaseResponse addCustomerStoreCredit(customer_profile_oid, store_credit_request)
Adds store credit to a customer
Adds store credit to a customer
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer oid to credit.
var store_credit_request = new UltraCartRestApiV2.CustomerStoreCreditAddRequest(); // CustomerStoreCreditAddRequest | Store credit to add
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.addCustomerStoreCredit(customer_profile_oid, store_credit_request, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer oid to credit. | |
store_credit_request | CustomerStoreCreditAddRequest | Store credit to add |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
AdjustInternalCertificateResponse adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request)
Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer profile oid
var adjust_internal_certificate_request = new UltraCartRestApiV2.AdjustInternalCertificateRequest(); // AdjustInternalCertificateRequest | adjustInternalCertificateRequest
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.adjustInternalCertificate(customer_profile_oid, adjust_internal_certificate_request, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer profile oid | |
adjust_internal_certificate_request | AdjustInternalCertificateRequest | adjustInternalCertificateRequest |
AdjustInternalCertificateResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
deleteCustomer(customer_profile_oid)
Delete a customer
Delete a customer 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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer_profile_oid to delete.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.deleteCustomer(customer_profile_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer_profile_oid to delete. |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerWishListItem deleteWishListItem(customer_profile_oid, customer_wishlist_item_oid)
Delete a customer wishlist item
Delete a customer wishlist item
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer oid for this wishlist.
var customer_wishlist_item_oid = 56; // Number | The wishlist oid for this wishlist item to delete.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.deleteWishListItem(customer_profile_oid, customer_wishlist_item_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer oid for this wishlist. | |
customer_wishlist_item_oid | Number | The wishlist oid for this wishlist item to delete. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
CustomerResponse getCustomer(customer_profile_oid, opts)
Retrieve a customer
Retrieves a single customer using the specified customer profile oid.
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer oid to retrieve.
var opts = {
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomer(customer_profile_oid, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer oid to retrieve. | |
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerResponse getCustomerByEmail(email, opts)
Retrieve a customer by Email
Retrieves a single customer using the specified customer email address.
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.CustomerApi();
var email = "email_example"; // String | The email address of the customer to retrieve.
var opts = {
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomerByEmail(email, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
String | The email address of the customer to retrieve. | ||
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerEditorValues getCustomerEditorValues()
Retrieve values needed for a customer profile editor
Retrieve values needed for a customer profile editor.
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.CustomerApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomerEditorValues(callback);
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
EmailListsResponse getCustomerEmailLists()
Retrieve all email lists across all storefronts
Retrieve all email lists across all storefronts
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.CustomerApi();
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomerEmailLists(callback);
This endpoint does not need any parameter.
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerStoreCreditResponse getCustomerStoreCredit(customer_profile_oid)
Retrieve the customer store credit accumulated through loyalty programs
Retrieve the customer store credit accumulated through loyalty programs
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer oid to retrieve.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomerStoreCredit(customer_profile_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer oid to retrieve. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerWishListItemsResponse getCustomerWishList(customer_profile_oid)
Retrieve wishlist items for customer
Retrieve wishlist items for customer.
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer oid for this wishlist.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomerWishList(customer_profile_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer oid for this wishlist. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerWishListItemResponse getCustomerWishListItem(customer_profile_oid, customer_wishlist_item_oid)
Retrieve wishlist item for customer
Retrieve wishlist item for customer.
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer oid for this wishlist.
var customer_wishlist_item_oid = 56; // Number | The wishlist oid for this wishlist item.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomerWishListItem(customer_profile_oid, customer_wishlist_item_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer oid for this wishlist. | |
customer_wishlist_item_oid | Number | The wishlist oid for this wishlist item. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomersResponse getCustomers(opts)
Retrieve customers
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
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.CustomerApi();
var opts = {
'email': "email_example", // String | Email
'qb_class': "qb_class_example", // String | Quickbooks class
'quickbooks_code': "quickbooks_code_example", // String | Quickbooks code
'last_modified_dts_start': "last_modified_dts_start_example", // String | Last modified date start
'last_modified_dts_end': "last_modified_dts_end_example", // String | Last modified date end
'signup_dts_start': "signup_dts_start_example", // String | Signup date start
'signup_dts_end': "signup_dts_end_example", // String | Signup date end
'billing_first_name': "billing_first_name_example", // String | Billing first name
'billing_last_name': "billing_last_name_example", // String | Billing last name
'billing_company': "billing_company_example", // String | Billing company
'billing_city': "billing_city_example", // String | Billing city
'billing_state': "billing_state_example", // String | Billing state
'billing_postal_code': "billing_postal_code_example", // String | Billing postal code
'billing_country_code': "billing_country_code_example", // String | Billing country code
'billing_day_phone': "billing_day_phone_example", // String | Billing day phone
'billing_evening_phone': "billing_evening_phone_example", // String | Billing evening phone
'shipping_first_name': "shipping_first_name_example", // String | Shipping first name
'shipping_last_name': "shipping_last_name_example", // String | Shipping last name
'shipping_company': "shipping_company_example", // String | Shipping company
'shipping_city': "shipping_city_example", // String | Shipping city
'shipping_state': "shipping_state_example", // String | Shipping state
'shipping_postal_code': "shipping_postal_code_example", // String | Shipping postal code
'shipping_country_code': "shipping_country_code_example", // String | Shipping country code
'shipping_day_phone': "shipping_day_phone_example", // String | Shipping day phone
'shipping_evening_phone': "shipping_evening_phone_example", // String | Shipping evening phone
'pricing_tier_oid': 56, // Number | Pricing tier oid
'pricing_tier_name': "pricing_tier_name_example", // String | Pricing tier name
'_limit': 100, // Number | The maximum number of records to return on this one API call. (Max 200)
'_offset': 0, // Number | Pagination of the record set. Offset is a zero based index.
'_since': "_since_example", // String | Fetch customers that have been created/modified since this date/time.
'_sort': "_sort_example", // String | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomers(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
String | [optional] | ||
qb_class | String | Quickbooks class | [optional] |
quickbooks_code | String | Quickbooks code | [optional] |
last_modified_dts_start | String | Last modified date start | [optional] |
last_modified_dts_end | String | Last modified date end | [optional] |
signup_dts_start | String | Signup date start | [optional] |
signup_dts_end | String | Signup date end | [optional] |
billing_first_name | String | Billing first name | [optional] |
billing_last_name | String | Billing last name | [optional] |
billing_company | String | Billing company | [optional] |
billing_city | String | Billing city | [optional] |
billing_state | String | Billing state | [optional] |
billing_postal_code | String | Billing postal code | [optional] |
billing_country_code | String | Billing country code | [optional] |
billing_day_phone | String | Billing day phone | [optional] |
billing_evening_phone | String | Billing evening phone | [optional] |
shipping_first_name | String | Shipping first name | [optional] |
shipping_last_name | String | Shipping last name | [optional] |
shipping_company | String | Shipping company | [optional] |
shipping_city | String | Shipping city | [optional] |
shipping_state | String | Shipping state | [optional] |
shipping_postal_code | String | Shipping postal code | [optional] |
shipping_country_code | String | Shipping country code | [optional] |
shipping_day_phone | String | Shipping day phone | [optional] |
shipping_evening_phone | String | Shipping evening phone | [optional] |
pricing_tier_oid | Number | Pricing tier oid | [optional] |
pricing_tier_name | String | Pricing tier name | [optional] |
_limit | Number | The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100] |
_offset | Number | Pagination of the record set. Offset is a zero based index. | [optional] [default to 0] |
_since | String | Fetch customers that have been created/modified since this date/time. | [optional] |
_sort | String | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomersResponse getCustomersByQuery(customer_query, opts)
Retrieve customers by query
Retrieves customers from the account. If no parameters are specified, all customers will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
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.CustomerApi();
var customer_query = new UltraCartRestApiV2.CustomerQuery(); // CustomerQuery | Customer query
var opts = {
'_limit': 100, // Number | The maximum number of records to return on this one API call. (Max 200)
'_offset': 0, // Number | Pagination of the record set. Offset is a zero based index.
'_since': "_since_example", // String | Fetch customers that have been created/modified since this date/time.
'_sort': "_sort_example", // String | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomersByQuery(customer_query, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_query | CustomerQuery | Customer query | |
_limit | Number | The maximum number of records to return on this one API call. (Max 200) | [optional] [default to 100] |
_offset | Number | Pagination of the record set. Offset is a zero based index. | [optional] [default to 0] |
_since | String | Fetch customers that have been created/modified since this date/time. | [optional] |
_sort | String | The sort order of the customers. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
DataTablesServerSideResponse getCustomersForDataTables(opts)
Retrieve customers for DataTables plugin
Retrieves customers from the account. If no searches are specified, all customers will be returned.
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.CustomerApi();
var opts = {
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getCustomersForDataTables(opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
EmailVerifyTokenResponse getEmailVerificationToken(token_request)
Create a token that can be used to verify a customer email address
Create a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
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.CustomerApi();
var token_request = new UltraCartRestApiV2.EmailVerifyTokenRequest(); // EmailVerifyTokenRequest | Token request
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getEmailVerificationToken(token_request, callback);
Name | Type | Description | Notes |
---|---|---|---|
token_request | EmailVerifyTokenRequest | Token request |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerMagicLinkResponse getMagicLink(customer_profile_oid, storefront_host_name)
getMagicLink
Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer_profile_oid of the customer.
var storefront_host_name = "storefront_host_name_example"; // String | The storefront to log into.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.getMagicLink(customer_profile_oid, storefront_host_name, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer_profile_oid of the customer. | |
storefront_host_name | String | The storefront to log into. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
CustomerResponse insertCustomer(customer, opts)
Insert a customer
Insert a customer 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.CustomerApi();
var customer = new UltraCartRestApiV2.Customer(); // Customer | Customer to insert
var opts = {
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.insertCustomer(customer, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer | Customer | Customer to insert | |
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
CustomerWishListItem insertWishListItem(wishlist_item, customer_profile_oid)
Insert a customer wishlist item
Insert a customer wishlist item
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.CustomerApi();
var wishlist_item = new UltraCartRestApiV2.CustomerWishListItem(); // CustomerWishListItem | Wishlist item to insert
var customer_profile_oid = 56; // Number | The customer oid for this wishlist.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.insertWishListItem(wishlist_item, customer_profile_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
wishlist_item | CustomerWishListItem | Wishlist item to insert | |
customer_profile_oid | Number | The customer oid for this wishlist. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
mergeCustomer(customer, customer_profile_oid, opts)
Merge customer into this customer
Merge customer into this customer.
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.CustomerApi();
var customer = new UltraCartRestApiV2.CustomerMergeRequest(); // CustomerMergeRequest | Customer to merge into this profile.
var customer_profile_oid = 56; // Number | The customer_profile_oid to update.
var opts = {
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
apiInstance.mergeCustomer(customer, customer_profile_oid, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer | CustomerMergeRequest | Customer to merge into this profile. | |
customer_profile_oid | Number | The customer_profile_oid to update. | |
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
null (empty response body)
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
LookupResponse searchCustomerProfileValues(lookup_request)
Searches for all matching values (using POST)
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.CustomerApi();
var lookup_request = new UltraCartRestApiV2.LookupRequest(); // LookupRequest | LookupRequest
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.searchCustomerProfileValues(lookup_request, callback);
Name | Type | Description | Notes |
---|---|---|---|
lookup_request | LookupRequest | LookupRequest |
ultraCartBrowserApiKey, ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json
CustomerResponse updateCustomer(customer, customer_profile_oid, opts)
Update a customer
Update a customer 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.CustomerApi();
var customer = new UltraCartRestApiV2.Customer(); // Customer | Customer to update
var customer_profile_oid = 56; // Number | The customer_profile_oid to update.
var opts = {
'_expand': "_expand_example" // String | The object expansion to perform on the result. See documentation for examples
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateCustomer(customer, customer_profile_oid, opts, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer | Customer | Customer to update | |
customer_profile_oid | Number | The customer_profile_oid to update. | |
_expand | String | The object expansion to perform on the result. See documentation for examples | [optional] |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
CustomerEmailListChanges updateCustomerEmailLists(customer_profile_oid, list_changes)
Update email list subscriptions for a customer
Update email list subscriptions for a customer
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.CustomerApi();
var customer_profile_oid = 56; // Number | The customer profile oid
var list_changes = new UltraCartRestApiV2.CustomerEmailListChanges(); // CustomerEmailListChanges | List changes
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateCustomerEmailLists(customer_profile_oid, list_changes, callback);
Name | Type | Description | Notes |
---|---|---|---|
customer_profile_oid | Number | The customer profile oid | |
list_changes | CustomerEmailListChanges | List changes |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
CustomerWishListItem updateWishListItem(wishlist_item, customer_profile_oid, customer_wishlist_item_oid)
Update a customer wishlist item
Update a customer wishlist item
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.CustomerApi();
var wishlist_item = new UltraCartRestApiV2.CustomerWishListItem(); // CustomerWishListItem | Wishlist item to update
var customer_profile_oid = 56; // Number | The customer oid for this wishlist.
var customer_wishlist_item_oid = 56; // Number | The wishlist oid for this wishlist item.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.updateWishListItem(wishlist_item, customer_profile_oid, customer_wishlist_item_oid, callback);
Name | Type | Description | Notes |
---|---|---|---|
wishlist_item | CustomerWishListItem | Wishlist item to update | |
customer_profile_oid | Number | The customer oid for this wishlist. | |
customer_wishlist_item_oid | Number | The wishlist oid for this wishlist item. |
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json; charset=UTF-8
- Accept: application/json
EmailVerifyTokenValidateResponse validateEmailVerificationToken(validation_request)
Validate a token that can be used to verify a customer email address
Validate a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
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.CustomerApi();
var validation_request = new UltraCartRestApiV2.EmailVerifyTokenValidateRequest(); // EmailVerifyTokenValidateRequest | Token validation request
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
apiInstance.validateEmailVerificationToken(validation_request, callback);
Name | Type | Description | Notes |
---|---|---|---|
validation_request | EmailVerifyTokenValidateRequest | Token validation request |
EmailVerifyTokenValidateResponse
ultraCartOauth, ultraCartSimpleApiKey
- Content-Type: application/json
- Accept: application/json