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

address

Example Query
1query ExampleQuery($companyId: Int, $addressId: Int) {
2  address(companyId: $companyId, addressId: $addressId) {
3    id
4    createdAt
5    updatedAt
6    firstName
7    lastName
8    isShipping
9    isBilling
10    addressLine1
11    addressLine2
12    address
13  }
14}
Variables
1{
2  "companyId": 0,
3  "addressId": 0
4}
Example response
1{
2  "data": {
3    "address": {
4      "id": "example",
5      "createdAt": 0,
6      "updatedAt": 0,
7      "firstName": "example",
8      "lastName": "example",
9      "isShipping": 0,
10      "isBilling": 0,
11      "addressLine1": "example",
12      "addressLine2": "example",
13      "address": "example"
14    }
15  }
16}
Details of the company address selected. Requires a B2B Token.
Was this page helpful?
Previous

addresses

Next

countries

Built with

Arguments

companyIdIntegerRequired
The id of the company. This field is required.
addressIdIntegerRequired
The id of the address. This field is required.

Returns

an optional AddressType
idString
createdAtInteger
updatedAtInteger
firstNameString
lastNameString
cityString
countryString
isActiveInteger
isShippingInteger
Is this address used for shipping. 1 means true, 0 means false
isBillingInteger
Is this address used for billing. 1 means true, 0 means false
addressLine1String
addressLine2String
addressString
stateString
stateCodeString
countryCodeString
zipCodeString
phoneNumberString
labelString
companyString
The company of address
uuidString
The uuid of address
extraFieldslist of optional AddressExtraFieldType
List of address extra fields
isDefaultShippingInteger
Is this address is the default shipping address.1 means true, 0 means false
isDefaultBillingInteger
Is this address is the default billing address.1 means true, 0 means false
companyInfoCompanyInfoType
Company information of address