API reference - Ready for Commerce

Base URL

https://app.readyforcommerce.com

Every operation’s path starts with /api/v1, and an organization’s operations sit under /api/v1/orgs/{orgId}/. Requests and answers are JSON.

Authentication

Every call sends an organization’s API key as a Bearer token, in the Authorization header. A person of the organization creates the key in the app, in Settings › API and connections › API keys. Keep it out of your code: read it from an environment variable or a secret store, as these examples do with RFC_API_KEY.

curl https://app.readyforcommerce.com/api/v1/credential \
  --header "Authorization: Bearer $RFC_API_KEY"

import os

import requests

response = requests.get(
    "https://app.readyforcommerce.com/api/v1/credential",
    headers={"Authorization": f"Bearer {os.environ['RFC_API_KEY']}"},
)
print(response.json())

<?php
$curl = curl_init('https://app.readyforcommerce.com/api/v1/credential');
curl_setopt_array($curl, [
    CURLOPT_HTTPHEADER => ['Authorization: Bearer ' . getenv('RFC_API_KEY')],
    CURLOPT_RETURNTRANSFER => true,
]);
echo curl_exec($curl);

const response = await fetch('https://app.readyforcommerce.com/api/v1/credential', {
  headers: { Authorization: `Bearer ${process.env.RFC_API_KEY}` },
});
console.log(await response.json());

This first call, Get the calling credential, reads the key itself: its organization, whose org.id is the orgId of every other path, its permissions, its limits and the calls it may still make. It counts against no limit. A key that is unknown, revoked or expired gets 401 with the code core.invalid_credential.

Errors

A failed call answers application/problem+json: its code names what went wrong, such as core.validation_failed or core.rate_limited, and its params hold the values that explain it. Each operation’s page lists the codes it may answer.

Groups of operations

Credentials

The credential that calls: its organization, its permissions, its limits and the calls it may still make.

Organization

The organization’s settings: its name, slug and currency.

Billing

The organization’s subscription, each module’s bill and cap, and this month’s usage.

Record types

The kinds of record the credential may import or export, with each one’s fields and options.

Imports

Bring CSV or Excel files in: upload or fetch a file, inspect and check it, then import it.

Files

An uploaded file’s status, until it is ready or rejected.

Exports

Export the records a filter matches to CSV or Excel files.

Export templates

Saved export setups, by name, to run the same export again.

Jobs

Follow long work: its state and progress, its messages and files, or cancel it.

Search

Find the organization’s records by words, a typo included, grouped by kind.

Version history

A record’s versions: compare one with another and restore the record to it.

Incidents

The organization’s problems you may see: mark them read or unread, and resolve them.

Notifications

Your notifications, newest first: mark one read or unread, or all of them read.

Saved views

A table’s search, filters, order and columns saved under a name, yours or shared.

Store connections

The organization’s stores: list them, connect one, reconnect it with new keys or disconnect it.

Products

The organization’s products with their options and variants: read one or create one.