Merchants

A merchant is the fiscal representative that is selling in a specific market. Tax calculators use the merchant's address (and the shipping address) to determine the tax rate for an order.

The merchant object

A merchant object is returned as part of the response body of each successful create, list, retrieve or update API call. The following table contains the list of all its fields along with their type, description and example values.
Object fields:
name
string
The merchant's internal name
Example:
The Brand Inc.
id
integer
Unique identifier for the resource.
Example:
1234
created_at
datetime
Time at which the resource was created.
Example:
2018-01-01T12:00:00.000Z
updated_at
datetime
Time at which the resource was last updated.
Example:
2018-01-01T12:00:00.000Z
reference
string
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
{"foo":"bar"}
relationship (N:1)
The associated address.

Create a merchant

To create a new merchant, send a POST request to the /api/merchants endpoint, passing the resource arguments in the request body. The following table contains the list of all the possible arguments, along with their type, description and examples values. All the arguments marked as required must be present in the request.
Arguments:
name
required
The merchant's internal name
Example:
The Brand Inc.
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
#
required
The associated address.
Example request:
POST /api/merchants HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "merchants",
    "attributes": {
      "name": "The Brand Inc."
    },
    "relationships": {
      "address": {
        "data": {
          "type": "addresses",
          "id": "1234"
        }
      }
    }
  }
}
Example response: 201 Created
HTTP/1.1 201 Created
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "merchants",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/merchants/1234"
    },
    "attributes": {
      "name": "The Brand Inc.",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "address": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/merchants/1234/relationships/address",
          "related": "https://your-brand.commercelayer.io/api/merchants/1234/address"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

List all merchants

To fetch a collection of merchants, send a GET request to the /api/merchants endpoint.

Example request:
GET /api/merchants HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": [
    {
      "id": "1234",
      "type": "merchants",
      "links": {
        "self": "https://your-brand.commercelayer.io/api/merchants/1234"
      },
      "attributes": {
        "name": "The Brand Inc.",
        "id": "1234",
        "created_at": "2018-01-01T12:00:00.000Z",
        "updated_at": "2018-01-01T12:00:00.000Z",
        "reference": "ANYREFEFERNCE",
        "metadata": {
          "foo": "bar"
        }
      },
      "relationships": {
        "address": {
          "links": {
            "self": "https://your-brand.commercelayer.io/api/merchants/1234/relationships/address",
            "related": "https://your-brand.commercelayer.io/api/merchants/1234/address"
          }
        }
      },
      "meta": {
        "mode": "test"
      }
    },
    {
      "other": "... 24 merchants (first page)"
    }
  ],
  "meta": {
    "record_count": 125,
    "page_count": 5
  },
  "links": {
    "first": "/api/merchants?page[number]=1&page[size]=25",
    "prev": "/api/merchants?page[number]=2&page[size]=25",
    "next": "/api/merchants?page[number]=4&page[size]=25",
    "last": "/api/merchants?page[number]=5&page[size]=25"
  }
}
Available filters
idreferenceidscreated_at_fromcreated_at_toupdated_at_fromupdated_at_to
Sortable attributes
idcreated_atupdated_atreference

Retrieve a merchant

To fetch a single merchant, send a GET request to the /api/merchants/{{id}} endpoint, where {{id}} is the id of the resource that you want to retrieve.
Example request:
GET /api/merchants/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "merchants",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/merchants/1234"
    },
    "attributes": {
      "name": "The Brand Inc.",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "address": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/merchants/1234/relationships/address",
          "related": "https://your-brand.commercelayer.io/api/merchants/1234/address"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Update a merchant

To update an existing merchant, send a PATCH request to the /api/merchants/{{id}} endpoint, where {{id}} is the id of the resource that you want to update. The following table contains the list of all the possible arguments that you can pass with the request body, along with their type, description and examples values. Please note that all arguments are optional.
Arguments:
name
optional
The merchant's internal name
Example:
The Brand Inc.
reference
optional
A string that you can use to add your own identifier to the resource. This can be useful for intergrating the resource to an external system, like an ERP, a marketing tool or a CRM.
Example:
ANYREFEFERNCE
metadata
optional
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
Example:
#
optional
The associated address.
Example request:
PATCH /api/merchants/1234 HTTP/1.1
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "merchants",
    "id": 1234,
    "attributes": {
      "name": "The Brand Inc."
    },
    "relationships": {
    }
  }
}
Example response: 200 OK
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1234",
    "type": "merchants",
    "links": {
      "self": "https://your-brand.commercelayer.io/api/merchants/1234"
    },
    "attributes": {
      "name": "The Brand Inc.",
      "id": "1234",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANYREFEFERNCE",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "address": {
        "links": {
          "self": "https://your-brand.commercelayer.io/api/merchants/1234/relationships/address",
          "related": "https://your-brand.commercelayer.io/api/merchants/1234/address"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

Delete a merchant

To delete a merchant, send a DELETE request to the /api/merchants/{{id}} endpoint, where {{id}} is the id of the resource that you want to delete.
Example request:
DELETE /api/merchants/1234 HTTP/1.1
Accept: application/vnd.api+json
Example response: 204 No Content
HTTP/1.1 204 No Content

Get our machine-readable JSON schema that follows the OpenAPI Specification (formerly Swagger).

Get our Postman collection in one click and start making real calls to Commerce Layer API in minutes.

Get in touch with our support team if you have any questions or want to learn more about Commerce Layer.