Skip to main content

Additive All Ep

POST 
/v1/additive/all

Additive All

Retrieves every additive configured in Additive Management, active and inactive, sorted by name.

Required Scopes (ia.r)

Response​

id: str
Internal identifier unique to the additive. Matches the additive id returned on orders and drops.

name: str
Name unique to the additive.

billable: bool = False
Whether the additive is billed to the customer.

is_active: bool = True
Whether the additive can be selected for new orders. Inactive additives are still returned.

treat_ratios: list[AdditiveTreatRatio] = []
One treat ratio per product group. A group with no entry is not treated.

Show AdditiveTreatRatio Attributes

product_group: str
Product group the ratio applies to. All applies to every group without its own entry.

ratio: int
Gallons of product per gallon of additive (1:1500 is stored as 1500).

rounding_significance: float | None = None
Step the calculated additive volume is rounded to, in gallons. None means no rounding.

rounding_direction: str | None = None
round_up, round_down or round_nearest. Set together with rounding_significance.

extra_data: dict = {}
Any additional data the client manages on the additive, keyed by name.

Responses​

Successful Response

[
  {
    "id": "string",
    "name": "string",
    "billable": true,
    "is_active": true,
    "treat_ratios": [
      {
        "product_group": "Gasoline",
        "ratio": 0
      }
    ],
    "rounding_significance": 0,
    "rounding_direction": "round_up",
    "extra_data": {}
  }
]
Loading...