adminSetAddressActive

Requires a tenant administrator.

Activates or deactivates a buyer's shipping or delivery address. An active address can be ordered against, and activating one also promotes a customer still waiting for approval to active. Tenant admins only. Returns true on success.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation AdminSetAddressActive($addressId: ID!, $isActive: Boolean!) {
  adminSetAddressActive(addressId: $addressId, isActive: $isActive)
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation AdminSetAddressActive($addressId: ID!, $isActive: Boolean!) {\n  adminSetAddressActive(addressId: $addressId, isActive: $isActive)\n}",
  "variables": {
    "addressId": "id",
    "isActive": true
  }
}
EOF

Variables:

{
  "addressId": "id",
  "isActive": true
}

Response:

{
  "data": {
    "adminSetAddressActive": true
  }
}

adminSetAddressActive(
  addressId: ID!
  isActive: Boolean!
): Boolean!

Arguments

adminSetAddressActive.addressId ● ID! non-null scalar

The ID of the address.

adminSetAddressActive.isActive ● Boolean! non-null scalar

True to activate the address, false to deactivate it.

Type

Boolean scalar

The Boolean scalar type represents true or false.