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.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
- Download OpenAPI Specs
REST
GraphQL
MCP
Resources

GraphQL Storefront Types Inputs

AddCompanyAddressInput

INPUT

Definition

1 input AddCompanyAddressInput {
2   firstName: String!
3   lastName: String!
4   address1: String!
5   address2: String
6   city: String!
7   countryCode: String!
8   stateOrProvince: String
9   phone: String
10   postalCode: String
11   extraFields: CompanyExtraFieldsInput
12 }

Input for adding a company address.

Was this page helpful?

AddCheckoutShippingConsignmentsInput

AddCompanyFileInput

Input fields

firstNameStringRequired

First name of the address owner.

lastNameStringRequired

Last name of the address owner.

address1StringRequired

First line for the street address.

cityStringRequired

City.

countryCodeStringRequired

ISO 3166-1 alpha-2 country code.

address2StringOptional

Second line for the street address.

stateOrProvinceStringOptional

Name of State or Province.

phoneStringOptional

Phone number.

postalCodeStringOptional

Postal code.

extraFieldsCompanyExtraFieldsInputOptional

Extra fields defined by merchant.

Referenced by

Mutations

addAddress(input)

Fields

RegisterCompanyInput.address