Required
productType :
OrderNPayProductType
The type of product this record represents
Required
MaxLength(50)
name :
string
The name of the product from the providers point of view
Required
quantity :
number (int)
The number of items
Required
decimal(13, 2)
price :
number (decimal)
The unit price of the item
NOTE: When the encompassing request's UseProviderPrices field is set to TRUE, the Price value must be set to the expected price for the item.
NOTE: When the encompassing request's UseProviderPrices field is set to FALSE, the Price value is ignored and can just be zero.
Required
decimal(13, 2)
totalAmount :
number (decimal)
The total of the item
NOTE: When the encompassing request's UseProviderPrices field is set to TRUE, the TotalAmount value must be set to the expected total for the item (ie Quantity * Price)
NOTE: When the encompassing request's UseProviderPrices field is set to FALSE, the TotalAmount value is ignored and can just be zero.
Nullable
MaxLength(64)
providerProductID :
string
The unique id for this line from the provider
Nullable
MaxLength(36)
pluIdentifier :
string
The PLU Guid or PLU Number
Nullable
MaxLength(36)
salesModifierIdentifier :
string
The Sales Modifier Guid or prefix
Nullable
MaxLength(8)
salesModifierName :
string
The Sales Modifier Name / prefix
Nullable
childProducts :
OrderNPayChildProduct
[]
The child items attached to this product
Nullable
adjustment :
OrderNPayAdjustment
A selected item adjustment to apply to this product
Example
{
"productType": 1,
"name": "string value",
"quantity": 321,
"price": 1.23,
"totalAmount": 1.23,
"providerProductID": "string value",
"pluIdentifier": "string value",
"salesModifierIdentifier": "string value",
"salesModifierName": "string value",
"childProducts": [],
"adjustment": {}
}