new CustomerAddress(shopify)
Creates an CustomerAddress instance.
Parameters:
| Name | Type | Description |
|---|---|---|
shopify |
Shopify | Reference to the Shopify instance |
Methods
create(customerId, params) → {Promise}
Creates a new address for a customer.
Parameters:
| Name | Type | Description |
|---|---|---|
customerId |
Number | Customer ID |
params |
Object | Address properties |
Returns:
Promise that resolves with the result
- Type
- Promise
default(customerId, id) → {Promise}
Sets default address for a customer.
Parameters:
| Name | Type | Description |
|---|---|---|
customerId |
Number | Customer ID |
id |
Number | Address ID |
Returns:
Promise that resolves with the result
- Type
- Promise
list(customerId, paramsopt) → {Promise}
Gets a list of addresses for a customer.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
customerId |
Number | Customer ID | |
params |
Object |
<optional> |
Query parameters |
Returns:
Promise that resolves with the result
- Type
- Promise
set(customerId, params) → {Promise}
Performs bulk operations against a number of addresses.
Parameters:
| Name | Type | Description |
|---|---|---|
customerId |
Number | Customer ID |
params |
Object | Query parameters |
Returns:
Promise that resolves with the result
- Type
- Promise
update(customerId, id, params) → {Promise}
Updates a customer address.
Parameters:
| Name | Type | Description |
|---|---|---|
customerId |
Number | Customer ID |
id |
Number | Address ID |
params |
Object | Address properties |
Returns:
Promise that resolves with the result
- Type
- Promise