mail

Get mail status

Look up one mailpiece by mail_id with its delivery status and event history, refreshed from the print provider. Free. If the provider dropped the piece before printing, this call refunds its full charge to the balance, once.

get/v1/mail/{mail_id}

Request

  • Base URL: https://api.noerrands.com/c/mail
  • URL: https://api.noerrands.com/c/mail/v1/mail/{mail_id}
  • Auth: HTTP bearer

Path parameters

mail_idstring required

Response

Success.

mail_idstring required

Opaque id, "ml_...". Use it with get_mail_status.

kind'letter' | 'postcard' required
status'created' | 'processing' | 'in_transit' | 'delivered' | 'returned' | 'failed' | 'cancelled' required
created_atstring date-time required
expected_delivery_datestring date

YYYY-MM-DD.

credits_charged_centsinteger required
tracking_urlstring uri

Changes

No recorded changes to this operation across all 1 revision of this API.