For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
  • GraphQL
    • Overview
      • Playground
          • QUERYcompanyRoles
          • QUERYcompanyRole
          • QUERYcompanyPermissions
          • QUERYaccountSettings
          • QUERYcustomerAccountSettings
          • QUERYinvoices
          • QUERYinvoice
          • QUERYinvoiceStats
          • QUERYinvoiceCustomerInformation
          • QUERYinvoicePaymentModules
          • QUERYinvoiceBcOrderAllowMethods
          • QUERYinvoicePaymentBcCart
          • QUERYinvoicePaymentFees
          • QUERYreceipts
          • QUERYreceipt
          • QUERYallReceiptLines
          • QUERYreceiptLine
          • QUERYreceiptLines
          • QUERYorder
          • QUERYallOrders
          • QUERYorderProducts
          • QUERYorderedProducts
          • QUERYcustomerOrders
          • QUERYcustomerOrder
          • QUERYcreatedByUser
          • QUERYshoppingLists
          • QUERYshoppingList
          • QUERYshoppingListsIdName
          • QUERYcustomerShoppingLists
          • QUERYcustomerShoppingList
          • QUERYcustomerShoppingListsIdName
          • QUERYcompanyExtraFields
          • QUERYuserCompany
          • QUERYcompanyValidateEmail
          • QUERYcompanyUserInfo
          • QUERYaccountFormFields
          • QUERYcompanyCreditConfig
          • QUERYcompanyPaymentTerms
          • QUERYcompanySubsidiaries
          • QUERYsuperAdminCompanies
          • QUERYsuperAdminMasquerading
          • QUERYquotes
          • QUERYcustomerQuotes
          • QUERYquote
          • QUERYquoteUserStoreInfo
          • QUERYquoteConfig
          • QUERYquoteExtraFieldsConfig
          • QUERYusers
          • QUERYuser
          • QUERYuserEmailCheck
          • QUERYcustomerEmailCheck
          • QUERYuserExtraFields
          • QUERYcurrentUser
          • QUERYcustomerInfo
          • QUERYuserLoginState
          • QUERYuserMasqueradingCompany
          • QUERYorderStatuses
          • QUERYbcOrderStatuses
          • QUERYcurrencies
          • QUERYautoLoader
          • QUERYstoreLimitations
          • QUERYstoreBasicInfo
          • QUERYstorefrontScript
          • QUERYstorefrontDefaultLanguage
          • QUERYstorefrontProductSettings
          • QUERYstorefrontSettings
          • QUERYstoreConfigSwitchStatus
          • QUERYstoreCheckoutConfig
          • QUERYstorefrontConfig
          • QUERYstorefrontConfigs
          • QUERYproductVariantsInfo
          • QUERYvariantSku
          • QUERYproductsInventory
          • QUERYproductsLoad
          • QUERYproductsSearch
          • QUERYtaxZoneRates
          • QUERYproductPurchasable
          • QUERYvalidateProduct
          • QUERYvalidateProducts
          • QUERYpriceProducts
          • QUERYaddresses
          • QUERYaddress
          • QUERYcountries
          • QUERYdefaultShippingAddress
          • QUERYdefaultBillingAddress
          • QUERYcustomerAddresses
          • QUERYcustomerAddress
          • QUERYaddressConfig
          • QUERYaddressExtraFields
  • MCP
    • Overview
Dev Portal
LogoLogo
GraphQLB2BQueries

addresses

Example Query
1query 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) {
2 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) {
3 pageInfo {
4 hasNextPage
5 hasPreviousPage
6 startCursor
7 endCursor
8 }
9 edges {
10 node
11 cursor
12 }
13 totalCount
14 }
15}
Variables
1{
2 "companyId": 0,
3 "offset": 0,
4 "before": "example",
5 "after": "example",
6 "first": 0,
7 "last": 0,
8 "search": "example",
9 "firstName": "example",
10 "lastName": "example",
11 "address": "example",
12 "country": "example",
13 "state": "example",
14 "city": "example",
15 "label": "example",
16 "uuid": "example",
17 "isShipping": "Decimal",
18 "isBilling": "Decimal",
19 "company": "example"
20}
Example response
1{
2 "data": {
3 "addresses": {
4 "pageInfo": {
5 "hasNextPage": true,
6 "hasPreviousPage": true,
7 "startCursor": "example",
8 "endCursor": "example"
9 },
10 "edges": [
11 {
12 "node": {
13 "id": null,
14 "createdAt": null,
15 "updatedAt": null,
16 "firstName": null,
17 "lastName": null,
18 "isShipping": null,
19 "isBilling": null,
20 "addressLine1": null,
21 "addressLine2": null,
22 "address": null
23 },
24 "cursor": "example"
25 }
26 ],
27 "totalCount": 0
28 }
29 }
30}
The list of addresses registered to the company. Requires a B2B Token.
Was this page helpful?
Previous

priceProducts

Next

address

Built with

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 AddressTypeCountableConnection
pageInfoPageInfo
Pagination data for this connection.
edgeslist of AddressTypeCountableEdges
totalCountInteger
A total count of items in the collection.