Lectronz API Reference, Version 1
Messages
Resource
No description provided
This object has the following properties:
Unique identifier of the message.
Content of the message.
Optional attachment of the message, typically an image or a document.
See details
URL of the attachment, where the file can be downloaded.
Name of the attachment file.
MIME type of the attachment (e.g. "image/jpeg").
The type of the message.
Valid values are: customer_order_message, seller_order_message, refund_order_message.
The subject of the message. Currently, orders are the only supported subject.
See details
Unique identifier of the subject.
The type of the subject. Currently, the only supported type is "order".
API URL pointing to the subject (see the order API).
UTC creation date of the message in ISO 8601 format.
UTC timestamp of last update of the message in ISO 8601 format.
UTC timestamp of when the message was read by the recipient in ISO 8601 format. The value is null if the message has not been read yet.
Get a message
Request
Response body (object)
Response Body
details
Unique identifier of the message.
Content of the message.
Optional attachment of the message, typically an image or a document.
See details
URL of the attachment, where the file can be downloaded.
Name of the attachment file.
MIME type of the attachment (e.g. "image/jpeg").
The type of the message.
Valid values are: customer_order_message, seller_order_message, refund_order_message.
The subject of the message. Currently, orders are the only supported subject.
See details
Unique identifier of the subject.
The type of the subject. Currently, the only supported type is "order".
API URL pointing to the subject (see the order API).
UTC creation date of the message in ISO 8601 format.
UTC timestamp of last update of the message in ISO 8601 format.
UTC timestamp of when the message was read by the recipient in ISO 8601 format. The value is null if the message has not been read yet.
Mark a message as read
Mark a message as read. The message type must be set to: customer_order_message.
The subject of the message must be an order.
The response code will be 200 if the message was successfully marked as read.
Request
Response body (object)
Response Body
details
Unique identifier of the message.
Content of the message.
Optional attachment of the message, typically an image or a document.
See details
URL of the attachment, where the file can be downloaded.
Name of the attachment file.
MIME type of the attachment (e.g. "image/jpeg").
The type of the message.
Valid values are: customer_order_message, seller_order_message, refund_order_message.
The subject of the message. Currently, orders are the only supported subject.
See details
Unique identifier of the subject.
The type of the subject. Currently, the only supported type is "order".
API URL pointing to the subject (see the order API).
UTC creation date of the message in ISO 8601 format.
UTC timestamp of last update of the message in ISO 8601 format.
UTC timestamp of when the message was read by the recipient in ISO 8601 format. The value is null if the message has not been read yet.
Get a list of messages
Get a list of messages from newest to oldest. You can use the limit and offset query parameters to
paginate the results.
The list only provides minimal information about each message. To get the full details of a message, use
the id property to fetch the message individually. If you have a copy of the message locally, you can use
the updated_at property to check if the message has been updated since you last fetched it.
Request
Response body (object)
Response Body
details
No description provided
No description provided
The total number of messages.
No description provided
See details
Unique identifier of the message.
The type of the message.
Valid values are: customer_order_message, seller_order_message, refund_order_message.
UTC creation date of the message in ISO 8601 format.
UTC timestamp of last update of the message in ISO 8601 format.
Create a message.
Create a message for an order. The message type must be one of the following: seller_order_message.
The subject of the message must be an order.
It is currently not possible to add an attachment to a message.
The response code will be 201 if the message was successfully created.
Request
Request body (object)
Request Body
details
Unique identifier of the message.
Content of the message.
Optional attachment of the message, typically an image or a document.
See details
URL of the attachment, where the file can be downloaded.
Name of the attachment file.
MIME type of the attachment (e.g. "image/jpeg").
The type of the message.
Valid values are: customer_order_message, seller_order_message, refund_order_message.
The subject of the message. Currently, orders are the only supported subject.
See details
Unique identifier of the subject.
The type of the subject. Currently, the only supported type is "order".
API URL pointing to the subject (see the order API).
UTC creation date of the message in ISO 8601 format.
UTC timestamp of last update of the message in ISO 8601 format.
UTC timestamp of when the message was read by the recipient in ISO 8601 format. The value is null if the message has not been read yet.
Response body (object)
Response Body
details
Unique identifier of the message.
Content of the message.
Optional attachment of the message, typically an image or a document.
See details
URL of the attachment, where the file can be downloaded.
Name of the attachment file.
MIME type of the attachment (e.g. "image/jpeg").
The type of the message.
Valid values are: customer_order_message, seller_order_message, refund_order_message.
The subject of the message. Currently, orders are the only supported subject.
See details
Unique identifier of the subject.
The type of the subject. Currently, the only supported type is "order".
API URL pointing to the subject (see the order API).
UTC creation date of the message in ISO 8601 format.
UTC timestamp of last update of the message in ISO 8601 format.
UTC timestamp of when the message was read by the recipient in ISO 8601 format. The value is null if the message has not been read yet.