You are reading the documentation for SDK v2, which is no longer the latest version. Switch to current
setDefaultShippingAddress
Endpoint for setting default shipping address of the currently logged user based on provided ID. By default, it uses the setDefaultShippingAddressDefaultQuery GraphQL query
Signature
export declare function setDefaultShippingAddress(
context: SetupContext,
params: SetDefaultShippingAddressParams,
customQuery?: CustomQuery,
responseOptions?: ResponseOptions
): Promise<SetDefaultShippingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SetupContext | Automatically injected context. Refer to SetupContext |
params | Required | SetDefaultShippingAddressParams | User and address information |
customQuery | Optional | CustomQuery | Custom queries included in the request |
responseOptions | Optional | ResponseOptions |
Returns
Customer data