Skip to main content
The Unified API covers most standard use cases.
When it doesn’t, Chift provides two advanced escape hatches:
  • Raw data: access the native API responses used to build unified objects
  • Custom endpoints: call connector-specific endpoints directly
These features allow you to go beyond the unified model while still benefiting from Chift’s authentication, routing, and connector maintenance.

​
Raw data

​
What it is

The Raw Data feature exposes the native API calls and responses used internally by Chift to build unified data. You still receive the unified response, with an additional raw_data field containing everything fetched behind the scenes.

​
When to use it

  • You need fields not exposed in the unified model
  • You want to understand or debug how unified data is built
  • You want to enrich unified objects with connector-specific fields

​
How to use it

Add the following header to your request: 
X-Chift-Raw-Data: true
E.g. GET /pos/customers:
It will return next to the unified data (as always), a raw_data field with the endpoints called and the result. 
{
  "items": [
    {
      "id": "168390",
      "first_name": "Henry",
      "last_name": "Michel",
      "name": "Henry Michel",
      "phone": null,
      "email": null,
      "created_on": "2016-01-13T10:05:10+01:00",
      "addresses": [],
      "loyalty": 0,
      "birthdate": null
    },
    ...
  ],
  "page": 1,
  "total": 1005,
  "raw_data": {
    "customers?offset=9000&limit=1000": {
      "customers": [
        {
          "id": 24909902
          ...
        }
      ]
    }
  }
}
When using the API Explorer in your Chift Platform, you have a checkbox to activate the “raw data” feature to test it out.

​
Custom endpoints

​
What it is

Custom endpoints let you call connector-specific API routes that are not exposed through the Unified API. Chift handles authentication and connection management.
You directly interact with the connector’s native endpoint and response format.

​
When to use it

Use custom endpoints when:
  • The Unified API does not expose a required feature
  • The connector provides useful routes (e.g. promotions, reports, exports)
  • You need immediate access without waiting for unification
If the endpoint can be unified, prefer the Unified API.

​
How it works

E.g. For a POS connector, you want to call a route to give you the list of promotions of restaurants. This can be done as such:
GET /consumers/consumerid/pos/custom/name_of_endpoints_with_params
You need to add custom after the name of the unified api and the endpoint you are requesting. E.G. GET /consumers/consumerid/pos/custom/promotions Chift manages authentication and forwards the request to the connector’s native API. All query parameters and request options are passed as-is.
This is not yet implemented on all connectors. Please contact the support or your CSM if needed