ReDoc documentation

customers/{customerId}

customers/{customerId}

get/V1/customers/{customerId}

Get customer by Customer ID.

Request
path Parameters
customerId
required
integer
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Response samples
{
  • "id": 0,
  • "group_id": 0,
  • "default_billing": "string",
  • "default_shipping": "string",
  • "confirmation": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "created_in": "string",
  • "dob": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "middlename": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "gender": 0,
  • "store_id": 0,
  • "taxvat": "string",
  • "website_id": 0,
  • "addresses": [
    ],
  • "disable_auto_group_change": 0,
  • "extension_attributes": {
    },
  • "custom_attributes": [
    ]
}

customers/{customerId}

put/V1/customers/{customerId}

Create or update a customer.

Request
path Parameters
customerId
required
string
Request Body schema:
required
object (customer-data-customer-interface)

Customer entity interface for API handling.

passwordHash
string
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Request samples
{
  • "customer": {
    },
  • "passwordHash": "string"
}
Response samples
{
  • "id": 0,
  • "group_id": 0,
  • "default_billing": "string",
  • "default_shipping": "string",
  • "confirmation": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "created_in": "string",
  • "dob": "string",
  • "email": "string",
  • "firstname": "string",
  • "lastname": "string",
  • "middlename": "string",
  • "prefix": "string",
  • "suffix": "string",
  • "gender": 0,
  • "store_id": 0,
  • "taxvat": "string",
  • "website_id": 0,
  • "addresses": [
    ],
  • "disable_auto_group_change": 0,
  • "extension_attributes": {
    },
  • "custom_attributes": [
    ]
}

customers/{customerId}

delete/V1/customers/{customerId}

Delete customer by Customer ID.

Request
path Parameters
customerId
required
integer
Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Response samples
true
➔ Next to customers/{customerId}/billingAddress