Data structure

The DealTrack API has been designed to be JSON:API compliant. The data structure and request format follow the patterns described in the specification.

Request Format

Requests to the API follow a standardised structure.

Versioning

As the DealTrack API changes overtime, Enable will utilise versioning to ensure that client applications which rely on the API are not impacted by breaking changes to the API or its structure. If a breaking change is introduced, it will be available in a different version of the API.

To achieve this, different versions of the API will be accessible by modifying the version identifier (v1, v2, etc.) which can be found at the start of DealTrack API endpoint URLs. For example: api.deal-track.com/v1/deals

Endpoints

Following the version will be the endpoint's name itself. Currently, Enable supports the following top level endpoints:

• v1/trading-partners
• v1/schemes
• v1/deals
• v1/items
• v1/earnings
• v1/turnover
• v1/activity

Filtering by Identifier

To select just a single entity from an endpoint you can add /{entity-id} to the end of the request url. For example: api.deal-track.com/v1/deals/3 will return a single deal with the Id of “3” if one exists.

Filtering by Entity Values

It is possible to query the API for entities with specific values. The structure of a filter request is: {entity-name}?filter[{attribute-name}]={target-value}. For example you can filter deals by start date: api.deal-track.com/v1/deals?filter[startDate]=2017-01-01T00:00:00Z

Multiple types of filtering are supported:

Accessing Related Entities

In the DealTrack API it is possible to retrieve entity data which is related to a top level Entity. The structure of this request is: {entity-name}/{entity-id}/{related-entity-name}. For example you can get all of the schemes which belong to a trading partner by making a request to: api.deal-track.com/v1/trading-partners/1/schemes.

DealTrack API supports multiple relationships like this:

Response Format

Structure of Entity Response

An endpoint will return up to 10 entities from DealTrack in the following structure:

{
    data: [
        {
            attributes: {
                property1: "value",
                property2: "value"
            },
            relationships: {
                related-entity: {
                    links: {
                        self: "https://api.deal-track.com/v1/entity-type/1/relationships/related-entity-type",
                        related: "https://api.deal-track.com/v1/entity-type/1/related-entity-type"
                    }
                }
            },
            type: "entity-type",
            id: 1
        },
        {
            attributes: {
                property1: "value",
                property2: "value"
            },
            relationships: {
                related-entity: {
                    links: {
                        self: "https://api.deal-track.com/v1/entity-type/2/relationships/related-entity-type",
                        related: "https://api.deal-track.com/v1/entity-type/2/related-entity-type"
                    }
                }
            },
            type: "entity-type",
            id: 2
        }
    ],
    meta: {
        total-records: 2
    }
}

In the structure above, the entity-type would be the name of the entity e.g. “deals”. The values of that entity are found within the attributes section. Links to related entities are stored within the relationship sections.