Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 3.37 KB

update-customer-request.md

File metadata and controls

38 lines (29 loc) · 3.37 KB
Raw

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
givenName string | undefined Optional The given name (that is, the first name) associated with the customer profile.

The maximum length for this value is 300 characters.
familyName string | undefined Optional The family name (that is, the last name) associated with the customer profile.

The maximum length for this value is 300 characters.
companyName string | undefined Optional A business name associated with the customer profile.

The maximum length for this value is 500 characters.
nickname string | undefined Optional A nickname for the customer profile.

The maximum length for this value is 100 characters.
emailAddress string | undefined Optional The email address associated with the customer profile.

The maximum length for this value is 254 characters.
address Address | undefined Optional Represents a postal address in a country.
For more information, see Working with Addresses.
phoneNumber string | undefined 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.
referenceId string | undefined 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.
note string | undefined Optional A custom note associated with the customer profile.
birthday string | undefined 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.
version bigint | undefined 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.
taxIds CustomerTaxIds | undefined 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.

Example (as JSON)

{
  "email_address": "[email protected]",
  "note": "updated customer note",
  "phone_number": "",
  "version": 2
}