Retrieve a discount engine

How to fetch a specific discount engine via API

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

Request

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

Example

The following request fetches the discount engine identified by the ID "XAyRWNUzyN":

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

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

{
  "data": {
    "id": "XAyRWNUzyN",
    "type": "discount_engines",
    "links": {
      "self": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN"
    },
    "attributes": {
      "name": "Personal discount engine",
      "type": "talon_one_accounts",
      "manage_gift_cards": false,
      "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": {
      "markets": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/relationships/markets",
          "related": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/markets"
        }
      },
      "discount_engine_items": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/relationships/discount_engine_items",
          "related": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/discount_engine_items"
        }
      },
      "attachments": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/relationships/attachments",
          "related": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/attachments"
        }
      },
      "event_stores": {
        "links": {
          "self": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/relationships/event_stores",
          "related": "https://yourdomain.commercelayer.io/api/discount_engines/XAyRWNUzyN/event_stores"
        }
      }
    },
    "meta": {
      "mode": "test",
      "organization_id": "xRRkjDFafe",
      "trace_id": "69abaa3545913c78132e5578bd26208d44aa9043647d78698fd0021f3958cd74"
    }
  }
}

Last updated 7 days ago

Good afternoon

hashtagRequest

hashtagExample

Request

Example