Product Feed API Specification
The SPOKE API lets you integrate your storefront or order management system directly with SPOKE Custom. Two APIs are available today, and both use the same credentials and the same base URL.
| API | What it does | Style |
|---|---|---|
| Order API Specification | Submit new orders, update or cancel them before production starts, and receive shipment and status notifications. | XML over HTTP POST |
| Product Feed API Specification | Retrieve the full list of orderable SKUs, their accepted aliases, and current availability so your catalog stays in sync with SPOKE. | JSON or XML over HTTP GET |
<aside> 💡
Base URL for all requests: https://api.spokecustom.com
</aside>
Every request requires two values issued by SPOKE: your API Customer Name and your API Key. Both are case-sensitive and the same pair works for both APIs.
| Credential | Order API | Product Feed API |
|---|---|---|
| API Customer Name | Customer element in the XML request body |
X-Api-Customer HTTP header |
| API Key | Key element in the XML request body |
X-Api-Key HTTP header |
<aside> 📧
Need credentials or want to enable an optional feature? Contact [email protected] or your account manager. Shipping method mappings, custom packing slips, notification subscriptions, and order extensions are configured per account.
</aside>
Send, Update, and Cancel Orders through SPOKE API. All calls are POST requests with an XML body to /order/submit.
Request functions
RequestType = NewRequestType = UpdateRequestType = CancelOptions and extensions
Notifications and errors
Product Feed API Specification
Retrieve the complete list of available SPOKE SKUs with accepted aliases and stock status. Both endpoints are GET requests returning JSON by default, or XML with format=xml.
Endpoints
X-Api-Customer and X-Api-Key headersGET /Product/Feed?limit=100&offset=0GET /Product/Detail?sku=…Reference
sku, aliases, status, stockA single list of every API function, in the order you are likely to use them.
| Function | API | Method and endpoint | Purpose |
|---|---|---|---|
| New Order | Order | POST /order/submit (RequestType=New) |
Create a new order with shipping info, cases and artwork. |
| Update Order | Order | POST /order/submit (RequestType=Update) |
Modify an existing order that has not started processing. |
| Cancel Order | Order | POST /order/submit (RequestType=Cancel) |
Cancel an order that has not started processing. |
| XML Responses | Order | Response body | Success (ResponseSuccess) and failure formats. |
| Shipping Method Overrides | Order | ShippingAccount • ShippingMethodId elements |
Choose a specific carrier and service per order. |
| Order Extensions | Order | OrderExtensions element |
Account-specific features such as Customer Supplied Shipping Label. |
| Shipment Notifications | Order | Outbound XML (URL post or email) | Tracking number, carrier, ship date and shipped cases. |
| Other Notifications | Order | Outbound XML (URL post or email) | Received, Working, Completed and Cancelled notices. |
| Common Error Responses | Order | Response body | Known validation errors and the element they relate to. |
| Response Codes | Product Feed | HTTP status + JSON body | 200 / 400 / 401 / 404 meanings and error body format. |
| Product Feed (paged) | Product Feed | GET /Product/Feed |
List all orderable SKUs with aliases and availability, 1–500 per page. |
| Product Detail | Product Feed | GET /Product/Detail?sku= |
Look up one item by SKU or alias. |