Skip to main content

CustomerAddressCreateInput

Input data for creating a new customer address.

Contains all necessary information to create an address associated with a specific customer account.

input CustomerAddressCreateInput {
  firstName: String
  middleName: String
  lastName: String
  gender: Gender
  company: String
  street: String!
  number: String
  numberExtension: String
  postalCode: String!
  city: String!
  region: String
  country: String!
  phone: String
  mobile: String
  email: String
  code: String
  notes: String
  isDefault: YesNo
  icp: YesNo
  customerId: Int!
  type: AddressType!
}

Fields​

CustomerAddressCreateInput.firstName ● String scalar​

First name of the person associated with this address.

Used for delivery and contact purposes. Maximum length of 30 characters.

CustomerAddressCreateInput.middleName ● String scalar​

Middle name of the person associated with this address.

Used for formal identification and delivery purposes. Maximum length of 20 characters.

CustomerAddressCreateInput.lastName ● String scalar​

Last name of the person associated with this address.

Used for delivery and contact purposes. Maximum length of 50 characters.

CustomerAddressCreateInput.gender ● Gender enum​

Gender of the person associated with this address.

Used for personalized communication and delivery preferences. Accepts M (Male), F (Female), or U (Unknown).

CustomerAddressCreateInput.company ● String scalar​

Company name associated with this address.

Used for business deliveries and B2B transactions. Maximum length of 100 characters.

CustomerAddressCreateInput.street ● String! non-null scalar​

Street name and address line for the location.

Primary address line containing street name and any additional location details. Required field with maximum length of 150 characters.

CustomerAddressCreateInput.number ● String scalar​

House or building number for the address.

Numeric or alphanumeric identifier for the specific building or location. Minimum length of 1 character, maximum length of 10 characters.

CustomerAddressCreateInput.numberExtension ● String scalar​

Additional identifier for the building number.

Used for apartment numbers, suite numbers, or other building extensions. Maximum length of 7 characters.

CustomerAddressCreateInput.postalCode ● String! non-null scalar​

Postal code for the address location.

ZIP code, postal code, or equivalent regional identifier. Required field with maximum length of 10 characters.

CustomerAddressCreateInput.city ● String! non-null scalar​

City name for the address location.

Municipality, city, or town name where the address is located. Required field with maximum length of 100 characters.

CustomerAddressCreateInput.region ● String scalar​

State, province, or region code for the address.

Two-character code representing the administrative region. Used for shipping calculations and regional compliance. Maximum length of 2 characters.

CustomerAddressCreateInput.country ● String! non-null scalar​

Country code for the address location.

Two-character ISO country code (e.g., US, GB, DE). Required field used for shipping, tax calculations, and regional compliance. Maximum length of 2 characters.

CustomerAddressCreateInput.phone ● String scalar​

Fixed landline phone number for the address.

Used for delivery coordination and customer contact. Minimum length of 6 characters, maximum length of 30 characters.

CustomerAddressCreateInput.mobile ● String scalar​

Mobile phone number for the address contact.

Used for delivery notifications and customer communication. Minimum length of 6 characters, maximum length of 30 characters.

CustomerAddressCreateInput.email ● String scalar​

Email address for the contact person at this address.

Used for delivery notifications and customer communication. Must be a valid email format.

CustomerAddressCreateInput.code ● String scalar​

Custom reference code for the address.

Internal identifier or reference code for address management and tracking purposes. Maximum length of 64 characters.

CustomerAddressCreateInput.notes ● String scalar​

Special delivery instructions or notes for the address.

Additional information for delivery personnel such as access codes, special instructions, or location details. Maximum length of 255 characters.

CustomerAddressCreateInput.isDefault ● YesNo enum​

Indicates whether this address is the default for its type.

When set to Y, this address becomes the primary address for its type (home, delivery, invoice). Only one address per type can be default.

CustomerAddressCreateInput.icp ● YesNo enum​

Intra-Community Purchase (ICP) tax designation for B2B transactions.

Determines whether tax should be applied when this address is used as a delivery address for cross-border B2B orders within the EU. Set to Y to apply ICP tax rules, N to use standard tax calculation.

CustomerAddressCreateInput.customerId ● Int! non-null scalar​

Unique identifier of the customer who owns this address.

Must be a positive integer representing a valid customer ID in the system.

CustomerAddressCreateInput.type ● AddressType! non-null enum​

Type of address being created.

Specifies the purpose of this address. Accepts 'home' for residential addresses, 'delivery' for shipping addresses, or 'invoice' for billing addresses.

Member Of​

customerAddressCreate mutation