Synccentric
API Reference · v1.1.0

Synccentric module for Ibotta

Send identifiers to the storage queue, monitor capacity, and retrieve completed Amazon export files. The module supports up to 500,000 processed identifiers per day.

Base URL  https://ibotta.synccentric.net/api/v1.1

Authentication

Include your API token with every request. Use a real token in production; the values in these examples are placeholders.

Authorization header
Authorization: Bearer your-api-token
Endpoints

Manage the integration queue

Identifiers are removed automatically after they are searched and exported. Export endpoints expose the most recent files ready for collection.

GET/status

Storage queue status

Return the storage capacity and the number of identifiers that can still be imported.

Response object 200
idstringAlways success.
codeintegerHTTP status code.
details.remainingintegerIdentifiers still available in the queue.
details.limitintegerTotal queue capacity.
Request example
curl -X GET 'https://ibotta.synccentric.net/api/v1.1/status' \
  -H 'Authorization: Bearer your-api-token'
Response object · 200
{
  "id": "success",
  "code": 200,
  "details": {
    "remaining": 1000000,
    "limit": 3000000
  }
}
POST/import

Add identifiers to the storage queue

Imported UPCs and ASINs are queued for Amazon listing searches. Import up to 1,000 identifiers in a single request; the queue can hold up to 3,000,000 identifiers.

Request body
identifiersarrayrequired

Identifier records. UPCs must be 12 digits and ASINs must be 10 characters.

Response object 200
details.insertedintegerTotal identifiers imported successfully.
details.errorsobjectInvalid identifiers and validation details, when present.
Request example
curl -X POST 'https://ibotta.synccentric.net/api/v1.1/import' \
  -H 'Authorization: Bearer your-api-token' \
  -H 'Content-Type: application/json' \
  --data '{
    "identifiers": [
      { "identifier": "B002000479", "type": "asin" },
      { "identifier": "268960062", "type": "asin" }
    ]
  }'
Response object · 200
{
  "id": "success",
  "code": 200,
  "details": {
    "inserted": 2,
    "errors": {}
  }
}
POST/delete

Delete imported identifiers

Delete specified UPC or ASIN identifiers from storage. Identifiers that are searched and exported are removed automatically.

Important: omitting the identifiers parameter deletes all identifiers from the module database.
Request body
identifiersarrayrequired

Up to 10 ASIN or UPC identifier records to delete.

Request example
curl -X POST 'https://ibotta.synccentric.net/api/v1.1/delete' \
  -H 'Authorization: Bearer your-api-token' \
  -H 'Content-Type: application/json' \
  --data '{
    "identifiers": [
      { "identifier": "B002004992", "type": "asin" }
    ]
  }'
Response object · 200
{
  "id": "success",
  "code": 200
}
GET/export/list

List export files

Returns the latest ten export file names that are ready for download. Pass a file name to the export endpoint to collect its data.

Response object 200
detailsarrayThe latest export file names available for download.
Request example
curl -X GET 'https://ibotta.synccentric.net/api/v1.1/export/list' \
  -H 'Authorization: Bearer your-api-token'
Response object · 200
{
  "id": "success",
  "code": 200,
  "details": [
    "01_2021_05_23_export.csv",
    "02_2021_05_23_export.csv"
  ]
}
POST/export

Download export file

Returns the export file selected by its file name. Files generally contain around 100,000–400,000 results, depending on secondary or duplicate listings.

Request body
filestringrequired

The export file name returned by GET /export/list.

Request example
curl -X POST 'https://ibotta.synccentric.net/api/v1.1/export' \
  -H 'Authorization: Bearer your-api-token' \
  -H 'Content-Type: application/json' \
  --data '{
    "file": "01_2021_05_23_export.csv"
  }'
Response object · 200
{
  "id": "success",
  "code": 200
}

Errors

All endpoints can return the following standard API errors.

401unauthorizedNo valid token was provided.
422parameter_errorOne or more request parameters failed validation.
Example error · 422
{
  "id": "parameter_error",
  "code": 422,
  "details": ["Validation error"]
}