logo
API docs by Redocly

Feedonomics: Platform (2.0)

Platform API

The Platform API helps manage databases and streamline operations across channels. Use it to handle accounts, databases, data transformations, and import/export schedules efficiently.

What You'll Learn

  • Creating and managing accounts and databases.
  • Configuring and updating imports, exports, and schedules.
  • Adding, updating, and deleting data transformers.
  • Managing channel credentials securely with vault entries.

Rate Limiting

Included headers in every authenticated response (success or failure):

  • X-Rate-Limit-Group: The name of the API group.
  • X-Rate-Limit-Remaining: The number of remaining requests in the current time window.
  • X-Rate-Limit-Reset: The timestamp when the rate limit will reset.

If the rate limit is exceeded, the API will return an HTTP 429 status code and a message with how many seconds to wait until the limit resets.

{"status":"fail","message":"Rate Limit Exceeded. Please wait -timeUntilReset- seconds before trying again."}

Accounts

Retrieves a list of dbs with status on their imports and exports

Authorizations:
bearerAuth
path Parameters
account_id
required
integer

ID of the account

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Retrieves a list of accounts for a user Deprecated

Authorizations:
bearerAuth
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Retrieves a list of accounts for a user, paginated with fuzzy search.

Authorizations:
bearerAuth
query Parameters
page
integer

Page number, begins at 1, defaults to 1 if not present

results_per_page
integer

How many accounts to return per page, defaults to 50 if not present

query
string

A search query that will filter the list of accounts returned, a weighted fuzzy search.

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "pagination": {
    }
}

Database

Retrieves a list of databases for an account Deprecated

Authorizations:
bearerAuth
path Parameters
account_id
required
integer

ID of the account that the database is added to

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Add a new database

Authorizations:
bearerAuth
path Parameters
account_id
required
integer

ID of the account that the database is added to

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The database parameters

name
required
string

The name of the database

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Retrieves a paginated list of databases for an account, with optional fuzzy search query

Authorizations:
bearerAuth
path Parameters
account_id
required
integer

ID of the account that the database is added to

query Parameters
page
integer

Page number, begins at 1, defaults to 1 if not present

results_per_page
integer

How many dbs to return per page, defaults to 50 if not present

query
string

A search query that will filter the list of dbs returned, a weighted fuzzy search.

paused
integer

Filters dbs that are paused or unpaused, defaults to all dbs ('')

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "dbs": [
    ],
  • "pagination": {
    }
}

Retrieves a single database

Authorizations:
bearerAuth
path Parameters
db_id
required
number
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "1",
  • "name": "db one",
  • "category_field_offset": null,
  • "user_id": "74",
  • "account_id": "73",
  • "import_running": "0",
  • "export_running": "0",
  • "paused": "0",
  • "visibility": "1",
  • "oauth_id": "0",
  • "email_address": "",
  • "google_account_id": "",
  • "google_account_name": "",
  • "google_analytics_oauth_id": "0",
  • "google_analytics_profile_id": "",
  • "amazon_seller_id": "",
  • "amazon_marketplace_id": "",
  • "amazon_mws_auth_token": "",
  • "bing_oauth_id": "0",
  • "bing_shopping_account_id": "",
  • "bing_shopping_campaign_id": "",
  • "polyvore_username": "",
  • "polyvore_password": "",
  • "polyvore_campaign_id": "",
  • "external_id": "",
  • "time": "2021-09-16 17:46:47",
  • "feedonomics_auth_token": "cce3ddc6fbcf2ea7d4d3931c8d8821af4dcb666d401cdce643c699d4beb76895",
  • "manual_billing_exclusion": "0",
  • "google_merchant_center_oauth_id": "",
  • "google_merchant_center_account_id": "",
  • "google_my_business_oauth_id": "",
  • "timestamp": "2021-09-16 17:48:21",
  • "billing_parent_id": "0",
  • "sears_email": "",
  • "sears_seller_id": "",
  • "sears_secret_key": "",
  • "walmart_private_key": "",
  • "walmart_consumer_id": "",
  • "kijiji_oauth_id": "0",
  • "mercado_libre_client_id": "",
  • "mercado_libre_client_secret": "",
  • "mercado_libre_oauth_id": "0",
  • "mercado_libre_country": "",
  • "google_sheets_oauth_id": "0",
  • "shopify_oauth_id": "0",
  • "facebook_oauth_id": "0",
  • "facebook_page_id": "",
  • "facebook_cms_id": "",
  • "character_set": "utf8",
  • "host": "127.0.0.1",
  • "scheduler_host": "localhost",
  • "feed_report_host": "127.0.0.1",
  • "cxn_id": "301",
  • "run_import_id": "6b75de51ce790807",
  • "data_count": "14139",
  • "google_service_account_id": "0",
  • "woocommerce_oauth_id": "0",
  • "bigcommerce_oauth_id": "0",
  • "etsy_oauth_id": "0",
  • "empty_exports_on_data_refresh_failures": "0",
  • "last_run_imports_status": "success",
  • "wish_oauth_id": "0",
  • "created_at": "2021-09-16 17:46:47",
  • "deleted_at": "0000-00-00 00:00:00",
  • "paused_at": "0000-00-00 00:00:00",
  • "features": [ ],
  • "db_group_id": 0,
  • "default_db_group_id": 0
}

Deletes database

Authorizations:
bearerAuth
path Parameters
db_id
required
number
header Parameters
x-api-key
required
string

Responses

Gets a list of extra import fields

Authorizations:
bearerAuth
path Parameters
db_id
required
number
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • "extra_01",
  • "misc_02"
]

Submits a list of extra import fields

Authorizations:
bearerAuth
path Parameters
db_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required
extra_fields
Array of strings

Responses

Request samples

Content type
application/json
{
  • "extra_fields": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

Returns a list of mapped fields in the file map

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database that the import belongs to

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Sets a database primary key

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The database parameters

primary_key
required
string

The field to set the primary key to

Responses

Request samples

Content type
application/json
{
  • "primary_key": "string"
}

Response samples

Content type
application/json
{
  • "run_import": {
    }
}

Database Groups

Retrieves a list of database groups for an account

Authorizations:
bearerAuth
path Parameters
account_id
required
integer

ID of the account that the database is added to

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Retrieves a list of CPR URLs per channel for a database group

Authorizations:
bearerAuth
path Parameters
db_group_id
required
integer

ID of the db_group

header Parameters
x-api-key
required
string

Responses

Response samples

Move Database to a group (and creates if necessary)

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database to move into the group

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The db group parameters

Array
source_db_group_id
required
integer

The current database db_group_id (or 0)

target_db_group_id
required
integer

The DB Group ID to assign (-1 if new group)

target_db_group_name
required
string

If creating a new DB group then this is the name (empty if target_db_group_id > 0)

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Transformers

Retrieves a list of transformers for a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database that the import belongs to

query Parameters
field_name
required
string

The field that the transformer belongs to

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add a new transformer to a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The database parameters

enabled
boolean

Whether the transformer is executed

field_name
string

The name of the field to transform

selector
string

The transformer selector ('if')

transformer
string

The transformer output ('then')

export_id
Array of integers

The export ID to apply the transformer to (empty if all)

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "field_name": "availability",
  • "selector": "true",
  • "transformer": "nohtml( [availability] )",
  • "export_id": [
    ]
}

Deletes the transformer

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

The database id

header Parameters
x-api-key
required
string

Responses

Update a transformer in a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database

transformer_id
required
integer

ID of the transformer

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The database parameters

enabled
boolean

Whether the transformer is executed

field_name
string

The name of the field to transform

selector
string

The transformer selector ('if')

transformer
string

The transformer output ('then')

export_id
Array of integers

The export ID to apply the transformer to (empty if all)

Responses

Request samples

Content type
application/json
{
  • "enabled": "1",
  • "field_name": "availability",
  • "selector": "true",
  • "transformer": "nohtml( [availability] )",
  • "export_id": [
    ]
}

Update a transformer's sort order in a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database

transformer_id
required
integer

ID of the transformer

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The database parameters

sort_order
integer

Target position for transformer

return_all
boolean

Flag to return all transformer ids and sort_orders (optional)

Responses

Request samples

Content type
application/json
{
  • "sort_order": 0,
  • "return_all": true
}

Imports

Get imports for DB

Authorizations:
bearerAuth
path Parameters
db_id
required
number
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create Import

Authorizations:
bearerAuth
path Parameters
db_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json

Create Import

name
required
string

The name of the import

join_type
required
string

The join type

file_name
required
string

The file name

tags
required
object

Tags associated with the import

timeout
number

The timeout duration

url
string

The URL for the import

CURLOPT_USERAGENT
string

The user agent

Responses

Request samples

Content type
application/json
Example
{
  • "name": "new url",
  • "join_type": "product_feed",
  • "file_location": "url",
  • "tags": {
    },
  • "timeout": 900,
  • "url": "https://google.com/file.txt",
  • "CURLOPT_USERAGENT": "Google"
}

Response samples

Content type
application/json
{
  • "id": "135",
  • "db_id": "132",
  • "name": "ftp",
  • "status": "0",
  • "file_location": "preprocess_script",
  • "import_info": {},
  • "file_type": "delimited",
  • "file_map": {
    },
  • "line_terminator": "",
  • "join_type": "product_feed",
  • "running": "0",
  • "cxn_id": "23935",
  • "name_based_maps": "1",
  • "xml_force_parse": "0",
  • "force_encoding": "0",
  • "ignore_lines": "1",
  • "load_threshold": "1",
  • "update_threshold": "1",
  • "max_attempts": "1",
  • "time_between_attempts": "1",
  • "limits": "",
  • "backup_failures": "0",
  • "needs_backup": "1",
  • "xmlreader": "0",
  • "clean_file_headers": "0",
  • "download_activity_timeout": "0",
  • "timeout": "900",
  • "last_download_status": "success",
  • "ftp_allow_minio_direct": "0"
}

Get Import by ID

Retrieves an import by its ID.

Authorizations:
bearerAuth
path Parameters
db_id
required
number

ID of the database that the import belongs to

import_id
required
number

ID of the import

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{}

Updates import

Authorizations:
bearerAuth
path Parameters
db_id
required
number
import_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required

Updates import

object

Responses

Request samples

Content type
application/json
Example
{
  • "name": "bigcommerce",
  • "join_type": "product_feed",
  • "file_location": "preprocess_script",
  • "tags": {
    },
  • "preprocess_info": {
    },
  • "url": "https:\\/\\/haproxy-preprocess.feedonomics.com\\/preprocess\\/run_preprocess.php?connection_info%5Bclient%5D=bigcommerce&connection_info%5Bprotocol%5D=api&connection_info%5Baccess_token%5D=5zvihq3fvya80cf42vnk5a6i66uogai&connection_info%5Bclient_id%5D=ca0eb7o90jh4s9jdsfs4hj55xn6j6yu&connection_info%5Bstore_hash%5D=3vc7ancyqo&connection_info%5Bstore_url%5D=https%3A%2F%2Ffeedonomicssandbox.mybigcommerce.com&connection_info%5Badditional_options%5D=product_reviews%2Cproduct_metafields%2Cgoogle_fields%2Ccomplex_rules%2Ccategory_tree%2Ccategory_metafields%2Cvariant_metafields&connection_info%5Badditional_image_sizes%5D=true&file_info%5Brequest_type%5D=get&"
}

Response samples

Content type
application/json
{
  • "id": "138",
  • "db_id": "136",
  • "name": "bigcommerce",
  • "cron": null,
  • "next_run_time": null,
  • "status": "0",
  • "file_location": "preprocess_script",
  • "file_type": "delimited",
  • "line_terminator": null,
  • "join_type": "product_feed",
  • "running": "0",
  • "cxn_id": "10726",
  • "name_based_maps": "1",
  • "xml_force_parse": "0",
  • "force_encoding": "0",
  • "timestamp": "2021-11-15 16:45:47",
  • "ignore_lines": "1",
  • "load_threshold": "1",
  • "update_threshold": "1",
  • "max_attempts": "1",
  • "time_between_attempts": "1",
  • "limits": "",
  • "backup_cxn_id": null,
  • "backup_failures": "0",
  • "last_download_time": "2021-09-27 18:31:51",
  • "last_backup_time": "0000-00-00 00:00:00",
  • "needs_backup": "1",
  • "xmlreader": "0",
  • "clean_file_headers": "0",
  • "download_activity_timeout": "0",
  • "timeout": "1800",
  • "last_download_status": "fail",
  • "last_download_size": "0",
  • "ftp_allow_minio_direct": "0",
  • "created_at": "2021-09-27 18:31:50"
}

Delete Import

Deletes an import by its ID.

Authorizations:
bearerAuth
path Parameters
db_id
required
number

ID of the database that the import belongs to

import_id
required
number

ID of the import

header Parameters
x-api-key
required
string

Responses

Update import schedule

Authorizations:
bearerAuth
path Parameters
db_id
required
number
import_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required

Json object containing 'day','hour','minute' with values, or 'paused' boolean, or both

day
string
hour
string
minute
string
paused
number

0 or 1. 1 sets to paused. 0 is default.

Responses

Request samples

Content type
application/json
Example
{
  • "day": "1",
  • "hour": "1,2",
  • "minute": "0"
}

Response samples

Content type
application/json
{
  • "cron": "0 1 * * 1",
  • "paused": "0"
}

Updates the import with file delimiters

Updates the delimiter settings for an import.

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database that the import belongs to

import_id
required
integer

ID of the import

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The delimiter settings

enclosure
required
string
Value: "\\\\n"

The character used to wrap each column (defaults to double quote)

encoding
required
string
Default: "utf8"
Enum: "utf8" "utf8mb4" "latin1" "utf16"

The character encoding of the file

escaper
required
string
Enum: "\\\\n" "\\\\"

The character used to escape characters (defaults to double quote)

line_terminator
required
string
Default: "\\n"
Enum: "\\\\n" "\\\\r\\\\n" "\\\\r"

The character used to define new lines

separator
required
string or null
Default: ","
Enum: "," "\\\\t" ";" "|"

The separator character between columns

Responses

Request samples

Content type
application/json
{
  • "enclosure": "\\\\n",
  • "encoding": "utf8",
  • "escaper": "\\\\n",
  • "line_terminator": "\\\\n",
  • "separator": ","
}

Updates the import's file_map after you've set the delimiters (see PUT|/dbs/{db_id}/imports/{import_id}/delimiters)

Authorizations:
bearerAuth
path Parameters
db_id
required
number
import_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required
encoding
required
string
separator
required
string
enclosure
required
string
escaper
required
string

double quote as an example

maps
required
object
ignore_join
required
object
name_based_maps
required
string
encode_source_file_keys
required
string
clean_file_headers
required
string
file_type
required
string

Responses

Request samples

Content type
application/json
{
  • "encoding": "",
  • "separator": ",",
  • "enclosure": "\\\\",
  • "escaper": "",
  • "maps": {
    },
  • "ignore_join": [ ],
  • "name_based_maps": "1",
  • "encode_source_file_keys": "1",
  • "clean_file_headers": "0",
  • "file_type": "delimited"
}

Response samples

Content type
application/json
{
  • "file_map": "'encoding':'','separator':',','enclosure':'\\\\'','escaper':'\\\\'','maps':{'id':'id','upc':'upc','additional_image_link':'additional_image_link','availability':'availability','brand':'brand','bulk_pricing_rules':'bulk_pricing_rules','categories':'categories','category_ids':'category_ids','condition':'condition','cost_price':'cost_price','custom_fields':'custom_fields','description':'description','fixed_cost_shipping_price':'fixed_cost_shipping_price','gtin':'gtin','image_link':'image_link','inventory_tracking':'inventory_tracking','is_visible':'is_visible','item_group_id':'item_group_id','link':'link','mpn':'mpn','options':'options','order_quantity_minimum':'order_quantity_minimum','parent_id':'parent_id','price':'price','product_can_be_purchased_online':'product_can_be_purchased_online','product_image':'product_image','sale_price':'sale_price','sku':'sku','stock':'stock','title':'title','variant_can_be_purchased_online':'variant_can_be_purchased_online','videos':'videos','weight':'weight','additional_image_link_description':'additional_image_link_description'},'ignore_join':[]}",
  • "name_based_maps": "1",
  • "clean_file_headers": "0"
}

Retrieves auto detected imports

Authorizations:
bearerAuth
path Parameters
db_id
required
number
import_id
required
number
header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Exports

Retrieves a list of exports for a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database that the export belongs to

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Adds an export to a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer
Example: 69600146

ID of the database

header Parameters
x-api-key
required
string
Example: commodo consequat reprehe
Content-Type
string
Example: application/json

Responses

Response samples

Content type
application/json
Example
{
  • "name": "consectetur",
  • "file_name": "exercitation in m",
  • "protocol": "webhook",
  • "protocol_info": {},
  • "host": "",
  • "username": "",
  • "password": "",
  • "file_header": "",
  • "file_footer": "",
  • "threshold": 0,
  • "delimiter": "tab",
  • "compression": "",
  • "quoted_fields": 0,
  • "deduplicate_field_name": { },
  • "export_format": "delimited",
  • "include_column_names": 1,
  • "export_encoding": "",
  • "enclosure": "'",
  • "escape": "\\\\",
  • "strip_characters": [
    ],
  • "show_empty_tags": 0,
  • "use_cdata": 0,
  • "xml_write_document_tag": 0,
  • "zip_inner_file_name": "",
  • "time_between_attempts": 1,
  • "max_attempts": 1,
  • "destination": "target",
  • "destination_region": "en-US"
}

Updates an export configuration

Authorizations:
bearerAuth
path Parameters
db_id
required
number
export_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required
any

Responses

Request samples

Content type
application/json
{
  • "name": "export_name2",
  • "file_name": "filename.txt",
  • "protocol": "ftp",
  • "protocol_info": [ ],
  • "host": "host.com",
  • "username": "username",
  • "password": "password",
  • "export_fields": {
    },
  • "export_selector": "true",
  • "file_header": "",
  • "file_footer": "",
  • "threshold": "0",
  • "include_column_names": "1",
  • "json_minify_type": "full",
  • "export_encoding": "",
  • "delimiter": "tab",
  • "enclosure": "",
  • "escape": "",
  • "strip_characters": {
    },
  • "show_empty_tags": "0",
  • "show_empty_parent_tags": "1",
  • "use_cdata": "0",
  • "xml_write_document_tag": "1",
  • "zip_inner_file_name": "",
  • "quoted_fields": "0",
  • "sortable_fields": {
    },
  • "deduplicate_field_name": [ ],
  • "export_format": "delimited",
  • "timeout": "1200",
  • "max_attempts": "3",
  • "time_between_attempts": "30",
  • "row_sort": "",
  • "row_order": "ASC",
  • "row_limit": 0,
  • "tags": [ ],
  • "validate_custom_input": true,
  • "export_index_field": "",
  • "destination": "target",
  • "destination_region": "en-US"
}

Response samples

Content type
application/json
{
  • "id": "72",
  • "db_id": "136",
  • "file_name": "filename.txt",
  • "username": "username",
  • "password": "password",
  • "ftp_url": "",
  • "cron": null,
  • "next_run_time": null,
  • "export_selector": "true",
  • "running": "0",
  • "cxn_id": "0",
  • "export_format": "delimited",
  • "name": "export_name2",
  • "protocol": "ftp",
  • "protocol_info": [ ],
  • "host": "host.com",
  • "file_header": "",
  • "file_footer": "",
  • "threshold": "0",
  • "include_column_names": "1",
  • "json_minify_type": "full",
  • "export_encoding": "",
  • "delimiter": "tab",
  • "compression": "",
  • "quoted_fields": "0",
  • "deduplicate_field_name": [ ],
  • "timestamp": "0000-00-00 00:00:00",
  • "enclosure": "",
  • "escape": "",
  • "strip_characters": {
    },
  • "show_empty_tags": "0",
  • "show_empty_parent_tags": "1",
  • "xml_write_document_tag": "1",
  • "use_cdata": "0",
  • "zip_inner_file_name": "",
  • "max_attempts": "3",
  • "time_between_attempts": "30",
  • "row_limit": "0",
  • "row_sort": "",
  • "row_order": "ASC",
  • "legacy_workers": "0",
  • "timeout": "1200",
  • "worker_pid": null,
  • "worker_hostname": null,
  • "blocked": "0",
  • "export_index_field": "",
  • "destination": "target",
  • "destination_region": "en-US",
  • "created_at": "2021-11-15 18:51:37",
  • "export_fields": {
    }
}

Delete Export

Authorizations:
bearerAuth
path Parameters
db_id
required
number
export_id
required
number
header Parameters
x-api-key
required
string

Responses

Update Schedule in Cron Format

Authorizations:
bearerAuth
path Parameters
db_id
required
number
export_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required

Json object containing 'day','hour','minute' with values, or 'paused' boolean, or both

day
string
hour
string
minute
string
paused
number

0 or 1. 1 sets to paused. 0 is default.

Responses

Request samples

Content type
application/json
{
  • "day": "string",
  • "hour": "string",
  • "minute": "string",
  • "paused": 0
}

Response samples

Content type
application/json
{
  • "cron": "0 1 * * 1",
  • "paused": 0
}

Run Export

Authorizations:
bearerAuth
path Parameters
db_id
required
number
export_id
required
number
header Parameters
x-api-key
required
string
Request Body schema: application/json
required
local
boolean

Responses

Request samples

Content type
application/json
{
  • "local": true
}

Response samples

Content type
application/json
{
  • "status": "success"
}

Vault

Retrieves a list of vault entries for a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database that the import belongs to

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "string",
  • "data": {
    }
}

Add a vault entry to a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database

header Parameters
x-api-key
required
string
Request Body schema: application/json
required

The vault parameters

name
required
string

The name of the vault entry

expiration
required
string

Date when the entry should expire (YYY-MM-DD)

credentials_type
required
string
Value: "none"

The type of credentials to be stored (Use 'none' for free-form JSON)

credentials
required
string

Free Form JSON string of credentials

Responses

Request samples

Content type
application/json
{
  • "name": "Facebook Credentials",
  • "expiration": "2022-12-25",
  • "credentials_type": "none",
  • "credentials": "json object"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "SUCCESS",
  • "data": {
    }
}

Deletes the vault entry

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

The database id

vault_id
required
integer

The vault entry id

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "SUCCESS",
  • "data": {
    }
}

Data Overrides

Retrieves the data overrides for a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database to get transformed data from

query Parameters
limit
number

How many results should be returned

last_id
number

Offset used for paging

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "count": "string",
  • "overrides": [
    ]
}

Retrieves the data overrides for a database

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database to get transformed data from

export_id
required
integer

ID of the export to add transformed data to (0 if all)

query Parameters
item_sku
string

Primary key value of specific row requesting

header Parameters
x-api-key
required
string

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "count": "string",
  • "overrides": [
    ]
}

Create/Update OR Delete transformed data overrides for a specific export in a database. A primary key must be set for the database.

Authorizations:
bearerAuth
path Parameters
db_id
required
integer

ID of the database to get transformed data from

export_id
required
integer

ID of the export to add transformed data to (0 if all)

header Parameters
x-api-key
required
string
Request Body schema: application/json

Create/Update or Delete transformed data overrides (TDOs)

data_row_id
required
string

The id of the TDO

join_value
required
string

The value of the primary-key-column in the target data row

override_field
required
string

The target column to override

override_value
required
string

The value that column will be set to

delete
boolean

Set to 'true' to specify deletion of given TDO. Note: deletes and creates/updates must be done in separate requests.

Responses

Request samples

Content type
application/json
Example
[
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
Example
{
  • "status": "success",
  • "data": {
    }
}