⬆️Request and Response
Request to the API endpoint
Retrieves a list of orders that meet the specified criteria
POST
https://api.alephcrm.com/v2/orders/{orderId}/messages
Query Parameters
Parameters details
API_KEY
The API_KEY that was provided.
accountId
The Alephee account ID of the shipping label you are trying to get.
orderId
Alephee ID to identify the order. The Alephee order number. It is not the marketplace order number.
message
Text message to be sent to the customer. Max size = 350 characters. This is available only on certain message options. See below.
messageOptions
Message reason for the message to be sent. Available values are:
1 = REQUEST_VARIANTS (Request product variation information) When this option is selected, an automatic text message template is sent to the customer. Can not use a custom free text message (the “message” parameter). This reason is valid only for orders with allowed shipping modes: “cross docking” and “drop off” (refer to the LogisticType property on the GET orders endpoint). The following table illustrate several countries and text messages templates combinations:
2 = REQUEST_BILLING_INFO (Request billing information) When this option is selected, an automatic text message template is sent to the customer asking for billing information. Can not use a custom free text message (the “message” parameter). The following table illustrate several countries and text messages combinations:
3 = SEND_INVOICE_LINK (Send invoice link) When this option is selected, it is possible to send with message including the link of the generated invoice. Can use a custom free text message (the “message” parameter). Valid only in México.
4 = OTHER (Others, free field) When this option is selected, I can send any message to the customer, it's a free field. Can use a custom free text message (the “message” parameter).
5 = DELIVERY_PROMISE (Inform delivery promise) When this option is selected, you can inform the delivery promise. Can use a custom free text message (the “message” parameter). This reason is valid only for orders with allowed shipping modes: “Flex” (refer to the LogisticType property on the GET orders endpoint). A brief summary of available messaging reasons by country:
Also, it is possible to send messages with an attached document. There are two ways to attach a document:
1. With form-data parameters:
file
Document file to attach into an order.
2. With a JSON body including a base64-encoded file:
fileBase64
The document to attach into an order. Must be an encoded base64 string of the document´s full content.
documentName
Document name, only for base64 encoded files
documentExtension
Document extension, only for base64 encoded files
Last updated