API Reference

Query Flags

For the /actions endpoint There are two flags that you must add to your queries:

  1. includeSkus: Set this to true if you want to see all of the SKUs data associated with an action or false if you want to hide this.
  2. includeCustomFields: Set this to true if you want to see all of the custom field data associated with an action (there are 20 custom fields) or false if you want to hide this.

## Sample JSON Body 

{
  "dates": {
    "eventDateStart": "2021-09-19",
    "eventDateEnd": "2021-09-22"
  },
  "includeSkus": false,
  "includeCustomFields": true,
  "limit": 100,
  "offset": 0
}

Sample JSON Request

curl --request POST \
  --url 'https://{server}-api.affluent.io/v1/actions?apiKey=YOUR_API_KEY&=' \
  --header 'Content-Type: application/json' \
  --data '{
"dates": {
    "eventDateStart": "2021-09-19",
    "eventDateEnd": "2021-09-22"
  },
"includeSkus": false,
"includeCustomFields": true,
  "limit": 100,
  "offset": 0
}'