Comment on page

Update a merchant

How to update an existing merchant via API

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.
Here below the list of all the possible arguments that you can pass with the request body.
Request
PATCH https://yourdomain.commercelayer.io/api/merchants/:id
Arguments
Body Parameter
Type
Required
type
string
Required
id
string
Required
attributes.name
string
Optional
attributes.reference
string
Optional
attributes.reference_origin
string
Optional
attributes.metadata
object
Optional
relationships.address
object
Optional
Example
Request
Response
The following request updates the merchant identified by the ID "xYZkjABcde":
curl -g -X PATCH \
  'https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token' \
  -H 'Content-Type: application/vnd.api+json' \
  -d '{
  "data": {
    "type": "merchants",
    "id": "xYZkjABcde",
    "attributes": {
      "reference": "ANY-EXTERNAL-REFEFERNCE"
    },
    "relationships": {
      "address": {
        "data": {
          "type": "addresses",
          "id": "ABCRtyUpBa"
        }
      }
    }
  }
}'
On success, the API responds with a 200 OK status code, returning the updated resource object:
{
  "data": {
    "id": "xYZkjABcde",
    "type": "merchants",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde"
    },
    "attributes": {
      "name": "The Brand Inc.",
      "created_at": "2018-01-01T12:00:00.000Z",
      "updated_at": "2018-01-01T12:00:00.000Z",
      "reference": "ANY-EXTERNAL-REFEFERNCE",
      "reference_origin": "ANY-EXTERNAL-REFEFERNCE-ORIGIN",
      "metadata": {
        "foo": "bar"
      }
    },
    "relationships": {
      "address": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/address",
          "related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/address"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/attachments"
        }
      },
      "versions": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/relationships/versions",
          "related": "https://yourdomain.commercelayer.io/api/merchants/xYZkjABcde/versions"
        }
      }
    },
    "meta": {
      "mode": "test"
    }
  }
}

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

Retrieve a merchant

Delete a merchant

Last modified 3mo ago