RemoteOrderCancellation Model

Represents a cancellation of a prior RemoteOrder sent by a third party provider

Required
remoteOrderCancellationID : string (GUID)

The primary key for this cancellation as assigned by ROS.

A third party provider should omit this property entirely OR leave this as Guid.Empty. ROS will overwrite it and return the new value at order submission

Required
remoteOrderID : string (GUID)

The primary key for the referenced remote order that is being cancelled. This is the ID returned when submitting the original RemoteOrder

Required
outletID : string (GUID)

ID of the outlet this will be transmitted to

Required
providerID : number (int)

Unique ID for identifying the third party provider transmitting the remote order (from the Registered Integration Provider's list)

Required MaxLength(64)
providerName : string

Name for identifying the third party provider transmitting the remote order (from the Registered Integration Provider's list)

Nullable
dateTimeReceivedUTC : string (ISO 8601 DateTime)

The time (in UTC) that this cancellation was received by our remote order service

Nullable MaxLength(32)
cancelReason : string

Reference to the cancellation reason, unique to provider

Can be null

Nullable MaxLength(32)
paymentStrategy : string

Reference to the reimbursment model supported by the provider or null if not applicable

Example
{
  "remoteOrderCancellationID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "remoteOrderID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "providerID": 321,
  "providerName": "string value",
  "dateTimeReceivedUTC": "2012-04-03T09:40:59.736Z",
  "cancelReason": "string value",
  "paymentStrategy": "string value"
}