DeliveryOrder.GetDraft

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
webOrder string Yes Route segment.

This endpoint does not accept a JSON request body.

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
404 Not Found Requested resource or draft was not found.

Success Body

Response type: DeliveryOrderResponse

Field Type Required Max Length Notes
webOrder string Yes
referenceNumber string Yes
plaintiff string Yes
defendant string Yes
caseNumber string Yes
claimNumber string Yes
orderType int No
dateOrdered string Yes
dueDate string Yes
specialInstructions string Yes
documentsDescription string Yes
pickup DeliveryAddressRequest Yes
delivery DeliveryAddressRequest Yes
advanceFees bool No
documents List<DeliveryOrderDocumentResponse> No

Response Sample

{
  "webOrder": "W123456",
  "referenceNumber": "REF-12345",
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "caseNumber": "24STCV12345",
  "claimNumber": "CLM-12345",
  "orderType": 123,
  "dateOrdered": "2026-05-07T00:00:00",
  "dueDate": "2026-05-07T00:00:00",
  "specialInstructions": "Call before delivery.",
  "documentsDescription": "Summons and complaint",
  "pickup": {
    "carRequired": false,
    "name": "Jane Smith",
    "contact": "Maria Contact",
    "address": "123 Main St",
    "suite": "Suite 200",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90012",
    "phone": "2135550100",
    "date": "2026-05-07T00:00:00",
    "instructions": "Call before delivery."
  },
  "delivery": {
    "carRequired": false,
    "name": "Jane Smith",
    "contact": "Maria Contact",
    "address": "123 Main St",
    "suite": "Suite 200",
    "city": "Los Angeles",
    "state": "CA",
    "zip": "90012",
    "phone": "2135550100",
    "date": "2026-05-07T00:00:00",
    "instructions": "Call before delivery."
  },
  "advanceFees": false,
  "documents": [
    {
      "name": "summons.pdf",
      "id": "doc-123"
    }
  ]
}