enotes/sendnote

Used to send an eNote. This API is used after enotes/fetch, which gives the Delivery ID and the eNote message thread.

POST https://www.parcelspace.com/enotes/sendnote.xml or https://www.parcelspace.com/enotes/sendnote.json

For use by a retailer or a carrier.

Variable Description type
key API key string
did Delivery ID integer
text Message content string
toconsumer Message intended for consumer? 1 for yes, 0 for no. integer (optional; please see below)
tocarrier Message intended for carrier? 1 for yes, 0 for no. integer (optional; please see below)
toretailer Message intended for retailer? 1 for yes, 0 for no. integer (optional; please see below)

* Fields are required except where marked optional.

The fields 'toconsumer', 'tocarrier' and 'toretailer' represent the recipients of an eNote message. It is not necessary to include the sender, as the 'to' field will always be marked for the sender. At least one recipient is required.

There are some further restrictions on sending eNotes:
i) eNote messages should only be sent by a retailer or a carrier to a consumer in response to an eNote message which has been received from a consumer. The reason for this is that if the consumer has not already sent a message, the consumer may not have access to eNotes and may never see your message.
ii) A retailer should only send an eNote message to a carrier which has their 'carriercanenote' flag set to 1; likewise a carrier should only send an eNote message to a retailer which has their 'retailercanenote' flag set to 1. This is their respective setting for accepting eNotes, and without this, any messages sent will not be received.