Skip to navigation

address

Details of the company address selected. Requires a B2B Token.

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
isShippingIntegerOptional
Is this address used for shipping. 1 means true, 0 means false
isBillingIntegerOptional
Is this address used for billing. 1 means true, 0 means false
addressLine1StringOptional
addressLine2StringOptional
addressStringOptional
stateStringOptional
stateCodeStringOptional
countryCodeStringOptional
zipCodeStringOptional
phoneNumberStringOptional
labelStringOptional
companyStringOptional
The company of address
uuidStringOptional
The uuid of address
extraFieldslist of optional AddressExtraFieldTypeOptional
List of address extra fields
isDefaultShippingIntegerOptional
Is this address is the default shipping address.1 means true, 0 means false
isDefaultBillingIntegerOptional
Is this address is the default billing address.1 means true, 0 means false
companyInfoCompanyInfoTypeOptional
Company information of address