DeliveryOrder.SaveDraft

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.

JSON Body

Body type: DeliveryOrderRequest

Field Type Required Max Length Notes
webOrder string? No 20
referenceNumber string Yes 35
plaintiff string Yes 600
defendant string Yes 600
caseNumber string Yes 100
claimNumber string Conditional 50 Required when the bill-to customer is an insurance customer.
orderType int Yes Order type code from DeliveryOrder.GetJobTypes.
dateOrdered DateTime? No
dueDate DateTime? No
specialInstructions string Yes 500
documentsDescription string Yes 2000
pickup DeliveryAddressRequest Yes Pickup name, address, city, and state are required.
delivery DeliveryAddressRequest Yes Delivery name, address, city, and state are required.
advanceFees bool No
export bool No
documents List<DeliveryOrderDocumentRequest> Conditional Required when the selected job type requires uploads.

Type / Enum Values

Field Allowed Values Notes
orderType Integer from DeliveryOrder.GetJobTypes Use the linked lookup endpoint to get valid delivery job types for the tenant.

Request Sample

{
  "webOrder": "string",
  "referenceNumber": "string",
  "plaintiff": "string",
  "defendant": "string",
  "caseNumber": "string",
  "claimNumber": "string",
  "orderType": 123,
  "dateOrdered": "2026-05-07T00:00:00",
  "dueDate": "2026-05-07T00:00:00",
  "specialInstructions": "string",
  "documentsDescription": "string",
  "pickup": {
    "carRequired": false,
    "name": "string",
    "contact": "string",
    "address": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "phone": "string",
    "date": "2026-05-07T00:00:00",
    "instructions": "string"
  },
  "delivery": {
    "carRequired": false,
    "name": "string",
    "contact": "string",
    "address": "string",
    "suite": "string",
    "city": "string",
    "state": "string",
    "zip": "string",
    "phone": "string",
    "date": "2026-05-07T00:00:00",
    "instructions": "string"
  },
  "advanceFees": false,
  "export": false,
  "documents": [
    {
      "name": "supporting-document.pdf",
      "id": "doc-123",
      "base64": "JVBERi0xLjQ="
    }
  ]
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.

Success Body

Response type: string

The response body is the saved draft web order id.

Response Sample

"W123456"