OnTime REST API
OnTime REST API / PriceModifier Json Schema
In This Topic
    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 name 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.
    Price : number
    The calculated price of 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]
    Properties
    NameDescriptionData Type
    The unique identifier for this PriceModifier record.string
    The name of this PriceModifier.string
    The user-defined custom value assigned to this PriceModifier.number
    The percentage-based value used to determine the commissionable amount for this PriceModifier.number
    The calculated price of this PriceModifier.number
    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
    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]string
    See Also