SQS Reference

This document provides an overview of how vendors can pull different message types from Amazon Simple Queue Service (SQS).

The possible message types include Job and Order creation and update notifications. For example, JobCreated, JobUpdated, OrderCreated, and OrderUpdated, among others.

Message Types

There are two main types of messages that vendors can pull from SQS:

Job: This message type is related to the job details.
Order: This message type is related to the order details.

Common Fields

All the above message types have the following common fields:

Field Name	Data Type	Description	Possible Values
originationSystem	String	The origination system for this message	`dot`, `pi`, `ursula`
messageType	String	Type of the message	`JobCreated`, `JobUpdated`, `OrderCreated`, `OrderUpdated`, `OrderCompleted`, `VoidOrder`
messageDate	Datetime (ISO 8601 in UTC)	The message date	`2025-07-02T22:13:07.630689011Z`
traceId	String	Trace id of this message	`0b68afc7-da89-4333-b313-538707620e52`
payload	JSON	JSON string of the message applying to the type	Please see the `payload` portion of the Sample Message section below for an example payload for the `JobCreated` message type.

Payload Statuses

Within the payload, we have both job-level and order-level status fields.

Level	Possible Status Values
Job	`draft`, `submitted`, `complete`
Order	`draft`, `submitted`, `completed`, `partially completed`, `voided`, `claimed`

Authorization

To pull messages from SQS, you need to ensure that your AWS account has the necessary permissions to access the SQS queue. This typically involves setting up an IAM role or user with the appropriate policies attached.

16 September 2025