Skip to main content
POST
Create notification

Body

application/json

Data to create a new resource at /notifications/test-email

Request payload for sending a test notification email. Contains email configuration and recipient information for testing notification delivery.

severityLevel
enum<string>
required

The severity level. Possible values: INFO, WARNING, ERROR, URGENT, UPDATES

Available options:
INFO,
WARNING,
ERROR,
URGENT,
UPDATES
contents
object[]
required

Array of content items

status
enum<string>
required

The current status of the item

Available options:
DRAFT,
PUBLISHED,
DELETED
expiresAt
string<date-time>
required

The expires at timestamp

id
integer<int64>

The unique identifier for the id

hash
string

The hash value

message
string

Message content

lastOccurrence
string<date-time>

The last occurrence timestamp

sort
object

The

notificationType
enum<string>

The type or category of the notification

Available options:
UNKNOWN_SKU_IN_ORDER,
ORDER_CANCELLATION_FAILED,
AMAZON_PARTNERED_CARRIER,
INVALID_ORDER_IDENTIFIER,
MISSING_ORDER_INFORMATION,
COMPLETING_ORDER_FORCEFULLY,
ADDRESS_VERIFICATION_FAILED,
ORDERS_OUT_OF_STOCK,
RESTRICTIVE_SHIPMENT,
NEW_RETURN,
STOCK_BELOW_THRESHOLD,
MULTIPLE_STOCK_QUANT_IDS,
ITEM_NOT_STOCKED_AT_SHOP,
INBOUND_COMPLETED,
INBOUND_SHIPMENT_ARRIVED,
INBOUND_STATUS_CHANGE,
INBOUND_UNKNOWN_SKU,
INBOUND_INFORMATION_MISSING,
CUSTOMER_INQUIRY_UPDATE,
CUSTOMER_INQUIRY_RESOLVED,
INQUIRY_REMINDER,
CUSTOMER_INQUIRY_NEW_QUIVO,
CUSTOMER_INQUIRY_NEW,
SHOP_ERROR,
ITEM_NOT_FOUND,
SHOP_DEACTIVATED,
NOT_ENOUGH_ACCESS,
LOCATION_NOT_FOUND,
MULTIPLE_LOCATION_IDS,
NO_LOCATION_CONFIGURED,
IMPORTING_ORDERS_FAILED,
EXPORTING_INVENTORY_FAILED,
SHOP_NOT_CONFIGURED_PROPERLy,
SHOP_AVAILABLE,
NEW_RETURN_LINK_LABEL,
ITEM_EXPIRATION,
APPROVED_API_KEY_REQUEST,
EXPIRED_API_KEY,
DECLINED_API_KEY_REQUEST,
DELETED_API_KEY_REQUEST,
IMPORTANT_NOTIFICATION

The unique identifier for the legalentitys

subscriptionPackages
enum<string>[]

Package identifier or subscription package

Available options:
RISING_STAR,
STELLAR_EXPLORER,
FULFILLED_LEGEND,
WITHOUT_PACKAGE,
SEND_IT_YOURSELF,
CUSTOMIZED
userRoles
enum<string>[]

Array of user role

Available options:
ROLE_ADMIN,
ROLE_LOCAL_ADMIN,
ROLE_SELLER_ADMIN,
ROLE_USER,
ROLE_MOBILE_APP,
ROLE_WEBHOOK
usernames
string[]

The name of the users

sellerIds
integer<int64>[]

The unique identifier for the sellers

acknowledgements
object[]

Array of acknowledgement items

channel
enum<string>

The channel. Possible values: EMAIL, POP_UP, BOTH

Available options:
EMAIL,
POP_UP,
BOTH

Response

Bad request - the request payload is invalid, missing required fields, or contains invalid data.