SalesData

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 Element

Data Type

What is it

Mandatory

Id

Integer

The unique identifier of the record

No

Date

Date

The date of the sales data record

No

Timestamp

Integer

The timestamp of the dales data record

No

Employee

Integer

The unique id of the employee record linked to this Sales Data record

No

OperationalUnit

Integer

The unique id of the operational unit (a.k.a. area) record linked to this Sales Data record

No

SalesRef

VarChar

A unique reference for the sale data record usually referring to the id in the source system for the sales data

Yes

SalesType

VarChar

The type of metric that this Sales Record belongs to

No

SalesQty

Float

The count of units sold

No

SalesAmount

Float

The dollar amount of the record

No

SalesPayload

Blob

JSON payload of sales record from external system

No

Creator

Integer

The identifier of the user who created the record

No

Created

DateTime

When the record was originally created

No

Modified

DateTime

The last time the record was modified

No

Foreign Objects which can be linked with the Resource API

EmployeeObject
OperationalUnitObject