Once a custom order has been purchased by the customer and is pending fulfillment, we require transmission of an order acknowledgement to the Spectrum REST API. This request will typically trigger dependent processes, such as delivery of factory print-ready files. It also ensures accurate and meaningful reporting within the Spectrum Admin interface.
An order acknowledgement consists a single order with one or more line items.
POST https://{SpectrumEnvironment}/api/order/acknowledgement HTTP/1.1
SPECTRUM_API_TOKEN: {SpectrumApiToken}
Content-Type: application/json
The available {SpectrumEnvironment} base URLs are listed in the page.
Required
purchaseOrderNumber (string)
orderDate (ISO 8601 date string)
lineItems (array)
lineItems[n] (object)
recipeSetId (string)
skuQuantities[n] (string)
quantity (string)
sku(string)
Order Optional Fields
accountNumber (string)
priority (enumeration: lower (1), normal (2), higher(3))
Finally, Spectrum can capture order and line item details for customer shipping information. This information is stored securely and encrypted within Spectrum, and it can be forwarded to fulfillment partners.
POST https://{SpectrumEnvironment}/api/order HTTP/1.1
SPECTRUM_API_TOKEN: {SpectrumApiToken}
Content-Type: application/json
Required
purchaseOrderNumber (string)
orderDate (ISO 8601 date string)
lineItems (array)
lineItems[n] (object)
recipeSetId (string)
sku (array)
quantity (string)
skuQuantities[n] (string)
quantity (string)
sku(string)
customerAddress (object)
firstName (string)
lastName (string)
address1 (string)
city (string)
state (string)
postalCode (string
country (string)
shippingAddress (object)
[same required fields as customerAddress]
Optional
accountNumber (string)
priority (enumeration: lower (1), normal (2), higher(3))
Spectrum can also handle multiple order acknowledgements, which is helpful when a bulk update is desired over a single request. The same fields for the are required.