v1

latestOpenAPI 3.0.02026-08-04265791.1 MB
Business KPIs data - salesdata

Create

You may create a new single salesdata or multiple salesdatas using this action.
When creating a single salesdata the body contains a json object, when creating multiple salesdata the body contains an array of objects.
Warning: a maximum of 1000 items can be sent in a single request.

post/public/api/salesdata

Headers

Acceptstring

e.g. application/json

Request body

store_idstring
reporting_datestring
titlestring
categorystring
valuenumber
value_currencystring
value_frequencystring

Example request

{
  "store_id": "54ab03c6546847ee0d30086d",
  "reporting_date": "2018-05-21T04:51:40.862Z",
  "title": "Milk salesdata 1",
  "category": "Food",
  "value": 5,
  "value_currency": "$",
  "value_frequency": "hourly"
}

Response

OK

salesdata_idstring
store_idstring
reporting_datestring
titlestring
categorystring
valuenumber
value_currencystring
value_frequencystring
targetboolean
created_datestring
updated_datestring

Example response

{
  "salesdata_id": "52cb02c6546847ee0d30082b",
  "store_id": "54ab03c6546847ee0d30086c",
  "reporting_date": "2018-05-21T04:51:40.862Z",
  "title": "Weekly Sales Target",
  "category": "sales",
  "value": 100000,
  "value_currency": "USD",
  "value_frequency": "weekly",
  "target": true,
  "created_date": "2018-05-21T04:51:40.862Z",
  "updated_date": "2018-05-21T04:51:40.862Z"
}