Skip to main content

CreateCustomerInput

A new customer.

input CreateCustomerInput {
addressCity: String
addressCountry: String
addressPostalCode: String
addressState: String
addressStreet1: String
addressStreet2: String
alsoCreateAsVendor: Boolean!
assignedSalesRepId: String
businessCategory: String
buyingProcess: String
certifications: [String!]
communicationPreference: String!
companySize: String
contactEmail: String
contactName: String
contactPhone: String
creditLimit: Int!
creditRating: String
customerType: String
decisionMaker: String
description: String
displayName: String
industry: String
leadTimeDays: Int
legalName: String
loyaltyPoints: Int!
loyaltyTier: String
marketingOptIn: Boolean!
minimumOrderValue: Int
name: String!
notes: String
paymentTerms: String
preferredCurrency: String
preferredShippingMethod: String
productCategories: [String!]
registrationNumber: String
seasonality: String
serviceAreas: [String!]
specialInstructions: String
tags: [String!]!
taxId: String
type: String
vendorType: String
website: String
}

Fields​

CreateCustomerInput.addressCity ● String scalar​

The city.

CreateCustomerInput.addressCountry ● String scalar​

The country.

CreateCustomerInput.addressPostalCode ● String scalar​

The postal code.

CreateCustomerInput.addressState ● String scalar​

The state or region.

CreateCustomerInput.addressStreet1 ● String scalar​

The first line of the street address.

CreateCustomerInput.addressStreet2 ● String scalar​

The second line of the street address.

CreateCustomerInput.alsoCreateAsVendor ● Boolean! non-null scalar​

True to also create the customer as a vendor, using the vendor terms.

CreateCustomerInput.assignedSalesRepId ● String scalar​

The ID of the sales rep the customer is assigned to. Admins may set it. For a sales rep creating the customer, the server sets it to that rep.

CreateCustomerInput.businessCategory ● String scalar​

The customer's business category.

CreateCustomerInput.buyingProcess ● String scalar​

How the customer buys.

CreateCustomerInput.certifications ● [String!] list scalar​

The customer's certifications.

CreateCustomerInput.communicationPreference ● String! non-null scalar​

How the customer prefers to be contacted.

CreateCustomerInput.companySize ● String scalar​

The size of the customer's company.

CreateCustomerInput.contactEmail ● String scalar​

The email address of the main contact.

CreateCustomerInput.contactName ● String scalar​

The name of the main contact.

CreateCustomerInput.contactPhone ● String scalar​

The phone number of the main contact.

CreateCustomerInput.creditLimit ● Int! non-null scalar​

The credit limit. 0 or less means unlimited.

CreateCustomerInput.creditRating ● String scalar​

The customer's credit rating.

CreateCustomerInput.customerType ● String scalar​

The customer's business type.

CreateCustomerInput.decisionMaker ● String scalar​

Who makes the buying decision.

CreateCustomerInput.description ● String scalar​

What the customer is.

CreateCustomerInput.displayName ● String scalar​

The name to show for the customer.

CreateCustomerInput.industry ● String scalar​

The customer's industry.

CreateCustomerInput.leadTimeDays ● Int scalar​

The vendor's expected days from order to delivery, when also created as a vendor.

The legal name of the customer.

CreateCustomerInput.loyaltyPoints ● Int! non-null scalar​

The customer's loyalty points.

CreateCustomerInput.loyaltyTier ● String scalar​

The customer's loyalty tier.

CreateCustomerInput.marketingOptIn ● Boolean! non-null scalar​

True when the customer agreed to marketing messages.

CreateCustomerInput.minimumOrderValue ● Int scalar​

The smallest order value the customer may place.

CreateCustomerInput.name ● String! non-null scalar​

The name of the customer.

CreateCustomerInput.notes ● String scalar​

Notes about the customer.

CreateCustomerInput.paymentTerms ● String scalar​

The payment terms agreed with the customer.

CreateCustomerInput.preferredCurrency ● String scalar​

The currency of the customer's documents. Leave out to use the organization's default.

CreateCustomerInput.preferredShippingMethod ● String scalar​

The customer's preferred shipping method.

CreateCustomerInput.productCategories ● [String!] list scalar​

The product categories the customer deals in.

CreateCustomerInput.registrationNumber ● String scalar​

The customer's company registration number.

CreateCustomerInput.seasonality ● String scalar​

When the customer's buying peaks.

CreateCustomerInput.serviceAreas ● [String!] list scalar​

The areas the customer serves.

CreateCustomerInput.specialInstructions ● String scalar​

Special instructions for handling the customer.

CreateCustomerInput.tags ● [String!]! non-null scalar​

Tags on the customer.

CreateCustomerInput.taxId ● String scalar​

The customer's tax ID.

CreateCustomerInput.type ● String scalar​

The kind of customer.

CreateCustomerInput.vendorType ● String scalar​

The kind of vendor, when also created as a vendor.

CreateCustomerInput.website ● String scalar​

The customer's website.

Member Of​

createCustomer mutation