Create Customer

Registers a customer for the store using their email. If the customer already exists and is linked to the store, a 409 conflict is returned. Requires the stores.customers.create permission.

POST /stores/{storeId}/customers

Create customer

cURL

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emailAddress": "[e-mail]"
}
'

200

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "dateCreated": "2023-11-07T05:31:56Z",
    "emailAddress": "<string>",
    "ipAddress": "<string>",
    "storeData": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "balance": 123,
        "externalIntegrations": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "accountId": "<string>",
            "platformId": "<string>",
            "expirationDate": "2023-11-07T05:31:56Z"
          }
        ],
        "tickets": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "subject": "<string>",
            "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "userId": "<string>",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "entries": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "name": "<string>",
                "message": "<string>",
                "ticketId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
              }
            ]
          }
        ],
        "subscriptions": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "customerStoreDataId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "price": 123,
            "currencyCode": "<string>",
            "currentPeriodStart": "2023-11-07T05:31:56Z",
            "currentPeriodEnd": "2023-11-07T05:31:56Z",
            "cancelAtPeriodEnd": true,
            "pauseCount": 123,
            "gateway": "<string>",
            "autoRenew": true,
            "failedPaymentCount": 123,
            "customIntervalDays": 123,
            "canceledAt": "2023-11-07T05:31:56Z",
            "pausedAt": "2023-11-07T05:31:56Z",
            "pauseResumeDate": "2023-11-07T05:31:56Z",
            "gatewaySubscriptionId": "<string>",
            "gatewayCustomerId": "<string>",
            "lastPaymentFailureDate": "2023-11-07T05:31:56Z",
            "nextRetryDate": "2023-11-07T05:31:56Z",
            "lastReminderSentAt": "2023-11-07T05:31:56Z",
            "metadataJson": "<string>"
          }
        ],
        "gatewayCustomerIds": {},
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customer": "<unknown>",
        "isBlocked": true,
        "ipAddress": "<string>",
        "affiliate": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isEnabled": true,
          "link": "<string>",
          "balance": 123,
          "returnPercentage": 123,
          "percentageOff": 123
        },
        "stripeCustomerId": "<string>",
        "mollieCustomerId": "<string>",
        "marketingOptions": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "isEnabled": true,
          "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "customerStoreDataId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "disabledAt": "2023-11-07T05:31:56Z",
          "consentSource": "<string>",
          "consentTimestamp": "2023-11-07T05:31:56Z",
          "consentIpAddress": "<string>",
          "consentWithdrawnAt": "2023-11-07T05:31:56Z"
        },
        "blockedNote": "<string>",
        "blockedAt": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

Authorization · string · header · required

Your API key goes here

Path Parameters

storeId · string<uuid> · required

ID of the store.

Body

application/jsontext/jsonapplication/*+json

Customer email payload.

Represents a form for creating customer data, inheriting email validation functionality.

emailAddress · string<email> · required

Represents the email address associated with the form.

Required string length: 1 - 256

Response

200

text/plain

The object was successfully created.

Represents a default generic response for API endpoints.

success · boolean · required

Indicates whether the operation or response was successful.

message · string | null

A descriptive message providing additional context or information about the response.

code · string | null

The error code (if there was an error) to use when referencing the error

data · object

Represents a customer registered at Komerza globally

Show child attributes