ProcessOrder.Create

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: ProcessOrderRequest

Field Type Required Max Length Notes
webOrder string? No 20
theirFileNumber string Yes 35
plaintiff string Yes 600
defendant string Yes 600
courtCode string Conditional 12 Court code, not the court display name. Required unless court override is used. Use Court.Search, Court.GetAll, or Court.Get to retrieve valid court codes.
hearingDate DateTime? No
caseNumber string Yes 100
claimNumber string Conditional 50 Required when the bill-to customer is an insurance customer.
jobTypeCode int Yes Job type code from ProcessOrder.GetJobTypes.
adjusterCode int? Yes Canonical property name. Attorney code from Attorney.GetAll. Do not send adjuster, attorney, or attorneyCode. Required on Create; SaveDraft is lenient.
billToAdjusterCode int? No Bill-to attorney code from BillTo.GetAttorneys. Defaults to adjusterCode when omitted.
servee string Yes 400 Legacy single-servee field kept for backward compatibility. Ignored when Servees contains one or more items.
servees List<ProcessOrderServeeRequest> Yes Preferred V2 request shape for multiple servees. When provided, this takes precedence over legacy Servee and top-level Addresses. At least one servee is required. Legacy servee/addresses are still accepted by the API.
specialInstructions string Yes 500
documentsDescription string Yes 2000
addresses List<ProcessOrderAddressRequest> No Legacy top-level addresses for the single servee flow. Ignored when Servees is provided. Each address requires addressType.
export bool No
documents List<ProcessOrderDocumentRequest> Conditional Required when the selected job type requires uploads.

Type / Enum Values

Field Allowed Values Notes
courtCode code from Court.Search, Court.GetAll, or Court.Get Send the court code, not the court name/description.
jobTypeCode Integer from ProcessOrder.GetJobTypes Must be a code returned by the linked lookup. Invalid codes return 400 with a jobTypeCode validation error.
servees[].addresses[].addressType / addresses[].addressType 1 Business, 2 Home, 3 Other, 4 Government, 5 Not a physical address Required on Create. WinServe address category; missing/invalid values return 400.

Request Sample

{
  "webOrder": "W123456",
  "theirFileNumber": "REF-12345",
  "plaintiff": "Acme Corporation",
  "defendant": "John Doe",
  "courtCode": "LASC",
  "hearingDate": "2026-05-07T09:00:00",
  "caseNumber": "24STCV12345",
  "claimNumber": "CLM-12345",
  "jobTypeCode": 101,
  "adjusterCode": 123,
  "billToAdjusterCode": 456,
  "servee": "",
  "servees": [
    {
      "partyBeingServed": "John Doe",
      "partyIsAnEntity": false,
      "serviceInstructions": "Personal service only.",
      "advanceFees": false,
      "amount": null,
      "agent": "Registered Agent",
      "fileProofOfService": true,
      "addresses": [
        {
          "addressType": 2,
          "businessName": "Acme Corporation",
          "street": "123 Main St",
          "suite": "Suite 100",
          "city": "Los Angeles",
          "state": "CA",
          "zip": "90012",
          "phone": "2135550100",
          "instructions": "Leave with receptionist if available."
        }
      ]
    }
  ],
  "specialInstructions": "Rush service requested.",
  "documentsDescription": "Summons, complaint, civil case cover sheet",
  "addresses": [],
  "export": false,
  "documents": [
    {
      "name": "complaint.pdf",
      "id": "doc-123",
      "base64": "JVBERi0xLjQ="
    }
  ]
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
400 Bad Request Validation (including unknown jobTypeCode or missing/invalid address addressType), invalid request, invalid contact, or service/export failure.

Success Body

Response type: ExportedOrderResult

Field Type Notes
webOrderId string Draft web order id.
workOrderId string Primary / first generated work order id.
generatedWorkOrders GeneratedWorkOrderItem[] All work orders created by this export. For multi-servee process orders this includes one entry per servee (for example WP5038A, WP5038B) with the servee name.

See the Order Lifecycle guide for how draft web order ids become exported work order ids.

Response Sample

{
  "webOrderId": "W123456",
  "workOrderId": "WP5038A",
  "generatedWorkOrders": [
    {
      "workOrder": "WP5038A",
      "servee": "John Doe"
    },
    {
      "workOrder": "WP5038B",
      "servee": "Jane Doe"
    }
  ]
}