Customers
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.
Insert a customer
Insert a customer on the UltraCart account.
Retrieve a customer by Email
Retrieves a single customer using the specified customer email address.
Retrieve customers for DataTables plugin
Retrieves customers from the account. If no searches are specified, all customers will be returned.
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.
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.
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.
Search for customers
Retrieves customers from the account by matching the search value against most customer fields. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination. This search also goes against the cache so updates should not be performed with these result objects. Always re-query the individual customer profile if you are going to make updates.
Delete a customer
Delete a customer on the UltraCart account.
Retrieve a customer
Retrieves a single customer using the specified customer profile oid.
Update a customer
Update a customer on the UltraCart account.
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.
Update email list subscriptions for a customer
Update email list subscriptions for a customer
Clear email suppression for a customer
Clears global unsubscribe, spam complaint and/or bounce suppression for a customer. This method is clear-only and cannot set a suppression flag. Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer's original lists become deliverable again with no further action. Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case.
getMagicLink
Retrieves a magic link to allow a merchant to login as a customer. This method is a PUT call intentionally.
Merge customer into this customer
Merge customer into this customer.
Retrieve the customer store credit accumulated through loyalty programs
Retrieve the customer store credit accumulated through loyalty programs
Adds store credit to a customer
Adds store credit to a customer
Retrieve wishlist items for customer
Retrieve wishlist items for customer.
Insert a customer wishlist item
Insert a customer wishlist item
Delete a customer wishlist item
Delete a customer wishlist item
Retrieve wishlist item for customer
Retrieve wishlist item for customer.
Update a customer wishlist item
Update a customer wishlist item
Retrieve values needed for a customer profile editor
Retrieve values needed for a customer profile editor.
Retrieve all email lists across all storefronts
Retrieve all email lists across all storefronts
Search the merchant's QuickBooks Online customers
Typeahead search of the merchant's QuickBooks Online customers by display name. Used by the customer profile editor to link a profile 1:1 to a QuickBooks Online customer. Returns up to 100 matches. If QuickBooks Online is not connected the list will be empty.
Searches for all matching values (using POST)
Searches for all matching values (using POST)
Webhooks
The following webhook events are available for this resource. See Webhooks for how delivery, retries, and versioning work.
| Event | Description | Reflow | Expandable |
|---|---|---|---|
customer_create | Fired when a customer profile is created. | — | Yes |
customer_delete | Fired when a customer profile is deleted. | — | Yes |
customer_update | Fired when a customer profile is updated. | — | Yes |