Runs a business action of one record. An action is not a field change: it moves the record to another state by its own rules. entities-schema shows which actions an object has and what each takes.
- Changes data: yes
- Who can use it: Your role’s right on that business action of the object, in the “Entities” group of the role.
What it is for
- Add a bid a carrier gave you by phone and close bidding. See Freight Procurement.
- Link two data model records. See Data models.
Example prompts
- “Demo: Carrier LLC called: 1,400 for TFY000000001. Add their bid.”
- “Close bidding on TFY000000001.”
- “Link contact Demo: Olena to the company Demo: Consignee LLC.”
Good to know
- Actions: a shipment has
transfer-ownership(hand a draft to another member of the brand, inputmember_user_id),add-bid(inputcarrier_idorcarrier_company_brand_id, andpricein the tender currency;carrier_idis thecatalog_idfromcarriers-list) andfinish-bidding(a tender with bids moves to “Awarding”; with automatic winner selection, to “Pre-Execution”; without bids, the brand’s tender rule decides, by default “Canceled”). A data model record haslink.
Reference
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
entity | string | yes | The object, as entities-list names it. |
operation | string | yes | The action, as entities-schema names it. |
id | string | yes | The record’s ID. |
input | object | no | The action’s input, as entities-schema describes it. |
reasoning | string | no | Why the action runs. |
Returns
The record after the action.
Errors
- “Operation not available.”
- A bid outside the tender’s rules: “The bid is above the maximum allowed for this tender. Allowed maximum: 1450.”
- Bidding is closed: “Tender is not open for bids.”
transfer-ownershipto someone outside the brand: “Target user is not a joined member of this brand.”add-bidwith both carrier IDs: “Pass exactly one of carrier_id or carrier_company_brand_id.”- A carrier outside your network and not invited: “The carrier is neither invited to this tender nor confirmed in this shipper's network.”
- “The bid must not exceed the starting price.”
- “The carrier is not in this shipper's network.”
- “The carrier is not confirmed in this shipper's network.”
- “Invalid value for price.”
- “Cannot link. This relation already exists.”
Invalid value for relationship_id. Relationships of …