The SalesData resource is used to create records for different metrics defined by the SalesType field.

❗️

Deprecated Endpoint

Please note that this endpoint will be deprecated at the end of 2023. Follow the Sales Data Overview guides for the latest info.

LATEST SALES DATA API INFORMATION
Sales Data Overview

Data ElementData TypeWhat is itMandatory
IdIntegerThe unique identifier of the recordNo
DateDateThe date of the sales data recordNo
TimestampIntegerThe timestamp of the dales data recordNo
EmployeeIntegerThe unique id of the employee record linked to this Sales Data recordNo
OperationalUnitIntegerThe unique id of the operational unit (a.k.a. area) record linked to this Sales Data recordNo
SalesRefVarCharA unique reference for the sale data record usually referring to the id in the source system for the sales dataYes
SalesTypeVarCharThe type of metric that this Sales Record belongs toNo
SalesQtyFloatThe count of units soldNo
SalesAmountFloatThe dollar amount of the recordNo
SalesPayloadBlobJSON payload of sales record from external systemNo
CreatorIntegerThe identifier of the user who created the recordNo
CreatedDateTimeWhen the record was originally createdNo
ModifiedDateTimeThe last time the record was modifiedNo

Foreign Objects which can be linked with the Resource API

EmployeeObject
OperationalUnitObject