Sales order messages

API reference › Sales › Sales orders

The conversation with the customer on an order: its participants and the emails and text messages sent to them.

5 operations

• POSTAdd a participant to an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participantParticipants are the people who can receive an order's messages: contacts of the customer, or guests with just an email address.
• GETList the messages of an order/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/messageReturns the conversation with the customer on a sales order or quote, oldest first, with each message's attachments.
• GETList the participants of an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participantParticipants are the people who can receive an order's messages: contacts of the customer, or guests with just an email address.
• POSTSend a message to the customer/v2/api/store/{team_slug}/v2/sales_order/{hash_id}/messageSends a message about a published sales order or quote to its participants, by email or text message, and saves it in the order's conversation.
• PATCHRemove every participant from an order/v1/api/store/{team_slug}/sales_order/{hash_id}/participant/clearRemoves all participants of a sales order.

Legacy and internal (2)

Prefer the operations above. Legacy operations name their replacement; internal ones are built for YoPrint's own apps.

• GETList the messages of an order (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/messageReturns the same conversation as the v2 list.
• POSTSend a message to the customer (v1)Legacy · deprecated/v1/api/store/{team_slug}/sales_order/{hash_id}/messageSends a message like the v2 operation, with the same body, but it also accepts drafts.