Customers

customer Customer Repository V1Get By Id Get

Get customer by Customer ID.

get

/V1/customers/{customerId}

Path parameters

customerIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'http://{{baseurl}}/V1/customers/{customerId}'

200

400

401

500

{
  "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": "dolore dolor Lorem",
          "value": "Excepteur eiusmod"
        },
        {
          "attribute_code": "commodo",
          "value": "ullam"
        }
      ]
    },
    {
      "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": "incididunt",
          "value": "Ut"
        },
        {
          "attribute_code": "magna vol",
          "value": "adipisicing cupidatat sint officia"
        }
      ]
    }
  ],
  "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": "eu nisi ",
      "value": "consequat sed id sit nostrud"
    },
    {
      "attribute_code": "officia in fugiat",
      "value": "ess"
    }
  ]
}

customer Customer Repository V1Save Put

Create or update a customer.

put

/V1/customers/{customerId}

Path parameters

customerIdstringrequired

(Required)

Example: <string>

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'http://{{baseurl}}/V1/customers/{customerId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "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>"
  }'

200

400

401

500

{
  "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": "dolore dolor Lorem",
          "value": "Excepteur eiusmod"
        },
        {
          "attribute_code": "commodo",
          "value": "ullam"
        }
      ]
    },
    {
      "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": "incididunt",
          "value": "Ut"
        },
        {
          "attribute_code": "magna vol",
          "value": "adipisicing cupidatat sint officia"
        }
      ]
    }
  ],
  "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": "eu nisi ",
      "value": "consequat sed id sit nostrud"
    },
    {
      "attribute_code": "officia in fugiat",
      "value": "ess"
    }
  ]
}

customer Customer Repository V1Delete By Id Delete

Delete customer by Customer ID.

delete

/V1/customers/{customerId}

Path parameters

customerIdstringrequired

(Required)

Example: <integer>

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'http://{{baseurl}}/V1/customers/{customerId}'

200

400

401

500

true

customer Account Management V1Create Account Post

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

post

/V1/customers

Header parameters

Content-Typestring

Example: application/json

Body

object

Example:

{"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

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'http://{{baseurl}}/V1/customers' \
  --header 'Content-Type: application/json' \
  --data '{
    "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>"
  }'

200

500

{
  "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": "dolore dolor Lorem",
          "value": "Excepteur eiusmod"
        },
        {
          "attribute_code": "commodo",
          "value": "ullam"
        }
      ]
    },
    {
      "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": "incididunt",
          "value": "Ut"
        },
        {
          "attribute_code": "magna vol",
          "value": "adipisicing cupidatat sint officia"
        }
      ]
    }
  ],
  "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": "eu nisi ",
      "value": "consequat sed id sit nostrud"
    },
    {
      "attribute_code": "officia in fugiat",
      "value": "ess"
    }
  ]
}

PreviousSearch NextConfirm