Drop Save Ep

POST 
/v1/order/save_drop

Save Drop

Saves drop (tank stick readings) for an order and sends them to the destination system.

Required Scopes (order:save_drop)

Headers

Header	Type	Required	Description
X-Tenant-Name	str	Yes	Name of the origin tenant making the request
X-Dest-Tenant-Name	str	Yes	Name of the destination tenant that will receive the drop data
X-Origin-System-Name	str | None	No	Name of the origin system. If not provided, uses the tenant's primary system

Request

order: OrderKey
Identifies the order this drop belongs to. At least one field is required.

Show Child Attributes

origin_order_number: str | None = None
Order number from the origin system.

---

destination_order_number: int | None = None
Order number in the destination system.

---

order_id: str | None = None
ID of the order.

---

site: SiteMappingKey
The delivery site for this drop. At least one of mapping_id, source_name, source_id, or goid must be provided. If using mapping_id, source_name, or source_id, tank_id is required. If using goid, tank_goid is required.

Show Child Attributes

mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping. Requires tank_id to be set.

---

source_name: str | None = None
Display name of the site in the source system. Matched against the mapping's display_name field. Requires tank_id to be set.

---

source_id: str | None = None
Unique identifier of the site in the source system. Matched against the mapping's source_id field. Requires tank_id to be set.

---

goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided except tank_goid. Format: site_XXXXXX.

---

tank_id: str | None = None
Tank identifier at the site in the source system. Required when using mapping_id, source_name, or source_id. Max 10 characters.

---

tank_goid: str | None = None
Tank Gravitate Object ID. Required when using goid. Format: tank_XXXXXX. Max 50 characters.

---

mode: str
How to handle existing drops. "replace" overwrites all existing drops, "append" adds to existing.

---

details: list[DropDetailRequest]
List of drop measurement details. Each detail records tank stick readings before and after delivery.

Show Child Attributes

product: ProductMappingKey
Product being dropped. At least one of mapping_id, source_name, source_id, or goid must be provided.

Show Child Attributes

mapping_id: str | None = None
ID of the mapping record. Use when you have previously looked up or cached the mapping.

---

source_name: str | None = None
Display name of the product in the source system. Matched against the mapping's display_name field.

---

source_id: str | None = None
Unique identifier of the product in the source system. Matched against the mapping's source_id field.

---

goid: str | None = None
Gravitate Object ID - direct reference to master data. When set, no other fields can be provided. Format: product_XXXXXX.

---

quantity: float
Volume delivered in gallons.

---

tank_id: int | None = None
Tank number identifier at the site.

---

pre_drop_volume: float | None = None
Tank volume in gallons before delivery.

---

pre_drop_inches: float | None = None
Tank stick measurement in inches before delivery.

---

pre_drop_time: datetime | None = None
Time of pre-drop measurement.

---

post_drop_volume: float | None = None
Tank volume in gallons after delivery.

---

post_drop_inches: float | None = None
Tank stick measurement in inches after delivery.

---

post_drop_time: datetime | None = None
Time of post-drop measurement.

Response

status: str
Crossroads integration status. Each status represents a step in the integration pipeline.

Integration Stages

origin_mapped
The order has been received by crossroads and needs mapping to crossroads master data.

master_mapped
The order has been mapped to crossroads master data and needs mapping to the destination system.

destination_mapped
The order has been mapped to the destination system and is ready to be sent.

synced
The order has been successfully sent to the destination system.

error
An error occurred during processing. Check the message and log for details.

rejected
The order was rejected by the destination system. Check the message and log for details.

---

drop: CrossroadsDrop | None = None
The saved drop record.

Show Child Attributes

site: SiteMappingKey
Delivery site where the drop was made.

---

details: list[DropDetail]
Drop measurement details including tank stick readings.

---

message: str | None = None
Status message or error details.

---

log: CrossroadsLogV2 | None = None
Processing log entry.

Responses

200

Successful Response

422

Validation Error

application/json

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...