get List of Special Orders matching a criteria

get List of Special Orders matching a criteria

Path Parameters

department_token string required

application/json

Request Body required

pageNo string
size string
orderType string[]

Possible values: [RepairOrder, PartsOrder, ManualOrder]

sorUuids string[]
toOpenDate string
fromOpenDate string
dealerAssociateUuid string
statuses string[]

Possible values: [ALL, SPECIAL_ORDER_INTIATED, PARTS_ORDERED, PARTS_PARTIALLY_ARRIVED, READY_FOR_SERVICE, READY_FOR_SERVICE_REQUEST, READY_FOR_PARTS_PICKUP, SERVICE_REQUEST_SENT, PARTS_PICKUP_REQUEST_SENT, VEHICLE_IN_SERVICE, PARTS_PICKED_UP, SERVICE_REMINDER_SENT, PARTS_PICKUP_REMINDER_SENT, SERVICE_FINAL_REMINDER_SENT, PARTS_PICKUP_FINAL_REMINDER_SENT, PART_ARRIVED, CLOSED]

sortableField string

Possible values: [SPECIAL_ORDER_NUMBER, CUSTOMER_NAME, STATUS]

sortOrder string

Possible values: [ASC, DESC]

orderNumber string

Responses

• 200

---

OK

*/*

Schema

Example (from schema)

---

Schema

statusCode int32
specialOrderList object[]
Array [
specialOrderHeader object
id int64
orderNumber string
orderStatus string
isVehicleOnSite boolean
linkingOrderNumber string
openDate date-time
closeDate date-time
saleType string
saleAmount string
depositAmount string
balanceDueAmount string
freightAmount string
miscAmount string
taxableAmount string
taxAmount string
handlingCharge string
costAmount string
totalAmount string
taxOverride boolean
makeCode string
paymentType string
printDate date-time
voidDate date-time
estimateNumber int32
priceLevel string
priceLevelOverride string
description string
userUuid string
orderUserUuid string
userFullName string
orderUserFullName string
uuid string
partOrderNumber string
orderType string
Possible values: [RepairOrder, PartsOrder, ManualOrder]
dealerUuid string
customerGuid string
customerName string
dealerOrderUuid string
linkingType boolean
specialOrderDetails object[]
Array [
id int64
orderNumber string
dmsStatus string
partsNumber string
partsOrderNumber string
partMake string
costAtOrder string
transactionCode string
pack string
packFactor string
specialOrderDescription string
specialOrderType string
shipperNumber string
dateOfContact date-time
quantityReceived int64
quantityPendigReceipt int64
quantityOrdered int64
availableOnHandQuantity int64
preSoldQuantity int64
currentOnHandQuantity int64
requestedOnHandQuantity int64
partsOrderDate date-time
partsReceivedDate date-time
uuid string
userUuid string
userFullName string
description string
closeDate date-time
priority string
dealerUuid string
]
]
totalResults int64
errors object[]
Array [
errorCode string
errorDescription string
errorUID string
]
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "statusCode": 0,
  "specialOrderList": [
    {
      "specialOrderHeader": {
        "id": 0,
        "orderNumber": "string",
        "orderStatus": "string",
        "isVehicleOnSite": true,
        "linkingOrderNumber": "string",
        "openDate": "2024-12-31T19:51:39.885Z",
        "closeDate": "2024-12-31T19:51:39.885Z",
        "saleType": "string",
        "saleAmount": "string",
        "depositAmount": "string",
        "balanceDueAmount": "string",
        "freightAmount": "string",
        "miscAmount": "string",
        "taxableAmount": "string",
        "taxAmount": "string",
        "handlingCharge": "string",
        "costAmount": "string",
        "totalAmount": "string",
        "taxOverride": true,
        "makeCode": "string",
        "paymentType": "string",
        "printDate": "2024-12-31T19:51:39.885Z",
        "voidDate": "2024-12-31T19:51:39.885Z",
        "estimateNumber": 0,
        "priceLevel": "string",
        "priceLevelOverride": "string",
        "description": "string",
        "userUuid": "string",
        "orderUserUuid": "string",
        "userFullName": "string",
        "orderUserFullName": "string",
        "uuid": "string",
        "partOrderNumber": "string",
        "orderType": "RepairOrder",
        "dealerUuid": "string",
        "customerGuid": "string",
        "customerName": "string",
        "dealerOrderUuid": "string",
        "linkingType": true
      },
      "specialOrderDetails": [
        {
          "id": 0,
          "orderNumber": "string",
          "dmsStatus": "string",
          "partsNumber": "string",
          "partsOrderNumber": "string",
          "partMake": "string",
          "costAtOrder": "string",
          "transactionCode": "string",
          "pack": "string",
          "packFactor": "string",
          "specialOrderDescription": "string",
          "specialOrderType": "string",
          "shipperNumber": "string",
          "dateOfContact": "2024-12-31T19:51:39.885Z",
          "quantityReceived": 0,
          "quantityPendigReceipt": 0,
          "quantityOrdered": 0,
          "availableOnHandQuantity": 0,
          "preSoldQuantity": 0,
          "currentOnHandQuantity": 0,
          "requestedOnHandQuantity": 0,
          "partsOrderDate": "2024-12-31T19:51:39.885Z",
          "partsReceivedDate": "2024-12-31T19:51:39.885Z",
          "uuid": "string",
          "userUuid": "string",
          "userFullName": "string",
          "description": "string",
          "closeDate": "2024-12-31T19:51:39.885Z",
          "priority": "string",
          "dealerUuid": "string"
        }
      ]
    }
  ],
  "totalResults": 0,
  "errors": [
    {
      "errorCode": "string",
      "errorDescription": "string",
      "errorUID": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Loading...