OrderExport.Export

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

Field Type Required Max Length Notes
orderType string Yes
webOrderId string Yes

Type / Enum Values

Field Allowed Values Notes
orderType Delivery Exports a delivery draft.
orderType Investigation Exports an investigation draft.
orderType Court Exports a court draft.
orderType Process Exports a process draft.
orderType FileAndServe Exports a file-and-serve draft.
orderType CountyRecording, County_Recording Exports a county-recording draft.
orderType PhotoCopy, Photo_Copy, Copy, X Exports a photocopy draft to WinCopy CWorkOrder tables.

webOrderId is the draft web order id returned by create/save draft endpoints, such as W123456. See the Order Lifecycle guide for the full draft-to-work-order flow.

Request Sample

{
  "orderType": "Court",
  "webOrderId": "W123456"
}

Expected Response Schema

Status Codes

Status Notes
200 OK Returned by the controller for this operation.
400 Bad Request Validation, invalid request, invalid contact, or service/export failure.

Success Body

Response type: OrderExportResponse

Field Type Max Length Notes
webOrderId string? Draft web order id.
workOrderId string? Primary / first generated work order id.
generatedWorkOrders GeneratedWorkOrderItem[] All work orders created by this export (process multi-servee and file-and-serve can return more than one).
errorMessage string? Present on failure responses.

Response Sample

{
  "webOrderId": "W123456",
  "workOrderId": "C123456",
  "generatedWorkOrders": [
    {
      "workOrder": "C123456",
      "servee": null
    }
  ],
  "errorMessage": null
}