✋ Introduction

The Product Feed API lets you retrieve the complete list of available SPOKE SKUs, along with the codes accepted on orders and current stock status. Use it to keep your catalog in sync with SPOKE and to avoid submitting orders for items that are unavailable.

The initial release returns item codes, aliases, and availability. Additional product attributes are planned for a future release and will be documented here.

<aside> 🔗

Items returned by this feed can be ordered through the Order API Specification. The sku value (or any listed alias) is the code to use on your order.

</aside>

API Base URL

<aside> 💡

All requests are sent to:

https://api.spokecustom.com

Endpoints below are relative to this base URL.

</aside>

🔐 Authentication

Every request must include two HTTP headers: your API Customer Name and your API Key. Requests without both headers are rejected with 401 Unauthorized. Both values are issued by SPOKE and are case-sensitive.

<aside> 📧

Don't have your API Customer Name or API Key? Contact [email protected] and we will provide your credentials. Existing Order API customers can use the same values.

</aside>

Header Required Description
X-Api-Customer Yes Your unique API Customer Name issued by SPOKE. This is the same value used as Customer on the Order API.
X-Api-Key Yes Your unique API Key issued by SPOKE. This is the same value used as Key on the Order API.

<aside> 🚨

Credentials are accepted only in headers. Credentials passed in the URL or query string are rejected. A missing header, or a value with incorrect casing, returns 401 Unauthorized.

</aside>

Example Request (cURL)

Replace YOUR_CUSTOMER_NAME and YOUR_API_KEY with the values issued by SPOKE.

curl "https://api.spokecustom.com/Product/Feed?limit=100&offset=0" \
  -H "X-Api-Customer: YOUR_CUSTOMER_NAME" \
  -H "X-Api-Key: YOUR_API_KEY"

↔️ Endpoints

Both endpoints are GET requests and return JSON by default. Add format=xml to receive XML.

📄 Product Feed (paged)

Returns the complete list of available SKUs, in pages.