API Guide Items- Customers - Update a Customer

Customers - Update a Customer

PUT yourdomain.com/api/customers/:id

Header

json
Field Type Description
Authorization String

Basic Access Authentication token.

Parameter

json
Field Type Description
company String

Mandatory Customer company.

vat (optional) String

Optional Vat.

phonenumber (optional) String

Optional Customer Phone.

website (optional) String

Optional Customer Website.

groups_in (optional) Number[]

Optional Customer groups.

default_language (optional) String

Optional Customer Default Language.

default_currency (optional) String

Optional default currency.

address (optional) String

Optional Customer address.

city (optional) String

Optional Customer City.

state (optional) String

Optional Customer state.

zip (optional) String

Optional Zip Code.

country (optional) String

Optional country.

billing_street (optional) String

Optional Billing Address: Street.

billing_city (optional) String

Optional Billing Address: City.

billing_state (optional) Number

Optional Billing Address: State.

billing_zip (optional) String

Optional Billing Address: Zip.

billing_country (optional) String

Optional Billing Address: Country.

shipping_street (optional) String

Optional Shipping Address: Street.

shipping_city (optional) String

Optional Shipping Address: City.

shipping_state (optional) String

Optional Shipping Address: State.

shipping_zip (optional) String

Optional Shipping Address: Zip.

shipping_country (optional) String

Optional Shipping Address: Country.

Success 200

json
Field Type Description
status Boolean

Request status.

message String

Customer Update Successful.

Error 4xx

json
Name Type Description
status Boolean

Request status.

message String

Customer Update Fail.

HTTP/1.1 200 OK
{
  "status": true,
  "message": "Customer Update Successful."
}
HTTP/1.1 404 Not Found
{
  "status": false,
  "message": "Customer Update Fail."
}

Did you find this article useful?