Search order

Search order

Path Parameters

department_token string required

application/json

Request Body required

orderNumberPrefix string
toOrderDate string
fromOrderDate string
tagNumber string
orderUuid string
userUuid string
pageNo string
size string
orderType string
orderStatus string
orderFilterLabel string
vin string
customerUuid string
dateFilterType string

Possible values: [ORDER_DATE, CLOSE_DATE, CREATED_DATE, UPDATED_DATE]

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

statusCode int32
totalCount int64
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]
orders object[]
Array [
orderNumber string
orderUuid string
customer object
uuid string
firstName string
lastName string
company string
vehicle object
make string
model string
year string
vin string
orderStatus string
orderDate string
updatedDate string
advisorUuid string
advisorDetails object
userUuid string
departmentUuid string
firstName string
lastName string
tagNumber string
amount string
originalEstimate string
invoiceUrl string
promiseTime string
orderType string
technicianUuids string[]
]

{
  "statusCode": 0,
  "totalCount": 0,
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ],
  "orders": [
    {
      "orderNumber": "string",
      "orderUuid": "string",
      "customer": {
        "uuid": "string",
        "firstName": "string",
        "lastName": "string",
        "company": "string"
      },
      "vehicle": {
        "make": "string",
        "model": "string",
        "year": "string"
      },
      "vin": "string",
      "orderStatus": "string",
      "orderDate": "string",
      "updatedDate": "string",
      "advisorUuid": "string",
      "advisorDetails": {
        "userUuid": "string",
        "departmentUuid": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "tagNumber": "string",
      "amount": "string",
      "originalEstimate": "string",
      "invoiceUrl": "string",
      "promiseTime": "string",
      "orderType": "string",
      "technicianUuids": [
        "string"
      ]
    }
  ]
}

POST /department/:department_token/order/specificSearch

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/order/v2

Username

Password

department_token — path required

Body required

{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}

curl / cURL

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

python / requests

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

go / native

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

nodejs / axios

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

ruby / Net::HTTP

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

csharp / RestSharp

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

php / cURL

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

java / OkHttp

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'

powershell / RestMethod

curl -L -X POST '/order/v2/department/:department_token/order/specificSearch' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderNumberPrefix": "string",
  "toOrderDate": "string",
  "fromOrderDate": "string",
  "tagNumber": "string",
  "orderUuid": "string",
  "userUuid": "string",
  "pageNo": "string",
  "size": "string",
  "orderType": "string",
  "orderStatus": "string",
  "orderFilterLabel": "string",
  "vin": "string",
  "customerUuid": "string",
  "dateFilterType": "ORDER_DATE"
}'