Skip to content

Quickstart

The planned production base URL is https://api.freshlycart.com/api/v1. It is not publicly available yet.

Terminal window
curl --request GET \
--url 'https://api.freshlycart.com/api/v1/products?limit=50' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer fc_pat_EXAMPLE'

Approved OAuth applications use an fc_oat_EXAMPLE access token in the same header. OAuth apps are provisioned by FreshlyCart; self-service registration is not available.

  • Public IDs such as prod_... are opaque. Never construct or decode them.
  • Collections default to limit=50, accept at most 200, and continue with meta.next_cursor.
  • Preserve all filters when sending the opaque cursor. There are no page numbers or guaranteed total counts.
  • Success responses include meta.request_id; all responses include X-Request-Id.
  • Errors use a stable error.code. A 429 includes Retry-After.
{
"data": [],
"meta": { "request_id": "req_EXAMPLE", "next_cursor": "opaque-cursor" }
}

Continue with Authentication, Scopes & Permissions, and Pagination.