Skip to main content

Filter MykaarmaDealerOrders by request - PaymentDealerOrder + StandardOrderDTO​


ApiScope: payment.paymentdealerorder.read
API Scope Level: DepartmentScope
Path Parameters
    departmentUuid string required
Query Parameters
    fetchDealerOrderFromRedis boolean required

    Search for DealerOrder in Redis

    fetchInvoicesAndSignatureRequest boolean required

    Fetch invoices and signature request details for orders

Request Body required
    dealerOrderUuids string[]
    dealerUUID string
    startDate string
    endDate string
    userUUID string
    orderFilterLabel string
    orderType string
    sortField string
    sortOrder string
    pageNumber string
    pageSize string
    customerUuidList string[]
    orderStatus string[]
    exactOrderNumber string
Responses

OK

Schema
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
    errorDescription string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
    warningDescription string
  • ]
    • mykaarmaDealerOrderList object[]
  • Array [
    • paymentDealerOrderDTO object
    orderNumber string
    orderType string
    orderDate date-time
    paymentDealer object
    dealerUuid string
    name string
    paymentCustomer object
    customerUuid string
    firstName string
    middleName string
    lastName string
    company string
    paymentUser object
    id int64
    dealerAssociateUUID string
    userUUID string
    dealerDepartmentUUID string
    signatureRequestId int64
    departmentUuid string
    dealerOrderUuid string
    numberOfInvoices int32
    readyROData string
    paidAmount number
    amount number
    dealerOrderSyncDate date-time
    paidInKaarma boolean
    suspicious boolean
    paid boolean
    paymentRequestSent boolean
    paidOnline boolean
    standardOrderDTO object
    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
    isAuthorised boolean
    lastPaidInvoiceGuid string
    signedInvoiceUrl string
    invoices object[]
  • Array [
    • id int64
    guid string
    invoiceStatus string
    amount number
    invoiceDate date-time
    description string
    refundedAmount number
    paidDate date-time
    fileName string
    reminderMileage int64
    reminderDate date-time
    signatureFileName string
    paymentDeclines string
    invoiceAttributes object
    property name* string
    paymentDealer object
    dealerUuid string
    paymentDealerOrder object
    orderNumber string
    orderType string
    departmentUuid string
    dealerOrderUuid string
    paymentCustomer object
    customerUuid string
    paymentUser object
    id int64
    dealerAssociateUUID string
    userUUID string
    dealerDepartmentUUID string
  • ]
    • mykaarmaCustomer object
    errors object[]
  • Array [
    • errorCode int32
    errorTitle string
    errorMessage string
    errorDescription string
  • ]
    • warnings object[]
  • Array [
    • warningCode int32
    warningTitle string
    warningMessage string
    warningDescription string
  • ]
    • customer object
    guid string
    firstName string
    lastName string
    company string
    customerKey string
    preferredLocale string
    preferredCommunication string
    bestTimeToContact object
    startTime string
    endTime string
    isBusiness boolean
    availability int32
    addresses object[]
  • Array [
    • line1 string
    line2 string
    city string
    zip string
    addressType string
    type string

    Possible values: [COMMON, PRIMARY, BILLING, OTHER]

    country string
    updateTS date-time
    uuid string
    isValid boolean
    isPreferred boolean
    state string
  • ]
    • emails object[]
  • Array [
    • emailAddress string
    label string
    okToEmail boolean
    isPreferred boolean
    comments string
  • ]
    • phoneNumbers object[]
  • Array [
    • phoneNumber string
    label string
    okToCall boolean
    okToText boolean
    isPreferred boolean
    comments string
  • ]
    • vehicles object[]
  • Array [
    • uuid string
    model string
    trim string
    vin string
    engine string
    year string
    licensePlate string
    make string
    isValid boolean
    customerUuid string
  • ]
  • ]
POST /v4/departments/:departmentUuid/mykaarma-dealer-orders/searches

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL
/payment
Username
Password
departmentUuid — path required
fetchDealerOrderFromRedis — query required
fetchInvoicesAndSignatureRequest — query required
Body required
{

  "dealerOrderUuids": [

    "string"

  ],

  "dealerUUID": "string",

  "startDate": "string",

  "endDate": "string",

  "userUUID": "string",

  "orderFilterLabel": "string",

  "orderType": "string",

  "sortField": "string",

  "sortOrder": "string",

  "pageNumber": "string",

  "pageSize": "string",

  "customerUuidList": [

    "string"

  ],

  "orderStatus": [

    "string"

  ],

  "exactOrderNumber": "string"

}
curl / cURL
curl -L -X POST '/payment/v4/departments/:departmentUuid/mykaarma-dealer-orders/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
--data-raw '{
  "dealerOrderUuids": [
    "string"
  ],
  "dealerUUID": "string",
  "startDate": "string",
  "endDate": "string",
  "userUUID": "string",
  "orderFilterLabel": "string",
  "orderType": "string",
  "sortField": "string",
  "sortOrder": "string",
  "pageNumber": "string",
  "pageSize": "string",
  "customerUuidList": [
    "string"
  ],
  "orderStatus": [
    "string"
  ],
  "exactOrderNumber": "string"
}'