Summarise order updates

What order updates delivered for this store — reach, cost and engagement

GET /crm/connections/{id}/order-updates/summary

Summarise order updates

cURL

curl --request GET \
  --url https://api.pineyard.ai/crm/connections/{id}/order-updates/summary \
  --header 'Authorization: Bearer <token>'

200

{
  "orders": 1,
  "ordersWithPhone": 1,
  "ordersNotified": 1,
  "attempted": 1,
  "delivered": 1,
  "read": 1,
  "failed": 1,
  "clicks": 1,
  "replies": 1,
  "spend": 1,
  "costPerNotifiedOrder": 1,
  "medianMinutesToFirstUpdate": 1,
  "optOuts": 1,
  "shippedNotified": 1,
  "notifiedValue": 1,
  "totalValue": 1,
  "currencies": [
    "<string>"
  ],
  "codOrders": 1
}

Required scope: crm.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Query Parameters

days · integer

Required range: 0 < x <= 365

Response

200

application/json

OK

orders · integer · required

Required range: x >= 0

ordersWithPhone · integer · required

Required range: x >= 0

ordersNotified · integer · required

Required range: x >= 0

attempted · integer · required

Required range: x >= 0

delivered · integer · required

Required range: x >= 0

read · integer · required

Required range: x >= 0

failed · integer · required

Required range: x >= 0

clicks · integer · required

Required range: x >= 0

replies · integer · required

Required range: x >= 0

spend · number · required

Required range: x >= 0

costPerNotifiedOrder · number | null · required

Required range: x >= 0

medianMinutesToFirstUpdate · number | null · required

Required range: x >= 0

optOuts · integer · required

Required range: x >= 0

shippedNotified · integer · required

Required range: x >= 0

notifiedValue · number · required

Required range: x >= 0

totalValue · number · required

Required range: x >= 0

currencies · string[] · required

codOrders · integer · required

Required range: x >= 0