Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 4.16 KB

update-customer-request.md

File metadata and controls

42 lines (33 loc) · 4.16 KB

Update Customer Request

Defines the body parameters that can be included in a request to the UpdateCustomer endpoint.

Structure

UpdateCustomerRequest

Fields

Name Type Tags Description Getter Setter
givenName ?string Optional The given name (that is, the first name) associated with the customer profile.

The maximum length for this value is 300 characters.		 getGivenName(): ?string setGivenName(?string givenName): void
familyName ?string Optional The family name (that is, the last name) associated with the customer profile.

The maximum length for this value is 300 characters.		 getFamilyName(): ?string setFamilyName(?string familyName): void
companyName ?string Optional A business name associated with the customer profile.

The maximum length for this value is 500 characters.		 getCompanyName(): ?string setCompanyName(?string companyName): void
nickname ?string Optional A nickname for the customer profile.

The maximum length for this value is 100 characters.		 getNickname(): ?string setNickname(?string nickname): void
emailAddress ?string Optional The email address associated with the customer profile.

The maximum length for this value is 254 characters.		 getEmailAddress(): ?string setEmailAddress(?string emailAddress): void
address ?Address Optional Represents a postal address in a country.
For more information, see Working with Addresses.		 getAddress(): ?Address setAddress(?Address address): void
phoneNumber ?string Optional The phone number associated with the customer profile. The phone number must be valid and can contain
9–16 digits, with an optional + prefix and country code. For more information, see
Customer phone numbers.		 getPhoneNumber(): ?string setPhoneNumber(?string phoneNumber): void
referenceId ?string Optional An optional second ID used to associate the customer profile with an
entity in another system.

The maximum length for this value is 100 characters.		 getReferenceId(): ?string setReferenceId(?string referenceId): void
note ?string Optional A custom note associated with the customer profile. getNote(): ?string setNote(?string note): void
birthday ?string Optional The birthday associated with the customer profile, in YYYY-MM-DD or MM-DD format. For example,
specify 1998-09-21 for September 21, 1998, or 09-21 for September 21. Birthdays are returned in YYYY-MM-DD
format, where YYYY is the specified birth year or 0000 if a birth year is not specified.		 getBirthday(): ?string setBirthday(?string birthday): void
version ?int Optional The current version of the customer profile.

As a best practice, you should include this field to enable optimistic concurrency control. For more information, see Update a customer profile.		 getVersion(): ?int setVersion(?int version): void
taxIds ?CustomerTaxIds Optional Represents the tax ID associated with a customer profile. The corresponding tax_ids field is available only for customers of sellers in EU countries or the United Kingdom.
For more information, see Customer tax IDs.		 getTaxIds(): ?CustomerTaxIds setTaxIds(?CustomerTaxIds taxIds): void

Example (as JSON)

{
  "email_address": "[email protected]",
  "note": "updated customer note",
  "phone_number": null,
  "version": 2,
  "given_name": "given_name0",
  "family_name": "family_name8",
  "company_name": "company_name4",
  "nickname": "nickname4"
}