InterfaceItem_ROHeader Model

Remote Order header details that are stored against a Sales Transaction longer term

Required
ProviderID : number (int)

unique ID for identifying the third party provider transmitting the remote order

Required
ProviderName : string

The name of the provider this remote order came from

Required
ProviderOrderID : string

Unique ID for this order as supplied by third party provider

Required
RemoteOrderType : RemoteOrderType

the type of the remote order

Nullable
RemoteOrderID : string (GUID)

The type of request that resulted in this transaction result

Nullable
ProviderDisplayName : string

In the case where the Provider is aggregating orders from multiple external channels/sources/marketplaces, this property can be used to assign a name that will used in place of ProviderName on all customer/staff facing UI/physical media.
It should be used to identify the actual downstream order provider fulfilling the order, otherwise it will match the ProviderName field.

Nullable
ProviderPickupCode : string

Semi unique human readable ID supplied by third party provider identifying this order for the person performing pickup (eg - a 4 digit number). These are expected to repeat over a long period of time

Can be null

Nullable
ConsumerProviderContactID : string

Consumer ID - can be null - as defined by third party provider

Nullable
CourierProviderContactID : string

Courier ID - can be null - as defined by third party provider

Nullable
ProviderDeliveryID : string

Delivery ID - can be null - as defined by third party provider

Example
{
  "ProviderID": 321,
  "ProviderName": "string value",
  "ProviderOrderID": "string value",
  "RemoteOrderType": 1,
  "RemoteOrderID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
  "ProviderDisplayName": "string value",
  "ProviderPickupCode": "string value",
  "ConsumerProviderContactID": "string value",
  "CourierProviderContactID": "string value",
  "ProviderDeliveryID": "string value"
}