Skip to content
NimlesNimlesNimles Docs

Create a customer

POST
/api/tenant/{tenantId}/Customers
curl --request POST \
  --url https://api.nimles.com/e-commerce/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "token": "example", "references": { "additionalProperty": "example" }, "customerPaymentMethodReference": "example", "description": "example", "buyer": { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "customerType": "example", "identityNumber": "example", "organizationName": "example", "firstName": "example", "lastName": "example", "email": "example", "phoneNumber": "example", "deliveryAddress": { "coAddress": "example", "state": "example", "country": "example", "name": "example", "firstName": "example", "lastName": "example", "street": "example", "postalCode": "example", "city": "example" }, "billingAddress": { "coAddress": "example", "state": "example", "country": "example", "name": "example", "firstName": "example", "lastName": "example", "street": "example", "postalCode": "example", "city": "example" }, "useDeliveryAddress": true }, "seller": { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantId
required
string format: uuid

Your tenant id.

Request Body

Section titled “Request Body”
Media typeapplication/json
object
resourceGroupId
required

The resource group the item is created in. Required: access is checked there.

string format: uuid
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
token
string
nullable
references
object
key
additional properties
string
customerPaymentMethodReference
string
nullable
description
string
nullable
buyer
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
organizationId
string format: uuid
nullable
userId
string format: uuid
nullable
siteId
string format: uuid
nullable
customerType
string
nullable
identityNumber
string
nullable
organizationName
string
nullable
firstName
string
nullable
lastName
string
nullable
email
string
nullable
phoneNumber
string
nullable
deliveryAddress
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
billingAddress
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
useDeliveryAddress
boolean
seller
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
organizationId
string format: uuid
nullable
userId
string format: uuid
nullable
siteId
string format: uuid
nullable

Example generated

{
  "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "fields": {
    "additionalProperty": {
      "value": "example",
      "valueType": "example"
    }
  },
  "accessibility": "example",
  "token": "example",
  "references": {
    "additionalProperty": "example"
  },
  "customerPaymentMethodReference": "example",
  "description": "example",
  "buyer": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "customerType": "example",
    "identityNumber": "example",
    "organizationName": "example",
    "firstName": "example",
    "lastName": "example",
    "email": "example",
    "phoneNumber": "example",
    "deliveryAddress": {
      "coAddress": "example",
      "state": "example",
      "country": "example",
      "name": "example",
      "firstName": "example",
      "lastName": "example",
      "street": "example",
      "postalCode": "example",
      "city": "example"
    },
    "billingAddress": {
      "coAddress": "example",
      "state": "example",
      "country": "example",
      "name": "example",
      "firstName": "example",
      "lastName": "example",
      "street": "example",
      "postalCode": "example",
      "city": "example"
    },
    "useDeliveryAddress": true
  },
  "seller": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  }
}

Responses

Section titled “Responses”

201

Section titled “201”

Created. The body is the item, or { data: { id } } when it cannot be read yet. Location is the item’s path within the service, /api/tenant/{tenantId}/{Resource}/{id}, without the /{service} prefix api.nimles.com routes by: use data.id from the body.

Media typeapplication/json
One of:
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
relations
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
name
string
nullable
entityId
required
string format: uuid
entityType
required
string
>= 1 characters
relationType
required
string
>= 1 characters
tenantId
string format: uuid
nullable
resourceGroupId
string format: uuid
nullable
creatorId
string format: uuid
nullable
createdDate
string format: date-time
nullable
version
integer format: int32
nullable
lastModified
string format: date-time
nullable
userId
string format: uuid
nullable
references
object
key
additional properties
string
buyer
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
organizationId
string format: uuid
nullable
userId
string format: uuid
nullable
siteId
string format: uuid
nullable
customerType
string
nullable
identityNumber
string
nullable
organizationName
string
nullable
firstName
string
nullable
lastName
string
nullable
email
string
nullable
phoneNumber
string
nullable
deliveryAddress
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
billingAddress
object
coAddress
string
nullable
state
string
nullable
country
string
nullable
name
string
nullable
firstName
string
nullable
lastName
string
nullable
street
string
nullable
postalCode
string
nullable
city
string
nullable
useDeliveryAddress
boolean
seller
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
organizationId
string format: uuid
nullable
userId
string format: uuid
nullable
siteId
string format: uuid
nullable
description
string
nullable
paymentMethods
Array<object>
nullable
object
fields
object
key
additional properties
object
value
required
nullable
valueType
string
nullable
accessibility
string
nullable
id
string format: uuid
reference
string
nullable
name
string
nullable
description
string
nullable
cardNumber
string
nullable
expMonth
integer format: int64
nullable
expYear
integer format: int64
nullable
clientReference
string
nullable
cardHolder
string
nullable
holder
string
nullable
cardType
string
nullable
customerReference
string
nullable
clientReference
string
nullable
paymentClientReference
string
nullable

Example generated

{
  "data": {
    "fields": {
      "additionalProperty": {
        "value": "example",
        "valueType": "example"
      }
    },
    "accessibility": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "relations": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "name": "example",
        "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "entityType": "example",
        "relationType": "example"
      }
    ],
    "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "createdDate": "2026-04-15T12:00:00Z",
    "version": 1,
    "lastModified": "2026-04-15T12:00:00Z",
    "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "references": {
      "additionalProperty": "example"
    },
    "buyer": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "customerType": "example",
      "identityNumber": "example",
      "organizationName": "example",
      "firstName": "example",
      "lastName": "example",
      "email": "example",
      "phoneNumber": "example",
      "deliveryAddress": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "billingAddress": {
        "coAddress": "example",
        "state": "example",
        "country": "example",
        "name": "example",
        "firstName": "example",
        "lastName": "example",
        "street": "example",
        "postalCode": "example",
        "city": "example"
      },
      "useDeliveryAddress": true
    },
    "seller": {
      "fields": {
        "additionalProperty": {
          "value": "example",
          "valueType": "example"
        }
      },
      "accessibility": "example",
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "organizationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "userId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "siteId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
    },
    "description": "example",
    "paymentMethods": [
      {
        "fields": {
          "additionalProperty": {
            "value": "example",
            "valueType": "example"
          }
        },
        "accessibility": "example",
        "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
        "reference": "example",
        "name": "example",
        "description": "example",
        "cardNumber": "example",
        "expMonth": 1,
        "expYear": 1,
        "clientReference": "example",
        "cardHolder": "example",
        "holder": "example",
        "cardType": "example",
        "customerReference": "example"
      }
    ],
    "clientReference": "example",
    "paymentClientReference": "example"
  }
}

Headers

Section titled “Headers”
Location
string

The new item’s path within the service, without the service prefix: /api/tenant/{tenantId}/{Resource}/{id}.

401

Section titled “401”

Unauthorized: no bearer token, or one that is expired or not for this API.

403

Section titled “403”

Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.

Media typeapplication/json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

409

Section titled “409”

Conflict: the item kept changing under concurrent writes; read it again and retry.

Media typeapplication/problem+json

An RFC 9457 problem.

object
detail
string
nullable
instance
string
nullable
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "detail": "example",
  "instance": "example",
  "status": 1,
  "title": "example",
  "type": "example"
}

422

Section titled “422”

Unprocessable: the body or the change is invalid. The errors are keyed by member.

Media typeapplication/problem+json

A validation problem: the messages by member (or by JSON Pointer for a patch).

object
errors
object
key
additional properties
Array<string>
status
integer format: int32
nullable
title
string
nullable
type
string
nullable
key
additional properties

Example generated

{
  "errors": {
    "additionalProperty": [
      "example"
    ]
  },
  "status": 1,
  "title": "example",
  "type": "example"
}