Retrieve a version

How to fetch a specific version via API

To fetch a single version, send a GET request to the /api/versions/:id endpoint, where id is the ID of the resource that you want to retrieve.

Request

GET https://yourdomain.commercelayer.io/api/versions/:id

Example

Request

The following request fetches the version identified by the id "xYZkjABcde":

curl -g -X GET \
  'https://yourdomain.commercelayer.io/api/versions/xYZkjABcde' \
  -H 'Accept: application/vnd.api+json' \
  -H 'Authorization: Bearer your-access-token'

Response

On success, the API responds with a 200 OK status code, returning a single resource object:

{
  "data": {
    "id": "xYZkjABcde",
    "type": "versions",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/versions/xYZkjABcde"
    },
    "attributes": {
      "resource_type": "orders",
      "resource_id": "PzdJhdLdYV",
      "event": "update",
      "changes": {
        "status": [
          "draft",
          "placed"
        ]
      },
      "who": {
        "application": {
          "id": "DNOPYiZYpn",
          "kind": "sales_channel",
          "public": true
        },
        "owner": {
          "id": "yQQrBhLBmQ",
          "type": "Customer"
        }
      },
      "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": {
    },
    "meta": {
      "mode": "test"
    }
  }
}