SPOKE API Documentation


✋ Introduction

API Base URL

<aside> 💡 All API calls are sent to a single URL:

https://api.spokecustom.com/order/submit

</aside>

↔️ XML Elements

Each call to the API will be a POST request with XML in the body. Each request is made up of the following elements.

<?xml version="1.0" ?>
<Request>
	<Customer>CustomerName</Customer>
	<RequestType>New|Update|Cancel</RequestType>
	<Key>1234554321123450</Key>
	<Logo>
		<ImageType>jpg</ImageType>
		<Url>http://MyLogoImage.com/logo.jpg</Url>
	</Logo>
	<Order>
		...	
	</Order>
</Request>

<aside> 💡 NOTE: All XML Elements are case sensitive.

</aside>

Element Required Description
Request Yes Container for the POST request.
Customer Yes Unique Customer Name provided by SPOKE.
RequestType Yes • New - Create a new order.
• Update - Modify an existing order.
• Cancel - Cancel an order that hasn’t started processing.
Key Yes Unique key provided by SPOKE.
Logo No Container for your Logo image.
Logo/ImageType Conditional Required if Logo is present. The file extension for the file referenced in the URL.
Logo/Url Conditional Required if Logo is present. The URL of the logo file you would like us to use on any documents created on your behalf. Image size should be a square of 140 pixels by 140 pixels and saved as a JPEG.
Order Yes Container for the Order information. This element allows different fields based on the request type.

🆕 New Order Elements


✍️ Update Order Elements


❌ Cancel Order Elements


⬅️ XML Responses


📔 Product Offerings

Spoke Custom Product/CaseTypes for All Product IDs.


🚚 Shipping Method Overrides

📢 Shipment Notifications

🗣️ Other Notifications

🔗Order Extensions