Create Customer

Create customer

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

{
  "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>",
            "status": 0,
            "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",
            "expirationDate": "2023-11-07T05:31:56Z",
            "startDate": "2023-11-07T05:31:56Z",
            "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customer": "<unknown>",
        "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>"
      }
    ]
  }
}

POST

stores

{storeId}

customers

Create customer

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

{
  "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>",
            "status": 0,
            "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",
            "expirationDate": "2023-11-07T05:31:56Z",
            "startDate": "2023-11-07T05:31:56Z",
            "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ],
        "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "customer": "<unknown>",
        "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>"
      }
    ]
  }
}

Authorizations

Authorization

string

header

required

Your API key goes here

Path Parameters

storeId

string<uuid>

required

ID of the store.

Body

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

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

data.id

string<uuid>

required

The unique identifier of the entity

data.dateCreated

string<date-time>

required

The date the entity was created in the database

data.emailAddress

string

required

Represents the email address of the customer

Required string length: 3 - 256

data.ipAddress

string

required

Represents the IP address associated with the customer.

Maximum string length: 45

data.storeData

object[]

required

The list of store-scoped data for the customer

Show child attributes

data.storeData.id

string<uuid>

required

The unique identifier of the entity

data.storeData.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeData.balance

number<double>

required

The customer balance, this can be used to buy items on the store with

data.storeData.externalIntegrations

object[]

required

The list of external integrations linked to this customer

Show child attributes

data.storeData.externalIntegrations.id

string<uuid>

required

The unique identifier of the entity

data.storeData.externalIntegrations.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeData.externalIntegrations.accountId

string

required

The users account identifier, used to identify the account on the platform

Maximum string length: 256

data.storeData.externalIntegrations.platformId

string

required

The ID of the platform which the integration is for

Maximum string length: 64

data.storeData.externalIntegrations.expirationDate

string<date-time> | null

The date the access token expires

data.storeData.tickets

object[]

required

The list of tickets created by the customer

Show child attributes

data.storeData.tickets.id

string<uuid>

required

The unique identifier of the entity

data.storeData.tickets.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeData.tickets.subject

string

required

Gets or sets the subject or title of the ticket, summarizing the issue or request.

Required string length: 1 - 128

data.storeData.tickets.status

enum<integer>

required

The different states of the ticket

Available options:

0,

1,

2,

3,

4

data.storeData.tickets.customerId

string<uuid>

required

The customer who opened the ticket

data.storeData.tickets.userId

string

required

The user who owns the store the ticket was made in

Required string length: 1 - 36

data.storeData.tickets.storeId

string<uuid>

required

The store which the ticket is for

data.storeData.tickets.entries

object[]

required

Gets or sets the list of entries or messages associated with the ticket. These entries represent the conversation or updates related to the ticket.

Show child attributes

data.storeData.tickets.entries.id

string<uuid>

required

The unique identifier of the entity

data.storeData.tickets.entries.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeData.tickets.entries.name

string

required

The name of the user that posted the entry

Required string length: 1 - 50

data.storeData.tickets.entries.message

string

required

The message the user has posted to the ticket

Required string length: 1 - 2048

data.storeData.tickets.entries.ticketId

string<uuid>

required

The ID of the ticket

data.storeData.subscriptions

object[]

required

The list of subscriptions the customer has

Show child attributes

data.storeData.subscriptions.id

string<uuid>

required

The unique identifier of the entity

data.storeData.subscriptions.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeData.subscriptions.expirationDate

string<date-time>

required

The date the subscription ends

data.storeData.subscriptions.startDate

string<date-time>

required

The date the subscription starts

data.storeData.subscriptions.customerId

string<uuid>

required

The ID of the customer the subscription belongs to

data.storeData.subscriptions.storeId

string<uuid>

required

The ID of the store the subscription belongs to

data.storeData.subscriptions.productId

string<uuid>

required

The ID of the product the subscription is for

data.storeData.storeId

string<uuid>

required

The ID the customer data is associated with

data.storeData.customerId

string<uuid>

required

The ID of the customer the data belongs to

data.storeData.customer

any

required

data.storeData.ipAddress

string

required

Represents the IP address the customer created the store data with.

Maximum string length: 45

data.storeData.affiliate

object

Represents an affiliate associated with a store.

Show child attributes

data.storeData.affiliate.id

string<uuid>

required

The unique identifier of the entity

data.storeData.affiliate.dateCreated

string<date-time>

required

The date the entity was created in the database

data.storeData.affiliate.storeId

string<uuid>

required

Unique identifier for the store associated with the affiliate

data.storeData.affiliate.customerId

string<uuid>

required

Unique identifier for the customer associated with the affiliate

data.storeData.affiliate.isEnabled

boolean

required

Indicates whether the store is affiliated with a user

data.storeData.affiliate.link

string

required

A link provided to affiliates for tracking and promotional purposes.

Required string length: 1 - 256

data.storeData.affiliate.balance

number<double>

required

Represents the balance of the affiliate, typically indicating the amount earned through affiliations.

data.storeData.affiliate.returnPercentage

integer<int32> | null

The percentage of the return that an affiliate receives

data.storeData.affiliate.percentageOff

integer<int32> | null

The percentage discount offered by the store affiliate

data.storeData.stripeCustomerId

string | null

The ID of the Stripe customer for the customer

Maximum string length: 64

Search Customers

Update Customer Balance

⌘I

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Authorizations

Path Parameters

Body

Response