customerAddresses | BigCommerce Developer Center

query ExampleQuery($offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $firstName: String, $lastName: String, $country: String, $stateOrProvince: String, $city: String, $company: String) {
  customerAddresses(offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, firstName: $firstName, lastName: $lastName, country: $country, stateOrProvince: $stateOrProvince, city: $city, company: $company) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example",
  "firstName": "example",
  "lastName": "example",
  "country": "example",
  "stateOrProvince": "example",
  "city": "example",
  "company": "example"
}

{
  "data": {
    "customerAddresses": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "firstName": null,
            "lastName": null,
            "company": null,
            "bcAddressId": null,
            "address1": null,
            "address2": null,
            "city": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

The list of addresses registered to the user. Requires a BC Token.

Arguments

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

firstNameStringOptional

lastNameStringOptional

countryStringOptional

stateOrProvinceStringOptional

cityStringOptional

companyStringOptional

Returns

an optional Object

pageInfoObject

Pagination data for this connection.

edgeslist of Objects

totalCountInteger

A total count of items in the collection.