List order notification rules

List the order-status WhatsApp notification rules for a store connection

GET /crm/connections/{id}/order-notifications

List order notification rules

cURL

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

200

{
  "rules": [
    {
      "id": "<string>",
      "trigger": "ORDER_PLACED",
      "templateId": "<string>",
      "enabled": true,
      "delayMinutes": 10080,
      "templateStatus": "<string>",
      "templatePurpose": "<string>"
    }
  ],
  "recentOrderVolume": 1
}

Required scope: crm.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Response

200

application/json

OK

rules · object[] · required

Show child attributes

recentOrderVolume · integer · required

Required range: x >= 0