ArchivedRemoteOrder Model

Required
providerID : number (int)

The ID of the provider who sent this remote order

Required MaxLength(64)
providerOrderID : string

The ID that the provider has defined for this order

Required MaxLength(8)
currencyCode : string

Copy of CurrencyCode from RemoteOrder

Nullable
outletID : string (GUID)

The OutletID this archived remote order applied to

Nullable
remoteOrderID : string (GUID)

The remote order ID that this is an archived record for

providerProcessedNotified : bool

Whether the remote order service (and by extension provider) has processed the creation of this archival. i.e. has the processed remote order been processed/received by the provider

Nullable
dateTimeProviderProcessNotifiedUTC : string (ISO 8601 DateTime)

The date time that ROS set ProviderProcessedNotified to true in UTC

Nullable
dateTimeReceivedUTC : string (ISO 8601 DateTime)

When was this order initially received by ROS in UTC

Nullable
dateTimeCreatedUTC : string (ISO 8601 DateTime)

UTC creation time if supplied by provider

Nullable
dateTimePrepareForUTC : string (ISO 8601 DateTime)

UTC time to prepare this order for in UTC (if applicable)

Nullable
dateTimeProcessed : string (ISO 8601 DateTime)

When was the referenced remote order processed by the POS and received by POSCore

isConfirmed : bool

True if this represents a confirmed order, false if this represents a rejected order

testOrder : bool

If set - the source RemoteOrder that created this ArchivedRemoteOrder had this property set. It indicates
that this isn't a "real" order and that all the items/amounts are for testing purposes only. The linked
sales transaction (if any) should be a training mode transaction.

This flag should ONLY be used for testing purposes only.

Nullable MaxLength(128)
rejectionReason : string

Nullable rejection reason (set only if IsConfirmed = false)

Nullable
rejectionType : RemoteOrderRejectionType

Simple classifier as to why the order was rejected (set only if IsConfirmed = false)

Nullable
outOfStockProducts : OutOfStockProduct []

If this was rejected due to one or more products being out of stock, this will enumerate the offending products (set only if IsConfirmed = false)

Nullable
salesTransactionID : string (GUID)

Set if IsConfirmed is true. It's a reference to the created SalesTransaction from the remote order

Nullable
remoteOrderType : RemoteOrderType

Copy of the RemoteOrderType from RemoteOrder

Nullable decimal(18, 2)
totalAmount : number (decimal)

Copy of TotalAmount from RemoteOrder

Example
{
  "providerID": 321,
  "providerOrderID": "string value",
  "currencyCode": "string value",
  "outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "remoteOrderID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "providerProcessedNotified": true,
  "dateTimeProviderProcessNotifiedUTC": "2012-04-03T09:40:59.736Z",
  "dateTimeReceivedUTC": "2012-04-03T09:40:59.736Z",
  "dateTimeCreatedUTC": "2012-04-03T09:40:59.736Z",
  "dateTimePrepareForUTC": "2012-04-03T09:40:59.736Z",
  "dateTimeProcessed": "2012-04-03T09:40:59.736Z",
  "isConfirmed": true,
  "testOrder": true,
  "rejectionReason": "string value",
  "rejectionType": 1,
  "outOfStockProducts": [],
  "salesTransactionID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "remoteOrderType": 1,
  "totalAmount": 1.23
}