An OrderReport represents the top level, header information on a historical order.
Historical orders may be sent to the RepSpark API that did not originate from the RepSpark web and mobile apps. For example, many brands want to provide their sales representatives and customers access to historical orders from the past couple of years. Refer to Batch Types and Sync Modes to learn more about sending millions of orders to the RepSpark API.
Delta syncs for Reports generally include OrderItems, but report headers and items can also be sent separately if desired - using the OrderReport sync for headers and OrderItemReport sync for the order line items. If any OrderItems are included at all in an OrderReport sync, then all OrderItems will be diffed - this can be used to delete specific OrderItems from reports. If no OrderItems are included in the sync, then it is assumed that only Report headers need to be updated.
Recommended sync cadence
Delta syncs should be run once per day and on-demand when needed.
Full syncs should only be necessary during initial setup or when an overall data refresh is needed.
Any Code/Description pair values typically found in Options data (e.g. Colors, Divisions) must have their Descriptions defined in Reports, as reporting data does NOT pull from the Options resource. This is because the report may have different description values from what is currently defined in the Option data. For example, the color code ABC may have been mapped to a different value in 2021 than what it is today.