CoworkerDeliveries
Get one CoworkerDelivery
Retrieve a single CoworkerDelivery record by its Id.
GET
A CoworkerDelivery tracks a delivery (mail, parcel, check, or other item) received on behalf of a customer at a location, along with its current processing status and the customer’s handling preference.
Each delivery records who it is for (
Deliveries can also have attached files — for example, a scanned copy of the contents (
CoworkerId or ContractContactId), what it is (DeliveryType), and how the customer wants it handled (HandlingPreference). Staff can then mark the delivery through its lifecycle — processed, collected, forwarded, scanned, recycled, shredded, or returned to sender — with corresponding timestamps.
Handling preferences control what happens to the delivery:
| HandlingPreference | Meaning |
|---|---|
| StoreForCollection | Hold for the customer to pick up |
| Forward | Forward to the customer’s address |
| OpenScanForward | Open, scan contents, then forward the original |
| OpenScanRecycle | Open, scan contents, then recycle the original |
| OpenScanShred | Open, scan contents, then shred the original |
| OpenScanStoreForCollection | Open, scan contents, then hold for collection |
| Recycle | Recycle the delivery |
| ReturnToSender | Return the delivery to the sender |
| Shred | Shred the delivery |
| DepositCheck | Deposit the enclosed check |
NewScannedFileDataUrl), a forwarding receipt (NewForwardedFileDataUrl), or a collection signature (NewSignatureUrl).
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerDelivery-Read role.Path Parameters
The Id of the CoworkerDelivery record to retrieve.
Code Examples
Response
200
Business Id.
Coworker Id.
Coworker Coworker Type.
Full name of the customer the delivery is for.
Email address of the customer the delivery is for.
Billing name of the customer the delivery is for.
Company name of the customer the delivery is for.
Team names the customer belongs to.
Contract Contact Id.
Full name of the contract contact the delivery is for.
Email address of the contract contact the delivery is for.
Short label or description identifying the delivery item.
Physical location where the delivery is being stored (e.g. mailroom shelf).
Name of the staff member who received the delivery.
Free-text notes about the delivery.
File Data File Name.
New File Data Url.
Clear File Data File.
Signature File Name.
New Signature Url.
Clear Signature File.
Scanned File Data File Name.
New Scanned File Data Url.
Clear Scanned File Data File.
Forwarded File Data File Name.
New Forwarded File Data Url.
Clear Forwarded File Data File.
Whether the delivery has been processed according to the handling preference.
Whether the customer has collected the delivery.
Whether the customer must sign upon collection.
Whether the customer has signed for the delivery.
Notified.
Date and time the customer collected the delivery.
Billed.
Type of delivery item (Mail, Parcel, Check, Publicity, or Other). See
eDeliveryType enum values: 0 = None, 1 = Mail, 2 = Parcel, 3 = Check, 4 = Publicity, 5 = Other.How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred).
Whether the enclosed check has been deposited.
Whether the delivery has been forwarded to the customer.
Whether the delivery contents have been scanned.
Whether the delivery has been recycled.
Whether the delivery has been shredded.
Whether the delivery is being held for customer collection.
Whether the delivery has been returned to sender.
Date and time the check was deposited.
Date and time the delivery was forwarded.
Date and time the delivery contents were scanned.
Date and time the delivery was recycled.
Date and time the delivery was shredded.
Date and time the delivery was placed in storage for collection.
Date and time the delivery was returned to sender.
Forwarding Address Unique Id.
Check Deposited Product Unique Id.
Forwarded Product Unique Id.
Scanned Product Unique Id.
Recycled Product Unique Id.
Shredded Product Unique Id.
Stored For Collection Product Unique Id.
Returned To Sender Product Unique Id.
Collected Product Unique Id.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response