Send a notification

POST

/notifications/send

curl --request POST \
  --url https://acme.mykreezalid.com/api/v1/notifications/send \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "type": "new_order_customer", "object_id": 185423 }'

• Your marketplace's address. A marketplace with a custom domain must be called on that domain instead (https://developers.kreezalid.com/getting-started/base-urls/).

Sends one of the marketplace’s e-mails about an order: new_order_customer (order confirmation to the customer), new_order_supplier (new order to the vendor), order_accepted_customer, order_canceled_customer, order_canceled_supplier (cancellation, to the vendor), order_rejected_customer, order_shipping_fulfilment (shipment to the customer) and order_customer_confirmed (reception confirmed, to the vendor). object_id is the order’s identifier. Each call sends one e-mail: type takes a single value, so telling both the customer and the vendor takes one call per type, for instance order_canceled_customer then order_canceled_supplier for a cancellation.

Authorizations

• basic

Request Body^required

Media typeapplication/json

object

type

required

The notification to send, one per call

string

Allowed values: new_order_customer new_order_supplier order_accepted_customer order_canceled_customer order_canceled_supplier order_shipping_fulfilment order_rejected_customer order_customer_confirmed

object_id

required

Identifier of the order

integer

Example

{
  "type": "new_order_customer",
  "object_id": 185423
}

Responses

200

The notification has been sent

Media typeapplication/json

object

success

boolean

data

object

id

Identifier of the e-mail sent

integer

object_id

integer

content

object

subject

string

body

Body of the e-mail

string

created

YYYY-MM-DD HH:MM:SS

string

recipient

string

transport

string

type

Kind of e-mail sent

string

Example

{
  "success": true,
  "data": {
    "id": 234432,
    "object_id": 185423,
    "content": {
      "subject": "You have a new order"
    },
    "created": "2023-01-18 23:42:27",
    "recipient": "jane@example.com",
    "transport": "email"
  }
}

400

type or object_id is missing, the type is unknown or not available, or the notification could not be sent: error says why.

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Bad Request - Missing type parameter"
}

404

No order has this identifier.

Media typeapplication/json

object

success

boolean

error

string

Example

{
  "success": false,
  "error": "Bad Request - Missing type parameter"
}