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
The following request creates a new merchant:
curl -g -X POST \
'https://yourdomain.commercelayer.io/api/merchants' \
-H 'Accept: application/vnd.api+json' \
-H 'Authorization: Bearer your-access-token' \
-H 'Content-Type: application/vnd.api+json' \
-d '{
"data": {
"type": "merchants",
"attributes": {
"name": "The Brand Inc."
},
"relationships": {
"address": {
"data": {
"type": "addresses",
"id": "ABCRtyUpBa"
}
}
}
}
}'
Last updated