Auto Service Schema

Solink tags video to Auto Service transactions based on a unique place and time pairing. Time is absolute and must adhere to the convention defined here.

Required Object Fields

Field	Type	Description
`dataType`	String	Must be set to "auto-service" to specify which data type the current event is.
`schemaVersion`	String	Must be set to "1" to specify which version of the schema is being used for this event (e.g. "1", "2", etc).
`startTime`	String	Start time of the transaction in either Unix time format milliseconds or ISO-8601 compliant format.
`endTime`	String	End time of the transaction in either Unix time format milliseconds or ISO-8601 compliant format.
`locationId`	String	Unique location identifier within the customer's set of locations.
`dataSourceId`	String	A unique identifier representing the source of the transaction data, typically a point-of-sale (POS) register, kiosk, or fuel pump within the retail environment. This ID helps differentiate where each transaction originated within the store.
`transactionId`	String	Unique ID which identifies the transaction in the originating POS software.
`status`	String	Describes the type of transaction. For example: "SALE" or "VOID". Supported Enum values: 'sale', 'void', 'refund', 'return', 'discount', 'exchange', 'cancel', 'no sale', 'post void', 'other', 'rebate'.
`items`	Array	The list of items, actions or events processed in the transaction.

Optional Object Fields

Field	Type	Description
`employeeId`	String	Unique employee id to identify the employee processing the transaction.
`employeeName`	String	The name of the employee processing the transaction.
`customerId`	String	The unique id to identify the customer being served.
`licensePlate`	String	Vehicle license plate number
`vehicleYear`	String	Year of the vehicle being serviced
`vehicleMake`	String	Make of the vehicle being serviced
`vehicleModel`	String	Model of the vehicle being serviced
`vehicleMileage`	String	Current mileage of the vehicle
`workOrderNumber`	String	Work order or service order number
`workOrderStartedTime`	String	When work on the vehicle started
`workOrderCompletedTime`	String	When work on the vehicle was completed
`workOrderCreatedTime`	String	When the work order was created
`workOrderFinalizedTime`	String	When the work order was finalized
`fleetAccountNumber`	String	Fleet account number for fleet customers
`customerType`	String	Type of customer (e.g., individual, fleet, commercial)

Required Item Object Fields

Field	Type	Description
`time`	String	Start time of the transaction in either Unix time format milliseconds or ISO-8601 compliant format.
`quantity`	Number	Quantity of the item.
`description`	String	Description of the item.
`unitPrice`	Number	Per unit price of the item.
`type`	String	May be one of the following allowed values: "SALE": Item sold at list price. "MODIFIER": Item modified with/without corresponding price modifications. "SALE_OVERRIDE": Item sale price was overridden by the employee. Final override price is recorded in unitPrice "OVERRIDE_MODIFIER": Override item modified with/without corresponding price modifications "DISCOUNT": A discount was applied to the transaction. "DISCOUNT_MODIFIER": The discount was modified with/without corresponding price modifications. "RETURN": Item was returned. "RETURN_MODIFIER": Returned item modified with/without corresponding price modifications. "RETURN_DISCOUNT": Returned item discount. "RETURN_DISCOUNT_MODIFIER": Returned item discount modifier. "PAYMENT": Payment applied to the transaction "REFUND": Refund payment previously applied to the transaction "CHANGE_DUE": Change due to the customer for a cash payment tendered > transaction total "TAX": Tax to be applied to the transaction "REFUND_TAX ": Refund tax previously applied to the transaction "OTHER_CHARGES": Other charges associated with the transaction "REFUND_OTHER_CHARGES": Refund other charges previously applied to the transaction "GRATUITY": Gratuity offered by the customer "VOID": Item entry voided. "VOID_MODIFIER": Item modifier entry voided/cancelled. "VOID_DISCOUNT": Item discount entry voided/cancelled. "VOID_RETURN": Item returned entry voided/cancelled "VOID_PAYMENT": Payment entry voided/cancelled "VOID_CHANGE_DUE": Change due entry voided/cancelled "VOID_REFUND": Refund payment voided/cancelled

Optional Item Object Fields

Field	Type	Description
`cardNumberLast4`	String	For credit/debit/gift card payment/refund/void. Last four digits of the card number.
`sku`	String	SKU or other unique item identifier.
`category`	String	Used to track Item Category

JSON Example

{
  "dataType": "auto-service",
  "schemaVersion": "1",
  "startTime": "2024-01-15T09:30:00Z",
  "endTime": "2024-01-15T11:45:00Z",
  "dataSourceId": "pos-001",
  "locationId": "location-123",
  "transactionId": "txn-456789",
  "employeeId": "emp-001",
  "employeeName": "John Smith",
  "status": "sale",
  "customerId": "cust-789",

  "licensePlate": "ABC123",
  "vehicleYear": "2020",
  "vehicleMake": "Toyota",
  "vehicleModel": "Camry",
  "vehicleMileage": "45000",
  "workOrderNumber": "WO-2024-001",
  "workOrderStartedTime": "2024-01-15T09:30:00Z",
  "workOrderCompletedTime": "2024-01-15T11:30:00Z",
  "workOrderCreatedTime": "2024-01-15T09:00:00Z",
  "workOrderFinalizedTime": "2024-01-15T11:45:00Z",
  "customerType": "individual",

  "items": [
    {
      "type": "SALE",
      "quantity": 1,
      "description": "Oil Change Service",
      "unitPrice": 29.99,
      "time": "2024-01-15T09:30:00Z",
      "sku": "OIL-CHANGE-001",
      "category": "Maintenance"
    },
    {
      "type": "SALE",
      "quantity": 1,
      "description": "Air Filter Replacement",
      "unitPrice": 15.99,
      "time": "2024-01-15T10:15:00Z",
      "sku": "AIR-FILTER-001",
      "category": "Parts"
    },
    {
      "type": "TAX",
      "description": "Sales Tax",
      "unitPrice": 3.68,
      "time": "2024-01-15T11:30:00Z"
    },
    {
      "type": "PAYMENT",
      "description": "Credit Card",
      "unitPrice": 49.66,
      "cardNumberLast4": "1234",
      "time": "2024-01-15T11:45:00Z"
    }
  ]
}