Skip to main content

CustomerAddressInput

An address of the customer.

input CustomerAddressInput {
city: String!
contactName: String
contactPhone: String
country: String!
customFields: JSON
instructions: String
isBranch: Boolean
isDualPurpose: Boolean
label: String
latitude: Float
longitude: Float
orderLimit: Float
postalCode: String!
state: String
street1: String!
street2: String
type: CustomerAddressType
}

Fields​

CustomerAddressInput.city ● String! non-null scalar​

The city.

CustomerAddressInput.contactName ● String scalar​

The person to ask for at the address.

CustomerAddressInput.contactPhone ● String scalar​

The phone number at the address.

CustomerAddressInput.country ● String! non-null scalar​

The country.

CustomerAddressInput.customFields ● JSON scalar​

Values for the organization's own address fields, keyed by field key. Only fields buyers may fill in are accepted. A key sent replaces the stored value, null clears it, and a key left out keeps its value.

CustomerAddressInput.instructions ● String scalar​

Delivery notes for the address, e.g. a gate code or the hours deliveries are taken.

CustomerAddressInput.isBranch ● Boolean scalar​

create this address as a sales branch (requires label).

CustomerAddressInput.isDualPurpose ● Boolean scalar​

This address serves both shipping and billing (read together with type).

CustomerAddressInput.label ● String scalar​

A label for the address.

CustomerAddressInput.latitude ● Float scalar​

The latitude of the address on the map.

CustomerAddressInput.longitude ● Float scalar​

The longitude of the address on the map.

CustomerAddressInput.orderLimit ● Float scalar​

branch order-value ceiling (org base currency; null = unlimited; > 0 only).

CustomerAddressInput.postalCode ● String! non-null scalar​

The postal code.

CustomerAddressInput.state ● String scalar​

The state or region.

CustomerAddressInput.street1 ● String! non-null scalar​

The first line of the street address.

CustomerAddressInput.street2 ● String scalar​

The second line of the street address.

CustomerAddressInput.type ● CustomerAddressType enum​

SHIPPING to deliver here, BILLING to invoice here. A new address defaults to SHIPPING.

Member Of​

customerCreateAddress mutation ● customerUpdateAddress mutation ● RegisterCustomerInput input