Order status notifications API (v0)

Download OpenAPI specification:Download

Use these APIs to get, create and update notification options for order related events. Possible notifications are:

order_pending: Sent after the order was placed.
order_cancelled: Sent when the entire order is canceled.

Get order status notification options

Get the current tenant config value for notification options

Authorizations:

newStoreAccessToken

Responses

Response samples

200

Content type

application/json

{"value": {"push_notification_channel_type": "email",
"options": {"order_cancelled": ["push_notification",
"email"
],
"order_pending": ["email"
]
}
},
"updated_at": "2021-07-13T20:18:25Z"
}

Set notification options

Set the tenant config value for notification options

Authorizations:

newStoreAccessToken

Request Body schema: application/json

required

object

push_notification_channel_type	string Enum: "customer_uuid" "email" Push notification need a channel (type of addressing) for where to send notifications. That can be the internal customer identifier or their email.
required	object A map of enabled notifications and their respective channels.

Responses

Request samples

Payload

Content type

application/json

{"value": {"push_notification_channel_type": "email",
"options": {"order_cancelled": ["push_notification",
"email"
],
"order_pending": ["email"
]
}
}
}

Response samples

400
500

Content type

application/json

{"messages": ["string"
],
"request_id": "string"
}