addresses | BigCommerce Developer Center

query ExampleQuery($companyId: Int, $offset: Int, $before: String, $after: String, $first: Int, $last: Int, $search: String, $firstName: String, $lastName: String, $address: String, $country: String, $state: String, $city: String, $label: String, $uuid: String, $isShipping: Decimal, $isBilling: Decimal, $company: String) {
  addresses(companyId: $companyId, offset: $offset, before: $before, after: $after, first: $first, last: $last, search: $search, firstName: $firstName, lastName: $lastName, address: $address, country: $country, state: $state, city: $city, label: $label, uuid: $uuid, isShipping: $isShipping, isBilling: $isBilling, company: $company) {
    pageInfo {
      hasNextPage
      hasPreviousPage
      startCursor
      endCursor
    }
    edges {
      node
      cursor
    }
    totalCount
  }
}

{
  "companyId": 0,
  "offset": 0,
  "before": "example",
  "after": "example",
  "first": 0,
  "last": 0,
  "search": "example",
  "firstName": "example",
  "lastName": "example",
  "address": "example",
  "country": "example",
  "state": "example",
  "city": "example",
  "label": "example",
  "uuid": "example",
  "isShipping": "Decimal",
  "isBilling": "Decimal",
  "company": "example"
}

{
  "data": {
    "addresses": {
      "pageInfo": {
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example",
        "endCursor": "example"
      },
      "edges": [
        {
          "node": {
            "id": null,
            "createdAt": null,
            "updatedAt": null,
            "firstName": null,
            "lastName": null,
            "isShipping": null,
            "isBilling": null,
            "addressLine1": null,
            "addressLine2": null,
            "address": null
          },
          "cursor": "example"
        }
      ],
      "totalCount": 0
    }
  }
}

The list of addresses registered to the company. Requires a B2B Token.

Arguments

companyIdIntegerRequired

The id of the company. This field is required.

offsetIntegerOptional

beforeStringOptional

afterStringOptional

firstIntegerOptional

lastIntegerOptional

searchStringOptional

firstNameStringOptional

lastNameStringOptional

addressStringOptional

countryStringOptional

stateStringOptional

cityStringOptional

labelStringOptional

uuidStringOptional

isShippingDecimalOptional

isBillingDecimalOptional

companyStringOptional

Returns

an optional Object

pageInfoObject

Pagination data for this connection.

edgeslist of Objects

totalCountInteger

A total count of items in the collection.