POST
/
merchants
curl --request POST \
  --url https://api.sulu.sh/v0/merchants \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "jsmith@example.com",
  "description": "<string>",
  "metadata": {},
  "vatNumber": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "billingAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "phone": "<string>",
  "organizationId": "<string>"
}'
{
  "id": "<string>",
  "object": "merchant",
  "name": "<string>",
  "email": "jsmith@example.com",
  "description": "<string>",
  "metadata": {},
  "vatNumber": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "billingAddress": {
    "line1": "<string>",
    "line2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "country": "<string>",
    "zipCode": "<string>"
  },
  "phone": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The name of the merchant organization.

​
email
string
required

The email address of the merchant organization.

​
description
string

A description of the merchant organization. This might be displayed to consumers.

​
metadata
object
​
vatNumber
string

The VAT number of the merchant organization. Will be used as the default VAT number for tax calculations.

​
address
object

The address of the merchant organization.

​
billingAddress
object

The billing address of the merchant organization. This is used for billing purposes.

​
phone
string

The phone number of the merchant organization.

​
organizationId
string

Optional organization ID. This should be used if a consumer organization already exists and you want to associate the merchant with it.

Response

201
application/json
Merchant organization created successfully
​
id
string

Unique identifier for the merchant organization.

​
object
enum<string>
default:merchant

The type of object, which is 'merchant' for this schema.

Available options:
merchant
​
name
string

The name of the merchant organization.

​
email
string

The email address of the merchant organization.

​
description
string

A brief description of the merchant organization.

​
metadata
object

Key-value pairs for storing additional data related to the merchant.

​
vatNumber
string

The VAT number of the merchant organization, used by default for tax calculations.

​
address
object

The address of the merchant organization.

​
billingAddress
object

The billing address of the merchant organization, used for billing purposes.

​
phone
string

The contact phone number of the merchant organization.

​
createdAt
string

The date and time when the merchant organization was created.

​
updatedAt
string

The date and time when the merchant organization was last updated.