DocsDocsReference

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
API
Management
Updated
Apr 26, 2026

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

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

API ownership

  • API family: Management API
  • Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
  • Do not use from: Browser-only storefront code or public clients.
  • Guide route: /apis/management/latest

The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.

Operation

  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/merchant-users
  • Summary: Create merchant user
  • Description: Creates a new merchant user with the provided details including personal information, address, and communication preferences
  • OpenAPI contract: management-api
  • Operation ID: Not documented in the OpenAPI contract.

Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID.

Parameters2 parameters
NameInRequiredTypeDescription
app_slugpathYesstringApp slug
team_slugpathYesstringTeam slug
Request bodyDocumented body
  • Required: Yes
  • Description: Merchant user details
  • Content: application/json (object)

Create Merchant User Payload

PropertyTypeRequiredDetails
additionsobjectNo-
addressobjectNo-
commentstringNo-
communication_preferencesobjectNo-
customer_group_idsstring[]NouniqueItems
emailstringYes-
email_verifiedbooleanNo-
is_super_adminbooleanNo-
languagestringYesminLength: 1
marketstringYesminLength: 1
namestringYesminLength: 1
phone_numberstringNo-
statusenum("active", "inactive", "pending")Yes-
store_groupstringYesminLength: 1
surnamestringYesminLength: 1

Address

PropertyTypeRequiredDetails
citystringNo-
countrystringNo-
country_codestringNo-
streetstringNo-
zip_codestringNo-

Communication Preferences

PropertyTypeRequiredDetails
allow_emailbooleanNo-
allow_postalbooleanNo-
allow_smsbooleanNo-

Generated example (synthetic):

{
  "additions": {},
  "address": {
    "city": "string",
    "country": "string",
    "country_code": "string",
    "street": "string",
    "zip_code": "string"
  },
  "comment": "string",
  "communication_preferences": {
    "allow_email": false,
    "allow_postal": false,
    "allow_sms": false
  },
  "customer_group_ids": [
    "string"
  ],
  "email": "string",
  "email_verified": false,
  "is_super_admin": false,
  "language": "string",
  "market": "string",
  "name": "string",
  "phone_number": "string",
  "status": "active",
  "store_group": "string",
  "surname": "string"
}
Responses5 statuses
StatusDescriptionContent
201Created merchant userapplication/json (object)
400Invalid request (e.g. bad payload, validation error, user already exists)application/json (object)
401Unauthorized accessapplication/json (object)
404Store group not foundapplication/json (object)
500Internal server errorapplication/json (object)

201 - object

Merchant User Response

PropertyTypeRequiredDetails
dataobjectNo-
detailsstring[]NoAdditional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes
successbooleanNo-
Merchant User
PropertyTypeRequiredDetails
additionsobjectNo-
addressobjectNo-
address_restrictionsobject[]No-
app_idstringNo-
attributesobject[]No-
commentstringNo-
communication_preferencesobjectNo-
created_atstringNo-
customer_groupsobject[]No-
emailstringNo-
email_verification_sent_atstringNo-
email_verifiedbooleanNo-
idstringNo-
is_super_adminbooleanNo-
languagestringNo-
marketstringNo-
namestringNo-
organisationsobject[]No-
phone_numberstringNo-
statusstringNo-
store_groupstringNo-
surnamestringNo-
tagsobject[]No-
updated_atstringNo-
Address
PropertyTypeRequiredDetails
citystringNo-
countrystringNo-
country_codestringNo-
streetstringNo-
zip_codestringNo-
Organisation Address Restriction
PropertyTypeRequiredDetails
address_idstringNo-
formatted_addressstringNo-
organisation_idstringNo-
organisation_namestringNo-
organisation_numberstringNo-
Attribute
PropertyTypeRequiredDetails
created_atstringNo-
descriptionstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
namestringNo-
template_keystringNo-
template_namestringNo-
translatablebooleanNo-
translationsobjectNo-
updated_atstringNo-
valuesobjectNo-
Communication Preferences
PropertyTypeRequiredDetails
allow_emailbooleanNo-
allow_postalbooleanNo-
allow_smsbooleanNo-
Customer Group Ref
PropertyTypeRequiredDetails
idstringNo-
namestringNo-
slugstringNo-
Merchant Organization Details
PropertyTypeRequiredDetails
custom_role_idstringNo-
custom_role_namestringNo-
custom_role_slugstringNo-
idstringNo-
levelstringNo-
namestringNo-
organisation_numberstringNo-
Tag
PropertyTypeRequiredDetails
attributesobject[]No-
created_atstringNo-
filterablebooleanNo-
idstringNo-
keystringNo-
marketsobject[]No-
namestringNo-
schedulesobject[]No-
source_app_idstringNo-
source_idstringNo-
statusstringNo-
translationsobjectNo-
updated_atstringNo-
{
  "data": {
    "additions": {},
    "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": false,
        "id": "string",
        "key": "string",
        "name": "string",
        "template_key": "string",
        "template_name": "string",
        "translatable": false,
        "translations": {
          "description": null,
          "name": null
        },
        "updated_at": "string",
        "values": {}
      }
    ],
    "comment": "string",
    "communication_preferences": {
      "allow_email": false,
      "allow_postal": false,
      "allow_sms": false
    },
    "created_at": "string",
    "customer_groups": [
      {
        "id": "string",
        "name": "string",
        "slug": "string"
      }
    ],
    "email": "string",
    "email_verification_sent_at": "string",
    "email_verified": false,
    "id": "string",
    "is_super_admin": false,
    "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",
        "filterable": false,
        "id": "string",
        "key": "string",
        "markets": [],
        "name": "string",
        "schedules": [],
        "source_app_id": "string",
        "source_id": "string",
        "status": "string",
        "translations": {
          "name": null
        },
        "updated_at": "string"
      }
    ],
    "updated_at": "string"
  },
  "details": [
    "string"
  ],
  "success": false
}

400 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

401 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

404 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

500 - object

Error Message

PropertyTypeRequiredDetails
detailsstring[]No-
messagestringNo-
successbooleanNo-

Generated example (synthetic):

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

Contract identity

Use these fields to confirm you are implementing the intended endpoint contract.

  • API family: Management API
  • Method: POST
  • Path: /api/v1/\{team_slug\}/\{app_slug\}/merchant-users
  • Operation ID: Not documented in the OpenAPI contract.
  • OpenAPI tag: Merchant Users
  • OpenAPI summary: Create merchant user

Create merchant user

# 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
Purpose

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

Required inputs

app_slug path team_slug path

Primary response

201 ยท Created merchant user

Operation key

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

## API ownership - API family: Management API - Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data. - Do not use from: Browser-only storefront code or public clients. - Guide route: [/apis/management/latest](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## Operation - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/merchant-users` - Summary: Create merchant user - Description: Creates a new merchant user with the provided details including personal information, address, and communication preferences - OpenAPI contract: management-api - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/merchant-users` Operation key uses API family, method, and path because this OpenAPI contract does not publish an operation ID. ## Parameters | Name | In | Required | Type | Description | | --- | --- | --- | --- | --- | | app_slug | path | Yes | string | App slug | | team_slug | path | Yes | string | Team slug | ## Request body - Required: Yes - Description: Merchant user details - Content: application/json (object) ### Create Merchant User Payload | Property | Type | Required | Details | | --- | --- | --- | --- | | `additions` | object | No | - | | `address` | object | No | - | | `comment` | string | No | - | | `communication_preferences` | object | No | - | | `customer_group_ids` | string[] | No | uniqueItems | | `email` | string | Yes | - | | `email_verified` | boolean | No | - | | `is_super_admin` | boolean | No | - | | `language` | string | Yes | minLength: 1 | | `market` | string | Yes | minLength: 1 | | `name` | string | Yes | minLength: 1 | | `phone_number` | string | No | - | | `status` | enum("active", "inactive", "pending") | Yes | - | | `store_group` | string | Yes | minLength: 1 | | `surname` | string | Yes | minLength: 1 | #### Address | Property | Type | Required | Details | | --- | --- | --- | --- | | `city` | string | No | - | | `country` | string | No | - | | `country_code` | string | No | - | | `street` | string | No | - | | `zip_code` | string | No | - | #### Communication Preferences | Property | Type | Required | Details | | --- | --- | --- | --- | | `allow_email` | boolean | No | - | | `allow_postal` | boolean | No | - | | `allow_sms` | boolean | No | - | **Generated example (synthetic):** ```json { "additions": {}, "address": { "city": "string", "country": "string", "country_code": "string", "street": "string", "zip_code": "string" }, "comment": "string", "communication_preferences": { "allow_email": false, "allow_postal": false, "allow_sms": false }, "customer_group_ids": [ "string" ], "email": "string", "email_verified": false, "is_super_admin": false, "language": "string", "market": "string", "name": "string", "phone_number": "string", "status": "active", "store_group": "string", "surname": "string" } ``` ## Responses | Status | Description | Content | | --- | --- | --- | | 201 | Created merchant user | application/json (object) | | 400 | Invalid request (e.g. bad payload, validation error, user already exists) | application/json (object) | | 401 | Unauthorized access | application/json (object) | | 404 | Store group not found | application/json (object) | | 500 | Internal server error | application/json (object) | ### 201 - object #### Merchant User Response | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object | No | - | | `details` | string[] | No | Additional contextual information about the response. Used to provide supplementary details beyond the main data payload, such as validation warnings or processing notes | | `success` | boolean | No | - | ##### Merchant User | Property | Type | Required | Details | | --- | --- | --- | --- | | `additions` | object | No | - | | `address` | object | No | - | | `address_restrictions` | object[] | No | - | | `app_id` | string | No | - | | `attributes` | object[] | No | - | | `comment` | string | No | - | | `communication_preferences` | object | No | - | | `created_at` | string | No | - | | `customer_groups` | object[] | No | - | | `email` | string | No | - | | `email_verification_sent_at` | string | No | - | | `email_verified` | boolean | No | - | | `id` | string | No | - | | `is_super_admin` | boolean | No | - | | `language` | string | No | - | | `market` | string | No | - | | `name` | string | No | - | | `organisations` | object[] | No | - | | `phone_number` | string | No | - | | `status` | string | No | - | | `store_group` | string | No | - | | `surname` | string | No | - | | `tags` | object[] | No | - | | `updated_at` | string | No | - | ##### Address | Property | Type | Required | Details | | --- | --- | --- | --- | | `city` | string | No | - | | `country` | string | No | - | | `country_code` | string | No | - | | `street` | string | No | - | | `zip_code` | string | No | - | ##### Organisation Address Restriction | Property | Type | Required | Details | | --- | --- | --- | --- | | `address_id` | string | No | - | | `formatted_address` | string | No | - | | `organisation_id` | string | No | - | | `organisation_name` | string | No | - | | `organisation_number` | string | No | - | ##### Attribute | Property | Type | Required | Details | | --- | --- | --- | --- | | `created_at` | string | No | - | | `description` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `name` | string | No | - | | `template_key` | string | No | - | | `template_name` | string | No | - | | `translatable` | boolean | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - | | `values` | object | No | - | ##### Communication Preferences | Property | Type | Required | Details | | --- | --- | --- | --- | | `allow_email` | boolean | No | - | | `allow_postal` | boolean | No | - | | `allow_sms` | boolean | No | - | ##### Customer Group Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `name` | string | No | - | | `slug` | string | No | - | ##### Merchant Organization Details | Property | Type | Required | Details | | --- | --- | --- | --- | | `custom_role_id` | string | No | - | | `custom_role_name` | string | No | - | | `custom_role_slug` | string | No | - | | `id` | string | No | - | | `level` | string | No | - | | `name` | string | No | - | | `organisation_number` | string | No | - | ##### Tag | Property | Type | Required | Details | | --- | --- | --- | --- | | `attributes` | object[] | No | - | | `created_at` | string | No | - | | `filterable` | boolean | No | - | | `id` | string | No | - | | `key` | string | No | - | | `markets` | object[] | No | - | | `name` | string | No | - | | `schedules` | object[] | No | - | | `source_app_id` | string | No | - | | `source_id` | string | No | - | | `status` | string | No | - | | `translations` | object | No | - | | `updated_at` | string | No | - |
Generated example (synthetic) ```json { "data": { "additions": {}, "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": false, "id": "string", "key": "string", "name": "string", "template_key": "string", "template_name": "string", "translatable": false, "translations": { "description": null, "name": null }, "updated_at": "string", "values": {} } ], "comment": "string", "communication_preferences": { "allow_email": false, "allow_postal": false, "allow_sms": false }, "created_at": "string", "customer_groups": [ { "id": "string", "name": "string", "slug": "string" } ], "email": "string", "email_verification_sent_at": "string", "email_verified": false, "id": "string", "is_super_admin": false, "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", "filterable": false, "id": "string", "key": "string", "markets": [], "name": "string", "schedules": [], "source_app_id": "string", "source_id": "string", "status": "string", "translations": { "name": null }, "updated_at": "string" } ], "updated_at": "string" }, "details": [ "string" ], "success": false } ```
### 400 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 401 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 404 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ### 500 - object #### Error Message | Property | Type | Required | Details | | --- | --- | --- | --- | | `details` | string[] | No | - | | `message` | string | No | - | | `success` | boolean | No | - | **Generated example (synthetic):** ```json { "details": [ "string" ], "message": "string", "success": false } ``` ## Contract identity Use these fields to confirm you are implementing the intended endpoint contract. - API family: Management API - Method: `POST` - Path: `/api/v1/{team_slug}/{app_slug}/merchant-users` - Operation ID: Not documented in the OpenAPI contract. - Stable operation key: `management-api:POST:/api/v1/{team_slug}/{app_slug}/merchant-users` - OpenAPI tag: Merchant Users - OpenAPI summary: Create merchant user