Skip to main content

Save Bol Ep

POST 
/v1/order/save_bol

Save BOL

Saves the details of a Bill of Lading (BOL) for an order.

Required Scopes (io.w)

Request​

order_id: str | None = None
Unique identifier for the order.

order_number: int | None = None
Order number for the order.

bol_number: str
Bill of Lading (BOL) number.

old_bol_number: str | None = None
The BOL's current number, when renaming an existing BOL. The BOL on the order is located by old_bol_number first and then rewritten to bol_number; any supplier-reconciliation match already referencing the old number is repointed to the new one. Omit it when creating a BOL or when the number is not changing — matching then falls back to bol_number.

terminal_id: str
Unique identifier for the terminal associated with the BOL.

bol_date: datetime
Timestamp of the BOL.

details: list[ExternalBOLRequest]
List of BOL details.

Show Child Attributes

supplier_id: str
Unique identifier for the supplier.

product_id: str
Unique identifier for the product.

contract: str | None = None
Contract number.

price_type: str | None = None
Deprecated: use price_types. When sent, it is tried before price_types.

price_types: list[str] = []
With price_type_preference, price types to try in order, else any priced type; S&D stores the type it chose, and a choice among several sets price_type_warning. Without it, the first entry must be priced exactly.

net_volume: float
Net volume.

gross_volume: float
Gross volume.

price_type_preference: bool = False
Treats each detail's price_types as an ordered preference, also on every later reprice of the BOL. Without it, each detail is priced at exactly its first price type, as before.
Intended use: integrators that do not carefully maintain price types in their own systems, which is most carriers.

Responses​

Successful Response

Loading...