Skip to main content

Price All Ep

POST 
/v1/price/all

Prices As Of

Retrieves prices that are effective at the given date and time with optional filters. Must provide either as_of or last_change_date, but not both.

Required Scopes (ipd.r)

Request​

as_of: datetime
The date and time for which to retrieve effective prices.

last_change_date: datetime
The date and time for which to retrieve updated prices.

terminals: list[str] | None
A list of terminal names. Can be left empty.

suppliers: list[str] | None
A list of suppliers names. Can be left empty.

products: list[str] | None
A list of products names. Can be left empty.

price_types: list[str] | None
A list of price types. Supported price types are "rack", "contract", "index", "inventory", and "spot". Can be left empty.

product_groups: list[str] | None
A list of product groups. Supported product groups are "Gasoline", "Diesel", "Ethanol", and "BioDiesel". Can be left empty.


Response​

Returns a list of price objects with the following properties:

curve_id: str
Unique identifier for the price curve.

price_id: str
Unique identifier for the price entry.

city: str | None
The city associated with the price.

contract: str | None
The contract associated with the price.

product: str | None
The product name.

product_id: str
Unique identifier for the product.

supplier: str | None
The supplier name.

supplier_id: str
Unique identifier for the supplier.

counterparty: str | None
The counterparty (supply owner) name.

counterparty_id: str | None
Unique identifier for the counterparty (supply owner).

terminal: str | None
The terminal name.

terminal_id: str
Unique identifier for the terminal.

store_number: str | None
The store number (for delivered prices).

store_id: str | None
Unique identifier for the store (for delivered prices).

price_type: str
The type of price (rack, contract, index, inventory, or spot).

product_group: str | None
The product group.

price: float
The price value.

effective_from: datetime
The date and time from which the price is effective.

effective_to: datetime
The date and time until which the price is effective.

expire: datetime | None
The expiration date and time for the price.

disabled: bool
Indicates whether the price is disabled.

disabled_by: str | None
User who disabled the price.

disabled_until: datetime | None
The date and time until which the price is disabled.

disabled_reason: str | None
The reason for disabling the price.

updated_by: str | None
User who last updated the price.

updated_on: datetime | None
The date and time when the price was last updated.

extra_data: dict | None
Additional data associated with the price.

group_id: str | None
Unique identifier for the directive.

group_effective_cutover: datetime | None
The reset time for the directive. The time portion is used to determine when a directive resets every day.

group_effective_cutover_timezone: str | None
The timezone for the group effective cutover.

group_identifier: str | None
The group identifier for the directive.

group_name: str | None
The name of the directive.

min_constraint: float | None
The minimum constraint of the directive.

max_constraint: float | None
The maximum constraint of the directive.

Responses​

Successful Response

[
  {
    "curve_id": "string",
    "price_id": "string",
    "city": "string",
    "contract": "string",
    "product": "string",
    "product_id": "string",
    "supplier": "string",
    "supplier_id": "string",
    "counterparty": "string",
    "counterparty_id": "string",
    "terminal": "string",
    "terminal_id": "string",
    "store_number": "string",
    "store_id": "string",
    "price_type": "string",
    "product_group": "string",
    "price": 0,
    "effective_from": "2025-12-17T21:49:50.633Z",
    "effective_to": "2025-12-17T21:49:50.633Z",
    "expire": "2025-12-17T21:49:50.633Z",
    "disabled": false,
    "disabled_by": "string",
    "disabled_until": "2025-12-17T21:49:50.633Z",
    "disabled_reason": "string",
    "updated_by": "string",
    "updated_on": "2025-12-17T21:49:50.633Z",
    "extra_data": {},
    "group_id": "string",
    "group_effective_cutover": "2025-12-17T21:49:50.633Z",
    "group_effective_cutover_timezone": "string",
    "group_identifier": "string",
    "group_name": "string",
    "min_constraint": 0,
    "max_constraint": 0,
    "created_on": "2025-12-17T21:49:50.633Z",
    "net_or_gross_type": "Net",
    "contract_lifting_valuation_method": "TimeOfLifting",
    "outages": [
      {
        "id": "5eb7cf5a86d9755df3a6c593",
        "reason_code": "string",
        "notes": "string",
        "schedule_local": {
          "schedule_type": "recurring",
          "start_date": "2025-12-17T21:49:50.633Z",
          "end_date": "2025-12-17T21:49:50.633Z",
          "days": [
            {
              "day_of_week": "Sunday",
              "start_time": "string",
              "end_time": "string"
            }
          ]
        },
        "schedule_utc": {
          "schedule_type": "recurring",
          "start_date": "2025-12-17T21:49:50.633Z",
          "end_date": "2025-12-17T21:49:50.633Z",
          "days": [
            {
              "day_of_week": "Sunday",
              "start_time": "string",
              "end_time": "string"
            }
          ]
        },
        "terminal_name": "string",
        "terminal_id": "string",
        "timezone": "string",
        "product_group": "Gasoline",
        "product_name": "string",
        "product_id": "string",
        "supplier_name": "string",
        "supplier_id": "string",
        "price_type": "rack",
        "contract": "string",
        "supply_owner_id": "string",
        "supply_owner_name": "string",
        "updated_by": "string",
        "canceled": false,
        "status": "active",
        "is_bulk": true,
        "updated_on": "2025-12-17T21:49:50.633Z"
      }
    ]
  }
]
Loading...