Request model for submitting a batch of PartnerSalesTransaction records for a Trading Date or Z Report.
Constant
System.Int32 MAX_BATCH_SIZE = 64
The maximum number of PartnerSalesTransaction records that can be included in a batch submission
Required
outletID :
string (GUID)
The OutletID that the batch will be associated with. This must be a valid Outlet ID configured within the POS system.
3rd party integrations can be provided with a valid Outlet ID for order submission depending on the customer's requirements.
Nullable
zReportID :
string (GUID)
(SPECIAL) This is the Z period that the sales figures in this batch will be included as part of.
When provided, the value for ZReportID must match an unfinalised Z Report in the system. Integrators should use the appropriate api method to get Z information before submitting their sales.
When NOT provided (ie NULL), the ZReportTarget property must be populated.
Rule: You must supply either a ZReportID or ZReportTarget.
Nullable
zReportTarget :
PartnerZReportTarget
(SPECIAL) This defines the parameters of the batch allocation when a specific Z Report ID has NOT been specified.
When provided, a Z will automatically be allocated based on the ZReportTarget settings for the batch.
Note: Auto generated Z's from the ZReportTarget will be created in an unfinalised state and will remain so until a separate api call is made to finalise the Z.
Rule: You must supply either a ZReportID or ZReportTarget.
Nullable
batchOptions :
PartnerSalesBatchRequestOptions
(OPTIONAL) Defines any additional processing options relating to the batch.
Default: No additional options.
Nullable
sales :
PartnerSalesTransaction
[]
A batch of one or more PartnerSalesTransaction objects to submit to the system.
Note: The batch size is limited to a maximum of MAX_BATCH_SIZE at a time. Exceeding this will result in the entire batch being rejected.
Example
{
"outletID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportID": "3f49efe7-ea42-4f21-8718-7e6ce9a33512",
"zReportTarget": {},
"batchOptions": {},
"sales": []
}