customer

customer.update

Update information of customer in store.

put/customer.update.json

Request

  • Base URL: https://api.api2cart.com/v1.1
  • URL: https://api.api2cart.com/v1.1/customer.update.json
  • Auth: API key in header x-api-key and API key in header x-store-key

Request body

idstring

Entity id

group_idstring

Customer group_id

group_idsstring

Groups that will be assigned to a customer

groupstring

Defines the group where the customer

emailstring

Defines customer's email

phonestring

Defines customer's phone number

first_namestring

Defines customer's first name

last_namestring

Defines customer's last name

birth_daystring

Defines customer's birthday

news_letter_subscriptionboolean

Defines whether the newsletter subscription is available for the user

partner_offers_subscriptionboolean

Defines whether the customer agreed to receive offers from partners

tagsstring

Customer tags

genderstring

Defines customer's gender

notestring

The customer note.

statusstring

Defines customer's status

passwordstring

Defines customer's unique password

currency_idstring

Currency Id

companystring

Defines customer's company

websitestring

Link to customer website

countrystring

Specifies ISO code or name of country

faxstring

Defines customer's fax

tax_idstring

Add Tax Id

is_tax_exemptboolean

Marks a customer as tax-exempt (B2B/wholesale).

vendor_idstring

Updates vendor id of the customer

store_idstring

Store Id

idempotency_keystring

A unique identifier associated with a specific request. Repeated requests with the same <strong>idempotency_key</strong> return a cached response without re-executing the business logic. <strong>Please note that the cache lifetime is 15 minutes.</strong>

Example request

{
  "group_ids": "1,2,3",
  "group": "Register",
  "email": "mail@example.com",
  "phone": "56686868654",
  "first_name": "John",
  "last_name": "Smith",
  "birth_day": "2013-02-26 15:00:00",
  "news_letter_subscription": true,
  "partner_offers_subscription": true,
  "tags": "tag1,tag2",
  "gender": "male",
  "note": "Customer note",
  "status": "disabled",
  "password": "fd5gfd5g75fd",
  "currency_id": "usd",
  "company": "Apple",
  "website": "http://api2cart.com",
  "country": "US",
  "fax": "54545787",
  "tax_id": "`12345678`",
  "vendor_id": "1",
  "store_id": "1",
  "idempotency_key": "098f6bcd4621d373cade4e832627b4f6",
  "address": [
    {
      "address_book_id": "7805807034473",
      "address_book_first_name": "John",
      "address_book_last_name": "Smith",
      "address_book_company": "Samsung",
      "address_book_fax": "5758787",
      "address_book_phone": "5758787",
      "address_book_phone_mobile": "5758787",
      "address_book_address1": "Green str. 35",
      "address_book_address2": "Green str. 35",
      "address_book_city": "Chicago",
      "address_book_country": "US",
      "address_book_state": "IL",
      "address_book_postcode": "12345",
      "address_book_tax_id": "`12345678`",
      "address_book_identification_number": "`123-456-7890`",
      "address_book_gender": "male",
      "address_book_region": "Alabama",
      "address_book_alias": "Address alias",
      "address_book_type": "billing",
      "address_book_default": true
    }
  ]
}

Response

successful operation

return_codeinteger
return_messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.