For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Developer
Developer
Search docs
/
Ask AI
Dev Portal
Docs
API Reference
Learn
Community
Changelog
GraphQL
B2B
Queries
address
Copy page
Details of the company address selected. Requires a B2B Token.
Arguments
companyId
Integer
Required
The id of the company. This field is required.
addressId
Integer
Required
The id of the address. This field is required.
Returns
an optional AddressType
id
String
createdAt
Integer
updatedAt
Integer
firstName
String
lastName
String
city
String
country
String
isActive
Integer
isShipping
Integer
Is this address used for shipping. 1 means true, 0 means false
isBilling
Integer
Is this address used for billing. 1 means true, 0 means false
addressLine1
String
addressLine2
String
address
String
state
String
stateCode
String
countryCode
String
zipCode
String
phoneNumber
String
label
String
company
String
The company of address
uuid
String
The uuid of address
extraFields
list of optional AddressExtraFieldType
List of address extra fields
isDefaultShipping
Integer
Is this address is the default shipping address.1 means true, 0 means false
isDefaultBilling
Integer
Is this address is the default billing address.1 means true, 0 means false
companyInfo
CompanyInfoType
Company information of address
