Green Screens AI Pricing API is one of 10 APIs that Green Screens AI publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Pricing. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes
12 operations
across 6 paths,
and defines 54 schemas.
It is described by OpenAPI 3.2.0, at version 1.3.3.
Requests are made against a single base URL, https://connect.greenscreens.ai/prediction/v3.
The identity and technical contract details declared by the specification.
Pricing_RuleLane
object
Lane description object
2 properties
2 required
Pricing_PricingStatistics
object
Statistical pricing percentages based on your historical load data
3 properties
3 required
Pricing_FlatAdjustmentEffect
object
In the default interpretation this effect increases the buy cost by a flat amount of the specified currency to get the sell cost
2 properties
2 required
Pricing_CombinationRulesCalculation
object
Contains applicable combination rules and if possible a calculated targetSellCost
2 properties
1 required
Pricing_RuleRequestLocations
array
A list of locations that the rule is applicable to
Pricing_PercentageAdjustmentEffect
object
In the default interpretation this effect marks up the buy cost by some percentage to get the sell cost
1 property
1 required
Pricing_RequestValidationError
object
Request validation error
3 properties
2 required
Pricing_FloatRange
object
2 properties
Pricing_PricingPriorityRulesResponse
object
1 property
1 required
Pricing_Currency
string
Currency code in ISO 4217 format (three letter code, e.g. USD) If not provided, defaults to the currency set in the profile of currently authenticated user (or…
Pricing_RuleConditions
object
Conditions in which this rule is applicable. When multuple conditions are provided the rule is only applied if all of them are met
12 properties
Pricing_SuggestedPricing
object
The pricing that we suggest to be used on this lane. This is based off of all the other pricing options found and calculated using a priority algorithm. You ca…
2 properties
1 required
Pricing_Address
object
Location specified by country, city, state and zip code. Country is required Either city-state pair or zip code is required All four parameters can be passed t…
4 properties
1 required
Pricing_MileageDifferenceRange
object
Range of the stops count of the route to which the rule is applicable. At least one of the range boundaries has to be provided. If only one range boundary is p…
2 properties
Pricing_PriorityRuleEffectsInput
object
The effects this rule will have on the price calculation. Only one effect is allowed per rule
3 properties
Pricing_MatchingTimeRange
object
Matching time range to which the rule is applicable. At least one of the range boundaries has to be provided. If only one range boundary is provided, it means…
2 properties
Pricing_PricingMarketplaceMyBrokerPartnersResponse
object
A response with a list of brokers and their sell rates
2 properties
2 required
Pricing_PricingPriorityRuleRequest
object
6 properties
5 required
Pricing_DefaultPricingEffects
object
The default pricing effects that are to be used for the sell cost calculation if no other pricing options are found
3 properties
Pricing_PricingRuleGroup
string
Pricing rule group filter. If not specified, all rules are returned.
Pricing_LengthOfHaulRange
object
Range of the distance of the route to which the rule is applicable. At least one of the range boundaries has to be provided. If only one range boundary is prov…
2 properties
Pricing_DefaultPricingCalculation
object
Contains the default pricing effects and if possible a calculated targetSellCost
2 properties
1 required
Pricing_CombinationRuleEffectsInput
object
The effects this rule will have on the price calculation. Only one effect is allowed per rule
2 properties
Pricing_PricingCombinationRuleRequest
object
5 properties
4 required
Pricing_ConfidenceLevelRange
object
Confidence level range to which the rule is applicable. At least one of the range boundaries has to be provided. If only one range boundary is provided, it mea…
2 properties
Pricing_PricingMarketplaceMyBrokerPartnersRequest
object
Data needed for calculating sell costs for a given lane
10 properties
3 required
Pricing_Stop
object
Contains the stop information e.g. address
2 properties
2 required
Pricing_StopsCountRange
object
Range of the stops count of the route to which the rule is applicable. Stops count includes origin and destination i.e. route with one extra stop will have 3 s…
2 properties
Pricing_TransportType
string
Transport type If you would like Hotshot predictions, reach out to your CSM and DA. The model will not work properly without your hotshot data effectively filt…
Pricing_RuleLocation
object
A location that the rule is applicable to
6 properties
1 required
Pricing_Stops
array
A list of stops
Pricing_PricingMarketplaceMyBrokerPartnersResponseBroker
object
A broker rate descriptor
2 properties
2 required
Pricing_CombinationRule
object
Combination pricing rule
6 properties
5 required
Pricing_PricingCombinationRulesResponse
object
1 property
1 required
Pricing_RuleLocations
array
A list of locations that the rule is applicable to
Pricing_CombinationRuleEffects
object
The effects this rule will have on the price calculation
2 properties
Pricing_Error
object
A common api error object
2 properties
2 required
Pricing_FlatAdjustmentEffectInput
object
In the default interpretation this effect increases the buy cost by a flat amount of the specified currency to get the sell cost
2 properties
1 required
Pricing_PricingRequest
object
A set of fields used during pricing calculation
12 properties
Pricing_GeographicalAreaLane
string
Determines the size of the area around origin and destination points, that will be searched for the related data. CITY - narrow, city wide, area ZIP - narrow,…
Pricing_SetSellCostEffectInput
object
In the default interpretation this effect sets the specified amount of the specified currency as the final sell cost
2 properties
1 required
Pricing_PricingStatisticsCalculation
object
Contains historical pricing statistics and if possible a calculated targetSellCost
2 properties
1 required
Pricing_SetSellCostEffect
object
In the default interpretation this effect sets the specified amount of the specified currency as the final sell cost
2 properties
2 required
Pricing_IntegerRange
object
2 properties
Pricing_WeightRange
object
Weight range, of the cargo, to which the rule is applicable. At least one of the range boundaries has to be provided. If only one range boundary is provided, i…
2 properties
Pricing_PriorityRule
object
Priority pricing rule
7 properties
6 required
Pricing_TransitTimeRange
object
Transit time range to which the rule is applicable. At least one of the range boundaries has to be provided. If only one range boundary is provided, it means t…
2 properties
Pricing_PriorityRuleCalculation
object
Contains an applicable priority rule and if possible a calculated targetSellCost
2 properties
1 required
Pricing_PriorityRuleEffects
object
The effects this rule will have on the price calculation
3 properties
Pricing_Error422UnprocessableEntityMulti
object
3 properties
3 required
Pricing_RuleRequestConditions
object
Conditions in which this rule is applicable. When multuple conditions are provided the rule is only applied if all of them are met.
12 properties
Pricing_PricingResponse
object
A collection of all the pricing options found
8 properties
1 required
Pricing_RuleRequestLocation
object
Lane stop
5 properties
1 required
Pricing_RuleRequestLane
object
A lane that the rule is applicable to
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Green Screens AI publishes across the network.
