Customers

customer Customer Repository V1Get By Id Get

get

Get customer by Customer ID.

Path parameters
customerIdstringRequired

(Required)

Example: <integer>
Responses
200

OK

application/json
Responseobject
get
/V1/customers/{customerId}

customer Customer Repository V1Save Put

put

Create or update a customer.

Path parameters
customerIdstringRequired

(Required)

Example: <string>
Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"customer":{"email":"<string>","firstname":"<string>","lastname":"<string>","id":"<integer>","group_id":"<integer>","default_billing":"<string>","default_shipping":"<string>","confirmation":"<string>","created_at":"<string>","updated_at":"<string>","created_in":"<string>","dob":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","gender":"<integer>","store_id":"<integer>","taxvat":"<string>","website_id":"<integer>","addresses":[{"id":"<integer>","customer_id":"<integer>","region":{"region_code":"<string>","region":"<string>","region_id":"<integer>","extension_attributes":"<object>"},"region_id":"<integer>","country_id":"<string>","street":["<string>","<string>"],"company":"<string>","telephone":"<string>","fax":"<string>","postcode":"<string>","city":"<string>","firstname":"<string>","lastname":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","vat_id":"<string>","default_shipping":"<boolean>","default_billing":"<boolean>","extension_attributes":"<object>","custom_attributes":[{"attribute_code":"magna nulla dolor proident","value":"esse dolor sint pariatur"},{"attribute_code":"exercitation et eiusmod mollit in","value":"qui Ut anim dolor"}]},{"id":"<integer>","customer_id":"<integer>","region":{"region_code":"<string>","region":"<string>","region_id":"<integer>","extension_attributes":"<object>"},"region_id":"<integer>","country_id":"<string>","street":["<string>","<string>"],"company":"<string>","telephone":"<string>","fax":"<string>","postcode":"<string>","city":"<string>","firstname":"<string>","lastname":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","vat_id":"<string>","default_shipping":"<boolean>","default_billing":"<boolean>","extension_attributes":"<object>","custom_attributes":[{"attribute_code":"esse cupidatat minim","value":"est in dolor"},{"attribute_code":"velit sit","value":"dolore ullamco eiusmod"}]}],"disable_auto_group_change":"<integer>","extension_attributes":{"assistance_allowed":"<integer>","is_subscribed":"<boolean>","amazon_id":"<string>","vertex_customer_code":"<string>","vertex_customer_country":"<string>"},"custom_attributes":[{"attribute_code":"aute irure ullamco ut","value":"exercitation et"},{"attribute_code":"dolore eu reprehenderit","value":"co"}]},"passwordHash":"<string>"}
Responses
200

OK

application/json
Responseobject
put
/V1/customers/{customerId}

customer Customer Repository V1Delete By Id Delete

delete

Delete customer by Customer ID.

Path parameters
customerIdstringRequired

(Required)

Example: <integer>
Responses
200

OK

application/json
Responseobject
delete
/V1/customers/{customerId}

customer Account Management V1Create Account Post

post

Create customer account. Perform necessary business operations like sending email.

Header parameters
Content-TypestringOptionalExample: application/json
Body
objectOptionalExample: {"customer":{"email":"<string>","firstname":"<string>","lastname":"<string>","id":"<integer>","group_id":"<integer>","default_billing":"<string>","default_shipping":"<string>","confirmation":"<string>","created_at":"<string>","updated_at":"<string>","created_in":"<string>","dob":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","gender":"<integer>","store_id":"<integer>","taxvat":"<string>","website_id":"<integer>","addresses":[{"id":"<integer>","customer_id":"<integer>","region":{"region_code":"<string>","region":"<string>","region_id":"<integer>","extension_attributes":"<object>"},"region_id":"<integer>","country_id":"<string>","street":["<string>","<string>"],"company":"<string>","telephone":"<string>","fax":"<string>","postcode":"<string>","city":"<string>","firstname":"<string>","lastname":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","vat_id":"<string>","default_shipping":"<boolean>","default_billing":"<boolean>","extension_attributes":"<object>","custom_attributes":[{"attribute_code":"sed dolore","value":"anim m"},{"attribute_code":"qui nostrud sunt ","value":"aliqua Lorem"}]},{"id":"<integer>","customer_id":"<integer>","region":{"region_code":"<string>","region":"<string>","region_id":"<integer>","extension_attributes":"<object>"},"region_id":"<integer>","country_id":"<string>","street":["<string>","<string>"],"company":"<string>","telephone":"<string>","fax":"<string>","postcode":"<string>","city":"<string>","firstname":"<string>","lastname":"<string>","middlename":"<string>","prefix":"<string>","suffix":"<string>","vat_id":"<string>","default_shipping":"<boolean>","default_billing":"<boolean>","extension_attributes":"<object>","custom_attributes":[{"attribute_code":"consequat est culpa","value":"officia occaecat deserunt"},{"attribute_code":"pariatur velit sint","value":"ut ad irure sit"}]}],"disable_auto_group_change":"<integer>","extension_attributes":{"assistance_allowed":"<integer>","is_subscribed":"<boolean>","amazon_id":"<string>","vertex_customer_code":"<string>","vertex_customer_country":"<string>"},"custom_attributes":[{"attribute_code":"eiusmod Ut","value":"laborum Ut aliquip"},{"attribute_code":"nulla dolor","value":"sunt"}]},"password":"<string>","redirectUrl":"<string>"}
Responses
200

OK

application/json
Responseobject
post
/V1/customers
PreviousSearchNextConfirm