Skip to content

Sales summary

Sales Summary is a reduced, simplified data set that can be used instead of the detailed endpoints.

It allows demoing Zoined with own, aggregated data, or can be used in production environment when the more detailed data set is not required or available.

Operations

Upload sales summaries

Request

POST https://api.zoined.com/salesSummaries?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
sales_datestringrequired

Sales date (yyyy-mm-dd)

Example:"2016-01-01"
sales_timestring

Sales time (HH:mm:ss)

Example:"15:00:00"
organisation_idstringrequired

Organisation/Store ID

Example:"540"
department_idstring

Store department ID

Example:"5401"
salesperson_idstring

Sales person ID

Example:"5402101"
sales_valuenumber

Total sales amount including tax

Example:2000
sales_value_wo_vatnumber

Total sales amount without tax

Example:1600
sales_currencystring

Sales currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
rebatenumber

Amount of rebate given including tax

Example:0
rebate_wo_vatnumber

Amount of rebate given without tax

Example:0
purchase_pricenumber

Total purchase price including tax

Example:500
purchase_price_wo_vatnumber

Total purchase price without tax

Example:400
purchase_currencystring

Purchase currency as ISO 4217 currency code. Required if multiple currencies are used.

Example:"EUR"
product_quantitynumber

Sold quantity

Example:4
number_of_transactionsnumber

Number of receipts

Example:2
product_idstring

Product ID

Example:"XYZ"
customer_idstring

Customer ID for identified customer

Example:"32"
supplier_idstring

Supplier ID

Example:"221"
parent_product_idstring

Parent Product ID

Example:"123"
campaign_idstring

Campaign ID

Example:"123"
rebate_code_idstring

Rebate Code ID

Example:"3313V"
cancelledboolean

cancelled. true=cancelled transaction false=not cancelled transaction. Default is false.

Example:false
custom_field_1string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_2string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_3string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_4string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_5string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_6string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_7string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_8string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_9string

Field that can be used for custom dimensions

Example:"XYZ"
custom_field_10string

Field that can be used for custom dimensions

Example:"XYZ"
custom_metric_1number

Custom metric 1

Example:1
custom_metric_2number

Custom metric 2

Example:100
custom_metric_3number

Custom metric 3

Example:2.2
custom_metric_4number

Custom metric 4

Example:1.05
custom_metric_5number

Custom metric 5

Example:10000
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/salesSummaries?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "sales_date": "2016-01-01",
    "sales_time": "15:00:00",
    "organisation_id": "540",
    "department_id": "5401",
    "salesperson_id": "5402101",
    "sales_value": 2000,
    "sales_value_wo_vat": 1600,
    "sales_currency": "EUR",
    "rebate": 0,
    "rebate_wo_vat": 0,
    "purchase_price": 500,
    "purchase_price_wo_vat": 400,
    "purchase_currency": "EUR",
    "product_quantity": 4,
    "number_of_transactions": 2,
    "product_id": "XYZ",
    "customer_id": "32",
    "supplier_id": "221",
    "parent_product_id": "123",
    "campaign_id": "123",
    "rebate_code_id": "3313V",
    "cancelled": false,
    "custom_field_1": "XYZ",
    "custom_field_2": "XYZ",
    "custom_field_3": "XYZ",
    "custom_field_4": "XYZ",
    "custom_field_5": "XYZ",
    "custom_field_6": "XYZ",
    "custom_field_7": "XYZ",
    "custom_field_8": "XYZ",
    "custom_field_9": "XYZ",
    "custom_field_10": "XYZ",
    "custom_metric_1": 1,
    "custom_metric_2": 100,
    "custom_metric_3": 2.2,
    "custom_metric_4": 1.05,
    "custom_metric_5": 10000,
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
statusstringrequired

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}