OfficeGest
Workshop/Service orders

List service orders

Returns paginated service orders with modern query parameters.

GET
/workshop/service-orders
AuthorizationBearer <token>

In: header

Query Parameters

number?string

Filter by service order number.

plate?string

Filter by vehicle plate.

customer_id?integer

Filter by customer id.

customer_name?string

Partial search on customer name.

delivery_name?string

Partial search on delivery name.

status?string

Filter by service order status.

status_in?string

Filter by multiple statuses (comma-separated, e.g. ABR,ESP,MAR).

status_not_in?string

Exclude service orders with these statuses (comma-separated, e.g. ANU,FAC).

awaiting_parts?boolean

Filter by awaiting parts flag (true or 1 = waiting for parts, false or 0 = not waiting).

awaiting_authorization?boolean

Filter by awaiting authorization flag (true or 1 = waiting for authorization, false or 0 = not waiting).

date_from?string

Start date filter.

Formatdate
date_to?string

End date filter.

Formatdate
employee_id?integer

Filter by employee id.

seller_id?integer

Filter by seller id.

vehicle_id?integer

Filter by vehicle internal id.

total?number

Filter by total value (supports operator arrays like total[gte]=100).

payment_method_code?string

Filter by payment method code.

type?string

Filter by document type code (tipo).

document_type?string

Filter by document type (tipodoc).

branch_number?integer

Filter by branch number.

search?string

Global search on number, plate, customer name, and delivery name.

sort?string

Sort field, prefixed with - for descending (e.g. -date). Ties are ordered by number.

limit?integer

Items per page. Default 50, maximum 250; a larger value is truncated to 250.

Default50
Range1 <= value <= 250
cursor?string

Opaque cursor taken from meta.next or meta.previous; omit it for the first page. A cursor that was changed, or that was issued for another sort, answers 422 INVALID_CURSOR. There are no page numbers: sending page answers 422.

Response Body

curl -X GET "https://og-tenant1.test:8003/api/v2/workshop/service-orders?number=string&plate=string&customer_id=0&customer_name=string&delivery_name=string&status=string&status_in=string&status_not_in=string&awaiting_parts=true&awaiting_authorization=true&date_from=2019-08-24&date_to=2019-08-24&employee_id=0&seller_id=0&vehicle_id=0&total=0&payment_method_code=string&type=string&document_type=string&branch_number=0&search=string&sort=string&limit=50&cursor=string"
{
  "data": [
    {
      "number": 0,
      "document_number": "string",
      "date": "string",
      "status": "string",
      "is_cancelled": true,
      "plate": "string",
      "customer_id": 0,
      "invoice_name": "string",
      "mechanic_id": 0,
      "department_id": 0,
      "priority": 0,
      "expected_delivery_date": "string",
      "km_counter": 0,
      "total": 0,
      "awaiting_parts": true,
      "awaiting_authorization": true,
      "system_entry_date": "string"
    }
  ],
  "meta": {
    "next": "string",
    "previous": "string",
    "has_more": true,
    "per_page": 50
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}
{
  "data": {
    "code": "VALIDATION_FAILED",
    "message": "The given data was invalid.",
    "errors": {
      "email": [
        "The email field is required."
      ]
    }
  },
  "meta": {
    "trace_id": "9f86d081884c7d659a2feaa0c55ad01568f3a1c2b4d5e"
  }
}