Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.retailgrid.io/llms.txt

Use this file to discover all available pages before exploring further.

The Retailgrid Public API is the programmatic counterpart to the in-app upload flow. Use it when you want to keep Retailgrid in sync with your source systems on a schedule, instead of uploading CSVs by hand.

​
Base URL

https://clientapi.retailgrid.io
All endpoints live under /v1. Future breaking changes will land under a new prefix; minor additions will not change /v1.

​
What you can do today

  • Push catalog data - create, patch, delete, and bulk-upsert products and product variants.
  • Push transactions - create, patch, delete, and bulk-upsert sales transactions.
  • Push competitor prices - create, patch, delete, and bulk-upsert observed competitor prices.
  • Upload CSVs asynchronously - submit a multipart CSV to /v1/imports/* and poll a job handle.
  • Verify your API key - sanity-check that your key works before hooking up a pipeline.

​
When to use the API vs other paths

Public API

For continuous, machine-to-machine sync from your ERP, PIM, or warehouse.

CSV upload in the app

For one-off loads or when an analyst is driving. Same data, manual flow.

Shopify integration

If your catalog lives in Shopify - skip the API and use the native connector.

​
Conventions

A few things are worth reading once before you start integrating:
  • Authentication - how Bearer keys work and where to issue one.
  • Conventions - bulk endpoints, async jobs, decimals as strings, timestamps in UTC.
  • Imports vs bulk - which endpoint family to pick for which job.
  • Errors - status codes and the validation-error shape.

​
Versioning

The current version is v1. Additive changes (new fields, new endpoints, new optional parameters) ship without notice. Breaking changes will be announced in the API changelog and shipped under a new version prefix.