Add Account

POST

commerce

customer

accounts

Error

A valid request URL is required to generate request examples

{
  "acceptsMarketing": true,
  "accountType": "<string>",
  "attributes": [
    {
      "attributeDefinitionId": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "fullyQualifiedName": "<string>",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "commerceSummary": {
    "lastOrderDate": "2023-11-07T05:31:56Z",
    "orderCount": 123,
    "totalOrderAmount": {
      "amount": 123,
      "currencyCode": "<string>"
    },
    "visitsCount": 123,
    "wishlistCount": 123
  },
  "companyOrOrganization": "<string>",
  "contacts": [
    {
      "accountId": 123,
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "addressType": "<string>",
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "faxNumber": "<string>",
      "firstName": "<string>",
      "id": 123,
      "label": "<string>",
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "types": [
        {
          "isPrimary": true,
          "name": "<string>"
        }
      ]
    }
  ],
  "customerSet": "<string>",
  "customerSinceDate": "2023-11-07T05:31:56Z",
  "emailAddress": "<string>",
  "externalId": "<string>",
  "firstName": "<string>",
  "hasExternalPassword": true,
  "id": 123,
  "isActive": true,
  "isAnonymous": true,
  "isLocked": true,
  "last2FaDate": "2023-11-07T05:31:56Z",
  "lastName": "<string>",
  "localeCode": "<string>",
  "migrationRequired": true,
  "notes": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "content": "<string>",
      "id": 123
    }
  ],
  "segments": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "code": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>"
    }
  ],
  "taxExempt": true,
  "taxId": "<string>",
  "userId": "<string>",
  "userName": "<string>"
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme.

Query Parameters

responseFields

string

limits which fields are returned in the response body

Body

application/json

Properties of the new customer account to create.

Customer account. Customers provide contact information, view order history, and set email preferences on their account. Merchants can edit accounts to add internal notes or assign them to segments.

acceptsMarketing

boolean

If true, the customer prefers to receive marketing material such as newsletters or email offers.

accountType

string | null

Type of account.

attributes

object[] | null

List of attributes for the account.

Show child attributes

auditInfo

object

Show child attributes

commerceSummary

object

Commerce (orders and wishlists) on a customer account which lists all the orders the customer has made with the order date, order amount, and status. Includes cancellations and returns. Also includes wishlist information.

Show child attributes

companyOrOrganization

string | null

The company or organization name for an account.

contacts

object[] | null

List of contacts for this account. A customer account can have multiple contacts for billing and shipping addresses.

Show child attributes

customerSet

string | null

customerSinceDate

string<date-time> | null

Date when the customer account is created.

emailAddress

string | null

"Email addresss of the customer.

externalId

string | null

firstName

string | null

First name of the customer.

hasExternalPassword

boolean

Indicates if an external password is set on this account

integer<int32>

Unique identifier of the account, also known as a customer number.

isActive

boolean

Is the account active?

isAnonymous

boolean

Is the account Anonymous?

isLocked

boolean

Is the account locked?

last2FaDate

string<date-time> | null

lastName

string | null

Last name of the customer.

localeCode

string | null

Locale Code.

migrationRequired

boolean

Indicates Subscription migration is required or not.

notes

object[] | null

List of notes for the account. Merchants use these internal notes, for example, to make a note of a customer's interests or complaints. Notes are available only from the merchant's view, customers cannot view these notes.

Show child attributes

segments

object[] | null

List of segments assigned to account. Merchants create segments, for example, to manage discounts or assign VIP status. Then they assign the account to the segment. An account can belong to several segments or none at all.

Show child attributes

taxExempt

boolean

taxId

string | null

userId

string | null

Unique identifier of the user who is currently logged in. This is null if the user is anonymous (not logged in). Unicode data with a maximum length of 55 characters.

userName

string | null

User name for the customer account.

Response

Customer account. Customers provide contact information, view order history, and set email preferences on their account. Merchants can edit accounts to add internal notes or assign them to segments.

acceptsMarketing

boolean

If true, the customer prefers to receive marketing material such as newsletters or email offers.

accountType

string | null

Type of account.

attributes

object[] | null

List of attributes for the account.

Show child attributes

auditInfo

object

Show child attributes

commerceSummary

object

Show child attributes

companyOrOrganization

string | null

The company or organization name for an account.

contacts

object[] | null

List of contacts for this account. A customer account can have multiple contacts for billing and shipping addresses.

Show child attributes

customerSet

string | null

customerSinceDate

string<date-time> | null

Date when the customer account is created.

emailAddress

string | null

"Email addresss of the customer.

externalId

string | null

firstName

string | null

First name of the customer.

hasExternalPassword

boolean

Indicates if an external password is set on this account

integer<int32>

Unique identifier of the account, also known as a customer number.

isActive

boolean

Is the account active?

isAnonymous

boolean

Is the account Anonymous?

isLocked

boolean

Is the account locked?

last2FaDate

string<date-time> | null

lastName

string | null

Last name of the customer.

localeCode

string | null

Locale Code.

migrationRequired

boolean

Indicates Subscription migration is required or not.

notes

object[] | null

Show child attributes

segments

object[] | null

Show child attributes

taxExempt

boolean

taxId

string | null

userId

string | null

Unique identifier of the user who is currently logged in. This is null if the user is anonymous (not logged in). Unicode data with a maximum length of 55 characters.

userName

string | null

User name for the customer account.

Error

A valid request URL is required to generate request examples

{
  "acceptsMarketing": true,
  "accountType": "<string>",
  "attributes": [
    {
      "attributeDefinitionId": 123,
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "fullyQualifiedName": "<string>",
      "values": [
        "<unknown>"
      ]
    }
  ],
  "auditInfo": {
    "createBy": "<string>",
    "createDate": "2023-11-07T05:31:56Z",
    "updateBy": "<string>",
    "updateDate": "2023-11-07T05:31:56Z"
  },
  "commerceSummary": {
    "lastOrderDate": "2023-11-07T05:31:56Z",
    "orderCount": 123,
    "totalOrderAmount": {
      "amount": 123,
      "currencyCode": "<string>"
    },
    "visitsCount": 123,
    "wishlistCount": 123
  },
  "companyOrOrganization": "<string>",
  "contacts": [
    {
      "accountId": 123,
      "address": {
        "address1": "<string>",
        "address2": "<string>",
        "address3": "<string>",
        "address4": "<string>",
        "addressType": "<string>",
        "cityOrTown": "<string>",
        "countryCode": "<string>",
        "isValidated": true,
        "postalOrZipCode": "<string>",
        "stateOrProvince": "<string>"
      },
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "companyOrOrganization": "<string>",
      "email": "<string>",
      "faxNumber": "<string>",
      "firstName": "<string>",
      "id": 123,
      "label": "<string>",
      "lastNameOrSurname": "<string>",
      "middleNameOrInitial": "<string>",
      "phoneNumbers": {
        "home": "<string>",
        "mobile": "<string>",
        "work": "<string>"
      },
      "types": [
        {
          "isPrimary": true,
          "name": "<string>"
        }
      ]
    }
  ],
  "customerSet": "<string>",
  "customerSinceDate": "2023-11-07T05:31:56Z",
  "emailAddress": "<string>",
  "externalId": "<string>",
  "firstName": "<string>",
  "hasExternalPassword": true,
  "id": 123,
  "isActive": true,
  "isAnonymous": true,
  "isLocked": true,
  "last2FaDate": "2023-11-07T05:31:56Z",
  "lastName": "<string>",
  "localeCode": "<string>",
  "migrationRequired": true,
  "notes": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "content": "<string>",
      "id": 123
    }
  ],
  "segments": [
    {
      "auditInfo": {
        "createBy": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "updateBy": "<string>",
        "updateDate": "2023-11-07T05:31:56Z"
      },
      "code": "<string>",
      "description": "<string>",
      "id": 123,
      "name": "<string>"
    }
  ],
  "taxExempt": true,
  "taxId": "<string>",
  "userId": "<string>",
  "userName": "<string>"
}

Developers

API reference

AI Tools

Authorizations

Query Parameters

Body

Response