List orders

List orders

Query Parameters

requestedFields string[]

Possible values: [CUSTOMER_IDENTIFIERS, VEHICLE_IDENTIFIERS, ORDER_IDENTIFIERS, PAYMENT_IDENTIFIERS]

getDetails boolean

application/json

Request Body required

orderUuidList string[]
customerUuidList string[]
vehicleUuidList string[]
orderStatus string[]
orderFilterLabels string[]
orderType string
dealerUuid string
openDateRequest object
from string
to string
closeDateRequest object
from string
to string
updatedDateRequest object
from string
to string
createdDateRequest object
from string
to string
departmentUuid string
userUuid string[]
sortField string

Possible values: [ORDER_NUMBER, AMOUNT, ORDER_DATE]

ordering string

Possible values: [ASC, DESC]

size string
pageNo string
orderNumberPrefix string

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

statusCode int32
orders object[]
Array [
dealerAssociateUuid string
dealerUuid string
dms string
Possible values: [ADP,0, Dealerbuilt,0, ReynoldsandReynolds,0, PBS,0, DealerTrack,0, InfinitiNet,0, UCS,0, AutoMate,0, myKaarmaAPI,0, Tekion,0]
orderNumber string
orderType string
description string
orderStatus string
dmsRawStatus string
isWaiter boolean
tagOrHat string
mileageText string
transportOption string
departmentType string
labourOpTypes string
payTypes string
id int64
uuid string
creatorAssociateUuid string
laborTypes string
dealerOrderStatusFilter string[]
invoiceUrl string
amount number
vehicle object
uuid string
vin string
make string
key string
model string
color string
licensePlate string
customer object
uuid string
key string
firstName string
lastName string
paymentInfo object
deliveryAmount number
paidAmount number
numberOfInvoices int32
readyROData string
isPaymentRequestSent boolean
isPaidOnline boolean
customerSignatureUrl string
isSuspicious boolean
dateInfo object
orderDate string
printDate string
closeDate string
updated_dt string
promiseTime string
created_dt string
dmsSyncDate string
transactions object[]
Array [
tenderDataId int64
transactionId int64
deviceId int64
transactionTypeId int64
transactionAmount number
ccNumber string
]
summary object[]
Array [
originalEstimate number
warrantyAmount number
salesTax number
laborTotal number
getcPAmount string
partsTotal number
orderStatus string
techniciansUuids string[]
jobCount int32
]
advisorDetails object
userUuid string
departmentUuid string
firstName string
lastName string
creatorDetails object
userUuid string
departmentUuid string
firstName string
lastName string
]
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "statusCode": 0,
  "orders": [
    {
      "dealerAssociateUuid": "string",
      "dealerUuid": "string",
      "dms": "ADP,0",
      "orderNumber": "string",
      "orderType": "string",
      "description": "string",
      "orderStatus": "string",
      "dmsRawStatus": "string",
      "isWaiter": true,
      "tagOrHat": "string",
      "mileageText": "string",
      "transportOption": "string",
      "departmentType": "string",
      "labourOpTypes": "string",
      "payTypes": "string",
      "id": 0,
      "uuid": "string",
      "creatorAssociateUuid": "string",
      "laborTypes": "string",
      "dealerOrderStatusFilter": [
        "string"
      ],
      "invoiceUrl": "string",
      "amount": 0,
      "vehicle": {
        "uuid": "string",
        "vin": "string",
        "make": "string",
        "key": "string",
        "model": "string",
        "color": "string",
        "licensePlate": "string"
      },
      "customer": {
        "uuid": "string",
        "key": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "paymentInfo": {
        "deliveryAmount": 0,
        "paidAmount": 0,
        "numberOfInvoices": 0,
        "readyROData": "string",
        "isPaymentRequestSent": true,
        "isPaidOnline": true,
        "customerSignatureUrl": "string",
        "isSuspicious": true
      },
      "dateInfo": {
        "orderDate": "string",
        "printDate": "string",
        "closeDate": "string",
        "updated_dt": "string",
        "promiseTime": "string",
        "created_dt": "string",
        "dmsSyncDate": "string"
      },
      "transactions": [
        {
          "tenderDataId": 0,
          "transactionId": 0,
          "deviceId": 0,
          "transactionTypeId": 0,
          "transactionAmount": 0,
          "ccNumber": "string"
        }
      ],
      "summary": [
        {
          "originalEstimate": 0,
          "warrantyAmount": 0,
          "salesTax": 0,
          "laborTotal": 0,
          "getcPAmount": "string",
          "partsTotal": 0,
          "orderStatus": "string",
          "techniciansUuids": [
            "string"
          ],
          "jobCount": 0
        }
      ],
      "advisorDetails": {
        "userUuid": "string",
        "departmentUuid": "string",
        "firstName": "string",
        "lastName": "string"
      },
      "creatorDetails": {
        "userUuid": "string",
        "departmentUuid": "string",
        "firstName": "string",
        "lastName": "string"
      }
    }
  ],
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

POST /listOrders

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/order/v2

Username

Password

requestedFields — query

CUSTOMER_IDENTIFIERSVEHICLE_IDENTIFIERSORDER_IDENTIFIERSPAYMENT_IDENTIFIERS

getDetails — query

---truefalse

Body required

{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}

curl / cURL

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

python / requests

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

go / native

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

nodejs / axios

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

ruby / Net::HTTP

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

csharp / RestSharp

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

php / cURL

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

java / OkHttp

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'

powershell / RestMethod

curl -L -X POST '/order/v2/listOrders' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "orderUuidList": [
    "string"
  ],
  "customerUuidList": [
    "string"
  ],
  "vehicleUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "orderFilterLabels": [
    "string"
  ],
  "orderType": "string",
  "dealerUuid": "string",
  "openDateRequest": {
    "from": "string",
    "to": "string"
  },
  "closeDateRequest": {
    "from": "string",
    "to": "string"
  },
  "updatedDateRequest": {
    "from": "string",
    "to": "string"
  },
  "createdDateRequest": {
    "from": "string",
    "to": "string"
  },
  "departmentUuid": "string",
  "userUuid": [
    "string"
  ],
  "sortField": "ORDER_NUMBER",
  "ordering": "ASC",
  "size": "string",
  "pageNo": "string",
  "orderNumberPrefix": "string"
}'