Skip to main content

CustomerCreateInput

A customer to create in a bulk operation. Follows the same rules as createCustomer.

input CustomerCreateInput {
  billToCompany: String
  billToEmail: String
  billToName: String
  billToPhone: String
  billToSameAsShipTo: Boolean
  billingAddress: CustomerAddressInput
  contactName: String
  contactTitle: String
  customerType: CustomerTypeEnum
  defaultTemplateId: ID
  defaultView: CustomerViewEnum
  email: String
  freightPayer: FreightPayerEnum
  handle: String
  legalName: String
  name: String!
  notes: String
  parentId: ID
  paymentTerms: String
  phone: String
  preferredContactMethod: PreferredContactMethodEnum
  preferredLanguage: String
  salesChannelId: ID
  shipToCompany: String
  shipToEmail: String
  shipToName: String
  shipToPhone: String
  shippingAccounts: [CustomerShippingAccountInput!]
  shippingAddress: CustomerAddressInput
  startDate: ISO8601Date
  taxExempt: Boolean
  taxId: String
  website: String
}

Fields

`CustomerCreateInput.billToCompany` ● `String` scalar common

Default bill-to company name.

`CustomerCreateInput.billToEmail` ● `String` scalar common

Default bill-to contact email.

`CustomerCreateInput.billToName` ● `String` scalar common

Default bill-to contact name.

`CustomerCreateInput.billToPhone` ● `String` scalar common

Default bill-to contact phone.

`CustomerCreateInput.billToSameAsShipTo` ● `Boolean` scalar common

When true (default), bill-to contact details mirror ship-to.

`CustomerCreateInput.billingAddress` ● `CustomerAddressInput` input common

Default billing address. Cannot be provided while bill-to mirrors ship-to.

`CustomerCreateInput.contactName` ● `String` scalar common

Named primary contact for a business customer.

`CustomerCreateInput.contactTitle` ● `String` scalar common

Role or title of the named primary contact.

`CustomerCreateInput.customerType` ● `CustomerTypeEnum` enum people

The kind of buying entity. Defaults to BUSINESS.

`CustomerCreateInput.defaultTemplateId` ● `ID` scalar common

Default B2B template for the customer's orders.

`CustomerCreateInput.defaultView` ● `CustomerViewEnum` enum common

Default customer record layout. Null follows customerType without changing the customer type.

`CustomerCreateInput.email` ● `String` scalar common

Contact email.

`CustomerCreateInput.freightPayer` ● `FreightPayerEnum` enum people

Who pays freight on this customer's shipments.

`CustomerCreateInput.handle` ● `String` scalar common

Optional stable identifier unique within the company; useful as an upsert key for uploads.

`CustomerCreateInput.legalName` ● `String` scalar common

The registered legal entity name, when it differs from the display name - what belongs on invoices, tax documents and contracts.

`CustomerCreateInput.name` ● `String!` non-null scalar common

Display name of the buying entity.

`CustomerCreateInput.notes` ● `String` scalar common

Internal notes about the customer relationship.

`CustomerCreateInput.parentId` ● `ID` scalar common

Parent customer for single-level family rollup.

`CustomerCreateInput.paymentTerms` ● `String` scalar common

Payment terms label (e.g. "Net 30").

`CustomerCreateInput.phone` ● `String` scalar common

General contact phone for the relationship, distinct from the ship-to and bill-to snapshots on an order.

`CustomerCreateInput.preferredContactMethod` ● `PreferredContactMethodEnum` enum people

The customer's stated preferred communication channel.

`CustomerCreateInput.preferredLanguage` ● `String` scalar common

The customer's stated preferred language.

`CustomerCreateInput.salesChannelId` ● `ID` scalar common

The customer's home sales channel.

`CustomerCreateInput.shipToCompany` ● `String` scalar common

Default ship-to company name.

`CustomerCreateInput.shipToEmail` ● `String` scalar common

Default ship-to contact email.

`CustomerCreateInput.shipToName` ● `String` scalar common

Default ship-to contact name.

`CustomerCreateInput.shipToPhone` ● `String` scalar common

Default ship-to contact phone.

`CustomerCreateInput.shippingAccounts` ● `[CustomerShippingAccountInput!]` list input people

Carrier accounts billed for this customer's shipments.

`CustomerCreateInput.shippingAddress` ● `CustomerAddressInput` input common

Default shipping address.

`CustomerCreateInput.startDate` ● `ISO8601Date` scalar common

The calendar date when the customer relationship began.

`CustomerCreateInput.taxExempt` ● `Boolean` scalar common

Whether the customer is exempt from sales tax.

`CustomerCreateInput.taxId` ● `String` scalar common

The buying entity's tax identification number.

`CustomerCreateInput.website` ● `String` scalar common

The buying entity's website URL.

Member Of

BulkCreateCustomersInput input

Fields
Member Of