Ordering API Docs Help

SQS Reference

This document provides an overview of how vendors can pull different message types from Amazon Simple Queue Service (SQS). The message types include issue, order, and orderAction.

Message Types

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

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

  2. OrderAction: This message type is related to any actions that need to be taken on an order.

  3. Issue: This message type is related to any issues that might occur during the order process.

Common Fields

All the above message types have the following common fields:

Field Name

Data Type

Description

Possible Values

messageType

String

Type of the message

issue, order, orderAction

messageVersion

Integer

Version of the message

1, 2

message

Object

Payload for the given message

issue, order, orderAction

timestamp

Datetime (ISO 8601 in UTC)

Timestamp when this message was sent

e.g. 2024-05-24T10:15:00.000Z

Authorization

To pull messages from SQS, reach out to the DOT team to authorize your AWS account to access the SQS queue.

09 July 2024