Create merchant user

Creates a new merchant user with the provided details including personal information, address, and communication preferences

POST/api/v1/{team_slug}/{app_slug}/merchant-users

Authorization

AuthorizationBearer token · headerrequired

Management API token, sent as Authorization: Bearer <token>.

Path parameters

app_slugstringrequired

App slug

team_slugstringrequired

Team slug

Request body

requiredapplication/json

Merchant user details

additionsobject

addressgithub_com_enadhq_nabbit_internal_pkg_clients_koopakey.Address

Show properties

citystring

countrystring

country_codestring

streetstring

zip_codestring

commentstring

communication_preferencesgithub_com_enadhq_nabbit_internal_pkg_clients_koopakey.CommunicationPreferences

Show properties

allow_emailboolean

allow_postalboolean

allow_smsboolean

customer_group_idsstring[]

emailstringrequired

email_verifiedboolean

is_super_adminboolean

languagestringrequired

min length 1

marketstringrequired

min length 1

namestringrequired

min length 1

phone_numberstring

statusstringrequired

Allowed:activeinactivepending

store_groupstringrequired

min length 1

surnamestringrequired

min length 1

third_party_sign_upboolean

Responses

201

Created merchant user

datagithub_com_enadhq_nabbit_internal_pkg_webserver_models.MerchantUserrequired

Show properties

additionsobject | null

addressgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Address

Show properties

citystring

countrystring

country_codestring

streetstring

zip_codestring

address_restrictionsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.OrganisationAddressRestriction[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.OrganisationAddressRestriction

address_idstring

formatted_addressstring

organisation_idstring

organisation_namestring

organisation_numberstring | null

app_idstring

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute

created_atstring

descriptionstring | null

filterableboolean | null

idstring

keystring

namestring | null

template_keystring

template_namestring

translatableboolean | null

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.AttributeTranslations

Show properties

descriptiongithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Translation

idstring

localestring

valuestring

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

updated_atstring | null

valuesobject | null

commentstring

communication_preferencesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CommunicationPreferences

Show properties

allow_emailboolean

allow_postalboolean

allow_smsboolean

created_atstring

customer_groupsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.CustomerGroupRef[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.CustomerGroupRef

idstring

namestring

slugstring

emailstring

email_verification_sent_atstring | null

email_verifiedboolean

idstring

is_super_adminboolean

languagestring | null

marketstring

namestring | null

organisationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.MerchantOrganizationDetails[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.MerchantOrganizationDetails

custom_role_idstring

custom_role_namestring

custom_role_slugstring

idstring

levelstring

namestring

organisation_numberstring | null

phone_numberstring

statusstring

store_groupstring

surnamestring | null

tagsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Tag[]

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Tag

attributesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Attribute[] | null

created_atstring

filterableboolean

idstring

keystring

marketsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Market[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Market

activeboolean

country_codesstring[] | null

created_atstring

currency_codestring

idstring

localestring

namestring

slugstring

updated_atstring | null

namestring

schedulesgithub_com_enadhq_nabbit_internal_pkg_webserver_models.Job[] | null

Show properties

Array of github_com_enadhq_nabbit_internal_pkg_webserver_models.Job

add_category_namesstring[]

add_collection_namesstring[]

add_tag_namesstring[]

execute_atstring

Date when the job should run

finished_atstring | null

If a job is finished will this timestamp be filled

group_idstring

idstring

item_idstring

item_namestring

item_typestring

remove_category_namesstring[]

remove_collection_namesstring[]

remove_tag_namesstring[]

to_amount_cents_with_taxinteger | null

to_market_idstring

to_market_statusstring

to_on_saleboolean | null

to_sale_amount_cents_with_taxinteger | null

to_start_sale_timestampstring

to_statusstring | null

to_stop_sale_timestampstring

to_store_group_idstring

statusstring

translationsgithub_com_enadhq_nabbit_internal_pkg_webserver_models.TagTranslations

Show properties

namegithub_com_enadhq_nabbit_internal_pkg_webserver_models.Translation[]

updated_atstring | null

third_party_sign_upboolean

updated_atstring

detailsstring[]

Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes

successbooleanrequired

400

Invalid request (e.g. bad payload, validation error, user already exists)

detailsstring[]

messagestring

successbooleanrequired

401

Unauthorized access

detailsstring[]

messagestring

successbooleanrequired

404

Store group not found

detailsstring[]

messagestring

successbooleanrequired

500

Internal server error

detailsstring[]

messagestring

successbooleanrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

app_slugpath*App slugteam_slugpath*Team slug

Bodyapplication/json

Request body

Request

curl -X POST 'https://api.enad.io/api/v1/string/string/merchant-users' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "additions": {
    "property1": "string",
    "property2": "string"
  },
  "address": {
    "city": "string",
    "country": "string",
    "country_code": "string",
    "street": "string",
    "zip_code": "string"
  },
  "comment": "string",
  "communication_preferences": {
    "allow_email": true,
    "allow_postal": true,
    "allow_sms": true
  },
  "customer_group_ids": [
    "string"
  ],
  "email": "string",
  "email_verified": true,
  "is_super_admin": true,
  "language": "string",
  "market": "string",
  "name": "string",
  "phone_number": "string",
  "status": "active",
  "store_group": "string",
  "surname": "string",
  "third_party_sign_up": true
}'

const response = await fetch("https://api.enad.io/api/v1/string/string/merchant-users", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"additions\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  },\n  \"address\": {\n    \"city\": \"string\",\n    \"country\": \"string\",\n    \"country_code\": \"string\",\n    \"street\": \"string\",\n    \"zip_code\": \"string\"\n  },\n  \"comment\": \"string\",\n  \"communication_preferences\": {\n    \"allow_email\": true,\n    \"allow_postal\": true,\n    \"allow_sms\": true\n  },\n  \"customer_group_ids\": [\n    \"string\"\n  ],\n  \"email\": \"string\",\n  \"email_verified\": true,\n  \"is_super_admin\": true,\n  \"language\": \"string\",\n  \"market\": \"string\",\n  \"name\": \"string\",\n  \"phone_number\": \"string\",\n  \"status\": \"active\",\n  \"store_group\": \"string\",\n  \"surname\": \"string\",\n  \"third_party_sign_up\": true\n}"
});

import requests

response = requests.post(
    "https://api.enad.io/api/v1/string/string/merchant-users",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"additions\": {\n    \"property1\": \"string\",\n    \"property2\": \"string\"\n  },\n  \"address\": {\n    \"city\": \"string\",\n    \"country\": \"string\",\n    \"country_code\": \"string\",\n    \"street\": \"string\",\n    \"zip_code\": \"string\"\n  },\n  \"comment\": \"string\",\n  \"communication_preferences\": {\n    \"allow_email\": true,\n    \"allow_postal\": true,\n    \"allow_sms\": true\n  },\n  \"customer_group_ids\": [\n    \"string\"\n  ],\n  \"email\": \"string\",\n  \"email_verified\": true,\n  \"is_super_admin\": true,\n  \"language\": \"string\",\n  \"market\": \"string\",\n  \"name\": \"string\",\n  \"phone_number\": \"string\",\n  \"status\": \"active\",\n  \"store_group\": \"string\",\n  \"surname\": \"string\",\n  \"third_party_sign_up\": true\n}",
)

Response

{
  "data": {
    "additions": {
      "property1": "string",
      "property2": "string"
    },
    "address": {
      "city": "string",
      "country": "string",
      "country_code": "string",
      "street": "string",
      "zip_code": "string"
    },
    "address_restrictions": [
      {
        "address_id": "string",
        "formatted_address": "string",
        "organisation_id": "string",
        "organisation_name": "string",
        "organisation_number": "string"
      }
    ],
    "app_id": "string",
    "attributes": [
      {
        "created_at": "string",
        "description": "string",
        "filterable": true,
        "id": "string",
        "key": "string",
        "name": "string",
        "template_key": "string",
        "template_name": "string",
        "translatable": true,
        "translations": {
          "description": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ],
          "name": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        },
        "updated_at": "string",
        "values": {
          "property1": {
            "field_id": "string",
            "id": "string",
            "image_id": "string",
            "image_object": {
              "alt": "string",
              "app_id": "string",
              "blurhash": "string",
              "copyright": "string",
              "custom": {
                "property1": "string",
                "property2": "string"
              },
              "folder_id": "string",
              "id": "string",
              "parent_id": "string",
              "public": true,
              "status": "string",
              "title": "string",
              "url": "string"
            },
            "translations": {
              "value": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "type": "string",
            "value": "string"
          },
          "property2": {
            "field_id": "string",
            "id": "string",
            "image_id": "string",
            "image_object": {
              "alt": "string",
              "app_id": "string",
              "blurhash": "string",
              "copyright": "string",
              "custom": {
                "property1": "string",
                "property2": "string"
              },
              "folder_id": "string",
              "id": "string",
              "parent_id": "string",
              "public": true,
              "status": "string",
              "title": "string",
              "url": "string"
            },
            "translations": {
              "value": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "type": "string",
            "value": "string"
          }
        }
      }
    ],
    "comment": "string",
    "communication_preferences": {
      "allow_email": true,
      "allow_postal": true,
      "allow_sms": true
    },
    "created_at": "string",
    "customer_groups": [
      {
        "id": "string",
        "name": "string",
        "slug": "string"
      }
    ],
    "email": "string",
    "email_verification_sent_at": "string",
    "email_verified": true,
    "id": "string",
    "is_super_admin": true,
    "language": "string",
    "market": "string",
    "name": "string",
    "organisations": [
      {
        "custom_role_id": "string",
        "custom_role_name": "string",
        "custom_role_slug": "string",
        "id": "string",
        "level": "string",
        "name": "string",
        "organisation_number": "string"
      }
    ],
    "phone_number": "string",
    "status": "string",
    "store_group": "string",
    "surname": "string",
    "tags": [
      {
        "attributes": [
          {
            "created_at": "string",
            "description": "string",
            "filterable": true,
            "id": "string",
            "key": "string",
            "name": "string",
            "template_key": "string",
            "template_name": "string",
            "translatable": true,
            "translations": {
              "description": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ],
              "name": [
                {
                  "id": "string",
                  "locale": "string",
                  "value": "string"
                }
              ]
            },
            "updated_at": "string",
            "values": {
              "property1": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              },
              "property2": {
                "field_id": "string",
                "id": "string",
                "image_id": "string",
                "image_object": {
                  "alt": "string",
                  "app_id": "string",
                  "blurhash": "string",
                  "copyright": "string",
                  "custom": {
                    "property1": "string",
                    "property2": "string"
                  },
                  "folder_id": "string",
                  "id": "string",
                  "parent_id": "string",
                  "public": true,
                  "status": "string",
                  "title": "string",
                  "url": "string"
                },
                "translations": {
                  "value": [
                    {
                      "id": "string",
                      "locale": "string",
                      "value": "string"
                    }
                  ]
                },
                "type": "string",
                "value": "string"
              }
            }
          }
        ],
        "created_at": "string",
        "filterable": true,
        "id": "string",
        "key": "string",
        "markets": [
          {
            "active": true,
            "country_codes": [
              "string"
            ],
            "created_at": "string",
            "currency_code": "string",
            "id": "string",
            "locale": "string",
            "name": "string",
            "slug": "string",
            "updated_at": "string"
          }
        ],
        "name": "string",
        "schedules": [
          {
            "add_category_names": [
              "string"
            ],
            "add_collection_names": [
              "string"
            ],
            "add_tag_names": [
              "string"
            ],
            "execute_at": "string",
            "finished_at": "string",
            "group_id": "string",
            "id": "string",
            "item_id": "string",
            "item_name": "string",
            "item_type": "string",
            "remove_category_names": [
              "string"
            ],
            "remove_collection_names": [
              "string"
            ],
            "remove_tag_names": [
              "string"
            ],
            "to_amount_cents_with_tax": 0,
            "to_market_id": "string",
            "to_market_status": "string",
            "to_on_sale": true,
            "to_sale_amount_cents_with_tax": 0,
            "to_start_sale_timestamp": "string",
            "to_status": "string",
            "to_stop_sale_timestamp": "string",
            "to_store_group_id": "string"
          }
        ],
        "status": "string",
        "translations": {
          "name": [
            {
              "id": "string",
              "locale": "string",
              "value": "string"
            }
          ]
        },
        "updated_at": "string"
      }
    ],
    "third_party_sign_up": true,
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}

{
  "details": [
    "string"
  ],
  "message": "string",
  "success": true
}