deleteShippingAddress
Delete shipping address for the current user.
By default, it uses the deleteShippingAddressDefaultQuery GraphQL query
Signature
declare function deleteShippingAddress(
context: CommercetoolsIntegrationContext,
params: DeleteShippingAddressParams,
customQuery?: CustomQuery
): Promise<DeleteShippingAddressResponse>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | CommercetoolsIntegrationContext | |
params | Required | DeleteShippingAddressParams | |
customQuery | Optional | CustomQuery |
Referenced Types
- CommercetoolsIntegrationContext
- DeleteShippingAddressParams
- CustomQuery
- DeleteShippingAddressResponse
Examples
Deleting a shipping address for the current user
const { user } = await sdk.commerce.deleteShippingAddress({
address: { id: "1" },
user: { version: "1" },
});