API reference
Create a merchant
How to create a merchant via API
To create a new merchant, send a POST request to the /api/merchants endpoint, passing the resource arguments in the request body.

Request

POST https://yourdomain.commercelayer.io/api/merchants

Arguments

Body Parameter
Type
Required
type
string
Required
attributes.name
string
Required
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.address
object
Required

Example

Request
Response
The following request creates a new merchant:
1
curl -g -X POST \
2
'https://yourdomain.commercelayer.io/api/merchants' \
3
-H 'Accept: application/vnd.api+json' \
4
-H 'Authorization: Bearer your-access-token' \
5
-H 'Content-Type: application/vnd.api+json' \
6
-d '{
7
"data": {
8
"type": "merchants",
9
"attributes": {
10
"name": "The Brand Inc."
11
},
12
"relationships": {
13
"address": {
14
"data": {
15
"type": "addresses",
16
"id": "QWERtyUpBa"
17
}
18
}
19
}
20
}
21
}'
Copied!
On success, the API responds with a 201 Created status code, returning the created resource object:
1
{
2
"data": {
3
"id": "xYZkjABcde",
4
"type": "merchants",
5
"links": {
6
"self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde"
7
},
8
"attributes": {
9
"name": "The Brand Inc.",
10
"created_at": "2018-01-01T12:00:00.000Z",
11
"updated_at": "2018-01-01T12:00:00.000Z",
12
"reference": "ANY-EXTERNAL-REFEFERNCE",
13
"reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
14
"metadata": {
15
"foo": "bar"
16
}
17
},
18
"relationships": {
19
"address": {
20
"links": {
21
"self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/address",
22
"related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/address"
23
}
24
},
25
"attachments": {
26
"links": {
27
"self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/attachments",
28
"related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/attachments"
29
}
30
}
31
},
32
"meta": {
33
"mode": "test"
34
}
35
}
36
}
Copied!
Copy link