PriceModifier Json Schema

In This Topic

Description

Represents a comprehensive PriceModifier record within the OnTime API.

Overview

PriceModifier

Represents a comprehensive PriceModifier record within the OnTime API.

ID : string

The unique identifier for this PriceModifier record.

Name : string

The public display name of this PriceModifier.

InternalName : string

The internal name of this PriceModifier.

Description : string

The internal description of this PriceModifier.

CustomValue : number

The user-defined custom value assigned to this PriceModifier.

PercentCommissionable : number

The percentage-based value used to determine the commissionable amount for this PriceModifier.

FlatCompensation : number

A flat compensation that is applied to drivers for this PriceModifier.

PercentCompensation : number

A percentage-based compensation that is applied to drivers for this PriceModifier.

Price : number

The calculated price of this PriceModifier.

Notes : string

The internal notes for this PriceModifier.

Type : string

The pre-defined {OnTime.Extensions.SDK.PriceModifierBase.PriceModifierType} detailing the pricing calculation behavior of this PriceModifier. Available Values: [Other, SignatureCapture, CashOnDelivery, DistanceBasePrice, AdHocCharge, Tax]

Input : string

The pre-defined {OnTime.Extensions.SDK.PriceModifierBase.InputFieldType} detailing the field-specific behavior used when calculating the pricing of this PriceModifier. Available Values: [None, Weight, Quantity, Mileage, Dimensions, Custom, DeclaredValue, BasePrice, Height, Width, Depth, ZoneLookupTable, CollectionDuration, DeliveryDuration, VehicleType, PackageType]

Properties

Name	Description	Data Type
ID	The unique identifier for this PriceModifier record.	string
Name	The public display name of this PriceModifier.	string
InternalName	The internal name of this PriceModifier.	string
Description	The internal description of this PriceModifier.	string
CustomValue	The user-defined custom value assigned to this PriceModifier.	number
PercentCommissionable	The percentage-based value used to determine the commissionable amount for this PriceModifier.	number
FlatCompensation	A flat compensation that is applied to drivers for this PriceModifier.	number
PercentCompensation	A percentage-based compensation that is applied to drivers for this PriceModifier.	number
Price	The calculated price of this PriceModifier.	number
Notes	The internal notes for this PriceModifier.	string
Type	The pre-defined {OnTime.Extensions.SDK.PriceModifierBase.PriceModifierType} detailing the pricing calculation behavior of this PriceModifier. Available Values: [Other, SignatureCapture, CashOnDelivery, DistanceBasePrice, AdHocCharge, Tax]	string
Input	The pre-defined {OnTime.Extensions.SDK.PriceModifierBase.InputFieldType} detailing the field-specific behavior used when calculating the pricing of this PriceModifier. Available Values: [None, Weight, Quantity, Mileage, Dimensions, Custom, DeclaredValue, BasePrice, Height, Width, Depth, ZoneLookupTable, CollectionDuration, DeliveryDuration, VehicleType, PackageType]	string