DeliveryOrder.GetExisting

Try it in Swagger

Endpoint

Request Schema

Headers

Header Required Notes
X-Api-Key Required when tenant is not resolved by subdomain Resolves the tenant/customer database.
Authorization: Bearer {token} Required for authorized endpoints Get a token from Auth/Token or Session/Create.

Path Parameters

Field Type Required Notes
workOrder string Yes Exported Winserve messenger/delivery work order.

This endpoint does not accept a JSON request body.

Expected Response Schema

Status Codes

Status Notes
200 OK Returned when the final exported messenger/delivery work order exists for the tenant customer.
404 Not Found Final exported messenger/delivery work order was not found.

Success Body

Response type: ExistingDeliveryResponse

This endpoint resolves exported work orders only. See the Order Lifecycle guide for how draft web order ids become exported work order ids.

Field Type Required Max Length Notes
workOrder string Yes
customer string Yes
contactCode int? No
jobCategoryCode int? No
jobType string Yes Job type title.
status string Yes Completed when proof of delivery exists, otherwise milestone or Active.
milestone string Yes Current delivery milestone from the tenant Milestone table.
referenceNumber string Yes
plaintiff string Yes
defendant string Yes
claimNumber string Yes
adjuster int? No
billToAdjuster int? No
pickupName string Yes
pickupContact string Yes
pickupPhone string Yes
pickupDate DateTime? No
pickupTime DateTime? No
pickupStreet string Yes
pickupCity string Yes
pickupState string Yes
pickupZip string Yes
pickupInstructions string Yes
deliveryName string Yes
deliveryContact string Yes
deliveryPhone string Yes
deliveryStreet string Yes
deliveryCity string Yes
deliveryState string Yes
deliveryZip string Yes
deliveryDate DateTime? No
deliveryTime DateTime? No
deliveryInstructions string Yes
specialInstructions string Yes

Response Sample

{
  "workOrder": "C123456",
  "customer": "ABC Legal Services",
  "contactCode": 456,
  "jobCategoryCode": 123,
  "jobType": "Same Day Delivery",
  "status": "Completed",
  "milestone": "Dispatched",
  "referenceNumber": "REF-12345",
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "claimNumber": "CLM-12345",
  "adjuster": 123,
  "billToAdjuster": 123,
  "pickupName": "Records Department",
  "pickupContact": "Pam Pickup",
  "pickupPhone": "2135550100",
  "pickupDate": "2026-05-07T00:00:00",
  "pickupTime": "10:00 AM",
  "pickupStreet": "123 Main St",
  "pickupCity": "Los Angeles",
  "pickupState": "CA",
  "pickupZip": "90012",
  "pickupInstructions": "Use loading dock entrance."
}