Retrieve a recipient's delivery status
Returns the latest carrier delivery status for one recipient on an order, identified by the recipient's first and last name, or by their address line.
Returns the latest carrier delivery status for one recipient on an order, identified by the recipient's first and last name, or by their address line.
Authorization
ApiKey In: header
Path Parameters
Query Parameters
Recipient first name (use with lastName).
Recipient last name (use with firstName).
Recipient address line (Address1 or Address2). Use instead of firstName/lastName.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/order/0/recipient-delivery-status"{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "firstName": "string", "lastName": "string", "address": "string", "status": "string", "updatedDate": "2019-08-24T14:15:22Z" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "firstName": "string", "lastName": "string", "address": "string", "status": "string", "updatedDate": "2019-08-24T14:15:22Z" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}"string"{ "authenticationSchemes": [ "string" ], "properties": { "items": { "property1": "string", "property2": "string" } }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "firstName": "string", "lastName": "string", "address": "string", "status": "string", "updatedDate": "2019-08-24T14:15:22Z" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}{ "profile": { "id": 0, "aadId": "1cbad290-069a-4527-be23-a0c144b5302d", "email": "string", "firstName": "string", "lastName": "string", "company": "string", "created": "2019-08-24T14:15:22Z", "shouldProcessQrCodes": true }, "payload": { "orderId": 0, "firstName": "string", "lastName": "string", "address": "string", "status": "string", "updatedDate": "2019-08-24T14:15:22Z" }, "errors": [ "string" ], "hasErrors": true, "warnings": [ "string" ], "hasWarnings": true, "metadata": { "property1": null, "property2": null }}Retrieve a recipient's proof GET
Renders and returns a proof PDF for one specific recipient on the order, substituting that recipient's mail-merge fields. The recipient must belong to the order.
Delete an order's recipients DELETE
Removes the specified recipients from an order. Pass the IDs of the recipients to remove in the request body.