get-sales | Mediahawk docs

Skip to main content

Get list of sales

Query Parameters

offset integer
The number of items to skip before starting to collect the result set
limit integer
The numbers of items to return. If not present, results will be limited to 100 items

Responses

200
400

application/json

Schema
Example (from schema)

Schema array

id string
The sale ID
description string
Description
date string
The date of the sale. Formatted as ISO 8601 without time.
value string
The value of the sale
call_id string
The matched call id
visit_id string
The matched visit id
properties object[]
key integer
The key of the property
value string
The value of the property

[
  {
    "id": "ABC123",
    "description": "1 x Box of stuff",
    "date": "2022-10-01",
    "value": "100",
    "call_id": "1",
    "visit_id": "1",
    "properties": [
      {
        "key": "1",
        "value": "JS001"
      }
    ]
  }
]