API Documentation

Use our API to integrate your system with our live product database. All requests must be authenticated using your private API key.

Authentication

Include your API key in the Authorization header for every request. You can generate and manage your key in the "API Key" tab.

Authorization: Bearer YOUR_API_KEY

Base URL

https://supplier-api-977359606390.us-central1.run.app

Endpoints & Parameters

GET /

Returns a paginated list of products. You can filter by SKU or UPC.

• limit (optional, default: 250, max: 250) - The number of items to return per page.
• sku (optional) - Filter results for a single product by its SKU.
• upc (optional) - Filter results for a single product by its UPC.
• cursor (optional) - The ID of the last item from the previous page to get the next page of results.

Response Format

All successful requests will return a JSON object with meta and data keys. The structure of the meta object depends on the type of query.

For general browsing (no SKU or UPC filter):

{
    "meta": {
        "rate_limit_remaining": 99,
        "per_page": 250,
        "next_page_cursor": "DOCUMENT_ID_OF_LAST_ITEM" 
    },
    "data": [ ... ]
}

For filtered queries (by SKU or UPC):

{
    "meta": {
        "rate_limit_remaining": 98,
        "total": 1,
        "total_pages": 1,
        "per_page": 250
    },
    "data": [ ... ]
}

Data Object Fields

Error Responses

If a request fails, the API will return a JSON object with an error key.

• 401 Unauthorized: The API key is missing, invalid, or has been revoked.

  { "error": "Unauthorized: Invalid API key." }

• 429 Too Many Requests: The user has exceeded the 100 requests per day limit.

  { "error": "You have exceeded the 100 requests in 24 hrs limit!" }

• 500 Internal Server Error: An unexpected error occurred on the server.

  { "error": "An unexpected error occurred." }

Example Request (cURL)

# Get the first page of items
curl -L -X GET "https://supplier-api-977359606390.us-central1.run.app" \
     -H "Authorization: Bearer YOUR_API_KEY"

# Get the next page using the cursor from the previous response
curl -L -X GET "https://supplier-api-977359606390.us-central1.run.app?cursor=PREVIOUS_CURSOR_ID" \
     -H "Authorization: Bearer YOUR_API_KEY"