new Customer(shopify)
Creates a Customer instance.
Parameters:
| Name | Type | Description |
|---|---|---|
shopify |
Shopify | Reference to the Shopify instance |
Methods
accountActivationUrl(id) → {Promise}
Generates and retrieve an account activation URL for a customer.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Number | Customer ID |
Returns:
Promise that resolves with the result
- Type
- Promise
orders(id, paramsopt) → {Promise}
Get all orders belonging to a customer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
id |
Number | Customer ID | |
params |
Object |
<optional> |
Query parameters |
Returns:
Promise that resolves with the result
- Type
- Promise
search(params) → {Promise}
Returns a list of customers matching the given search parameters.
Parameters:
| Name | Type | Description |
|---|---|---|
params |
Object | Search parameters |
Returns:
Promise that resolves with the result
- Type
- Promise
sendInvite(id, params) → {Promise}
Sends an account invite for the customer.
Parameters:
| Name | Type | Description |
|---|---|---|
id |
Number | Customer ID |
params |
Object | Optional params for adjusting the sent email |
Returns:
Promise that resolves with the result
- Type
- Promise