Order Acknowledgement
Single Order Acknowledgement
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.
The Single Order Acknowledgement endpoint supports two request formats: the LineItem format and the deprecated RecipeSet format supported for clients on previous API versions.
The available {SpectrumEnvironment}
base URLs are listed in the Environments page.
LineItem Format - Required
purchaseOrderNumber
(string)orderDate
(ISO 8601 date string)lineItems
(array)lineItems[n]
(object)recipeSetId
(string)sku
(string)quantity
(string)proofStatus
("Requested" (1) or "Fulfilled" (2))skuQuantities[n]
(string)quantity
(string)sku
(string)
LineItem Format - Optional
accountNumber
(string)priority
(enumeration: lower, normal, higher)organizationId
(string)phoneNumber
(string)serialNumber
(string)proofStatus
("Requested" (1) or "Fulfilled" (2))estimatedDeliveryDate
(ISO 8601 date string)
LineItem Format: Example request body
RecipeSet Format (Deprecated) - Required
purchaseOrderNumber
(string)orderDate
(ISO 8601 date string)recipeSets
(array)recipeSets[n]
(object)recipeSetId
(string)skuQuantities
(array)skuQuantities[n]
(object)sku
(string)quantity
(string)
RecipeSet Format (Deprecated) - Optional
accountNumber
(string)organizationId
(string)
RecipeSet Format (Deprecated): Example request body
Regardless of the request method chosen, both formats will return the same JSON responses.
Example JSON response (200 Success)
Example JSON response (409 Conflict)
Example JSON response (500 Error)
Multiple Order Acknowledgements
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 single order acknowledgement are required.
Example request body
Full Order Details
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.
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
(stringcountry
(string)
shippingAddress
(object)[same required fields as customerAddress]
Optional
accountNumber
(string)priority
(enumeration: lower, normal, higher)organizationId
(string)emailAddress
(string)phoneNumber
(string)giftMessage
(string)shipmentVendor
(string)shipmentTracking
(string)estimatedDeliveryDate
(ISO 8601 date string)address2
(string)province
(string)
Example request body
Last updated