Skip to main content

Best Price By Tank Ep

POST 
/v1/best_price_by_tank

Best Price by tank report

Gets the best overall price and the best contract price for every tank product at every store, and returns the results in a CSV. If both options are the same, it will be shown twice.

Required Scopes (i.r)

Response​

type: str
Best Overall or Best Contract.

Market: str
Market of the Store.

Market id: str
Market Identifier.

Site Number: str
Number of the site.

Site Name: str
Name of the site.

Site id: str
Site Identifier.

Tank ID: str
Identifier of the Tank the best price is for.

Tank Product: str
Product of the tank. The product the best price is for.

*Tank Product Id: str
Identifier of the Tank Product.

Tank Product Short Name: str
Short Name of the tank product.

*Tank Product Group: str
Product Group of the Tank Product, like Diesel or Gasoline.

*Carrier: str
If the market or tank has an assigned carrier, the carrier name.

*Carrier Id: str
If the market or tank has an assigned carrier, the carrier identifier.

*Terminal: str
Terminal Name of the terminal with the best price.

*Terminal Id: str
Terminal identifier of the terminal with the best price.

*Supplier: str
Supplier Name of the supplier with the best price.

*Supplier Id: str
Supplier identifier of the Supplier with the best price.

*Product: str
Best Price option product name. Could be different from Tank Product in the case of blends or alternate products.

*Product Id: str
Best Price option product identifier. Could be different from Tank Product in the case of blends or alternate products.

*Product Short Name: str
Best Price option product short name.

*Product Group: str
Best Price option product group.

*Blend Percentage: str
If Blend, the amount this product makes up of the full product. If 1, then the final product or a 100% blend.

*Price Type: str
Best Price option price type.

*Contract: str
If a contract price, the contract number.

*Curve Id: str
Best Price option price curve identifier.

*Price Id: str
Best Price option price identifier.

*Is directive: boolean
Indicated whether the price is part of a directive.

*Effective Start UTC: str
Best Price option price effective start date in UTC time.

*Effective End UTC: str
Best Price option price effective end date in UTC time.

*Product Price: float
Component product price.

*Freight Rate: float
Component freight rate.

*Loaded Miles: float
loaded miles of the supply

*Blend Rate: float
Price of the blend product. If not blend, same as Product Price.

*Total Price: float
Total cost of the component. Product Price + Freight Rate.

Responses​

Successful Response

Loading...