customerUpdateAddress

Requires a customer (portal or buyer app) session.

Update a partner address. screen 17.

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 CustomerUpdateAddress($addressId: ID!, $input: CustomerAddressInput!) {
  customerUpdateAddress(addressId: $addressId, input: $input) {
    id
    postalCode
    type
    city
    contactPhone
    country
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation CustomerUpdateAddress($addressId: ID!, $input: CustomerAddressInput!) {\n  customerUpdateAddress(addressId: $addressId, input: $input) {\n    id\n    postalCode\n    type\n    city\n    contactPhone\n    country\n  }\n}",
  "variables": {
    "addressId": "id",
    "input": {
      "city": "string",
      "country": "string",
      "postalCode": "string",
      "street1": "string"
    }
  }
}
EOF

Variables:

{
  "addressId": "id",
  "input": {
    "city": "string",
    "country": "string",
    "postalCode": "string",
    "street1": "string"
  }
}

Response:

{
  "data": {
    "customerUpdateAddress": {
      "id": "id",
      "postalCode": "string",
      "type": "BILLING",
      "city": "string",
      "contactPhone": "string",
      "country": "string"
    }
  }
}

customerUpdateAddress(
  addressId: ID!
  input: CustomerAddressInput!
): CustomerAddress!

Arguments

customerUpdateAddress.addressId ● ID! non-null scalar

The ID of the address.

customerUpdateAddress.input ● CustomerAddressInput! non-null input

The details of the customer address request.

Type

CustomerAddress object

An address of the customer.