@chrt-inc/typescript-sdk 1.929.0 → 1.930.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/Client.js +2 -2
- package/dist/cjs/api/resources/shipping/client/Client.d.ts +0 -3
- package/dist/cjs/api/resources/shipping/client/Client.js +10 -15
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.d.ts +6 -3
- package/dist/cjs/api/resources/shipping/resources/flights/client/Client.js +19 -11
- package/dist/cjs/api/resources/shipping/resources/flights/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/flights/client/index.js +15 -0
- package/dist/cjs/api/resources/shipping/resources/flights/client/requests/FlightsGetFlightTrackForFlightLegV1Request.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/flights/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shipping/resources/index.d.ts +1 -2
- package/dist/cjs/api/resources/shipping/resources/index.js +2 -3
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.d.ts +103 -0
- package/dist/cjs/api/resources/shipping/resources/orders/client/Client.js +442 -0
- package/dist/{esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request.d.mts → cjs/api/resources/shipping/resources/orders/client/requests/OrdersAddCoordinatorTaskListToApplyAtOrderStagingV1Request.d.ts} +1 -1
- package/dist/{esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersDraftDeleteManyReq.d.mts → cjs/api/resources/shipping/resources/orders/client/requests/OrdersDeleteManyDraftsReq.d.ts} +1 -1
- package/dist/{esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/SetTaskGroupOrderingDraftReq.d.mts → cjs/api/resources/shipping/resources/orders/client/requests/OrdersTaskGroupOrderingReq.d.ts} +2 -2
- package/dist/cjs/api/resources/shipping/resources/orders/{resources/drafts/client/requests/OrdersDraftUpdateReq.d.ts → client/requests/OrdersUpdateDraftReq.d.ts} +2 -2
- package/dist/cjs/api/resources/shipping/resources/orders/client/requests/index.d.ts +4 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/cargo/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/cargo/client/Client.js +59 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.ts +0 -109
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/Client.js +0 -452
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersOpenDraftReq.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/index.d.ts +0 -4
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/index.js +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.d.ts +13 -0
- package/dist/cjs/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.js +59 -0
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.d.ts +3 -2
- package/dist/cjs/api/resources/tracking/resources/sessions/client/Client.js +11 -7
- package/dist/cjs/api/resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.d.ts +4 -1
- package/dist/cjs/api/types/OrderLimitedForProvider1.d.ts +0 -1
- package/dist/cjs/api/types/OrderLimitedForShipper1.d.ts +0 -1
- package/dist/cjs/api/types/{OrdersDraftDeleteManyRes.d.ts → OrdersDeleteManyDraftsRes.d.ts} +1 -1
- package/dist/cjs/api/types/{OrdersDraftUpdateRes.d.ts → OrdersUpdateDraftRes.d.ts} +1 -1
- package/dist/cjs/api/types/index.d.ts +2 -9
- package/dist/cjs/api/types/index.js +2 -9
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/Client.mjs +2 -2
- package/dist/esm/api/resources/shipping/client/Client.d.mts +0 -3
- package/dist/esm/api/resources/shipping/client/Client.mjs +0 -5
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.d.mts +6 -3
- package/dist/esm/api/resources/shipping/resources/flights/client/Client.mjs +19 -11
- package/dist/esm/api/resources/shipping/resources/flights/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/flights/client/index.mjs +1 -1
- package/dist/esm/api/resources/shipping/resources/flights/client/requests/FlightsGetFlightTrackForFlightLegV1Request.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/flights/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shipping/resources/index.d.mts +1 -2
- package/dist/esm/api/resources/shipping/resources/index.mjs +1 -2
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.d.mts +103 -0
- package/dist/esm/api/resources/shipping/resources/orders/client/Client.mjs +442 -0
- package/dist/{cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request.d.ts → esm/api/resources/shipping/resources/orders/client/requests/OrdersAddCoordinatorTaskListToApplyAtOrderStagingV1Request.d.mts} +1 -1
- package/dist/{cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersDraftDeleteManyReq.d.ts → esm/api/resources/shipping/resources/orders/client/requests/OrdersDeleteManyDraftsReq.d.mts} +1 -1
- package/dist/{cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/SetTaskGroupOrderingDraftReq.d.ts → esm/api/resources/shipping/resources/orders/client/requests/OrdersTaskGroupOrderingReq.d.mts} +2 -2
- package/dist/esm/api/resources/shipping/resources/orders/{resources/drafts/client/requests/OrdersDraftUpdateReq.d.mts → client/requests/OrdersUpdateDraftReq.d.mts} +2 -2
- package/dist/esm/api/resources/shipping/resources/orders/client/requests/index.d.mts +4 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/cargo/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/cargo/client/Client.mjs +59 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/Client.d.mts +0 -109
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/Client.mjs +0 -452
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/OrdersOpenDraftReq.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/index.d.mts +0 -4
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.d.mts +13 -0
- package/dist/esm/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.mjs +59 -0
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.d.mts +3 -2
- package/dist/esm/api/resources/tracking/resources/sessions/client/Client.mjs +11 -7
- package/dist/esm/api/resources/tracking/resources/sessions/client/requests/SessionsFlightTrackV1Request.d.mts +4 -1
- package/dist/esm/api/types/OrderLimitedForProvider1.d.mts +0 -1
- package/dist/esm/api/types/OrderLimitedForShipper1.d.mts +0 -1
- package/dist/esm/api/types/{OrdersDraftDeleteManyRes.d.mts → OrdersDeleteManyDraftsRes.d.mts} +1 -1
- package/dist/esm/api/types/{OrdersDraftUpdateRes.d.mts → OrdersUpdateDraftRes.d.mts} +1 -1
- package/dist/esm/api/types/index.d.mts +2 -9
- package/dist/esm/api/types/index.mjs +2 -9
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +326 -935
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.d.ts +0 -182
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/Client.js +0 -720
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/index.js +0 -17
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.ts +0 -33
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.ts +0 -37
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.d.ts +0 -14
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.ts +0 -80
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/client/requests/index.d.ts +0 -4
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orderTemplates/index.js +0 -17
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/client/requests/SetTaskGroupOrderingDraftReq.js +0 -5
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/Client.d.ts +0 -46
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/Client.js +0 -127
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/index.js +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/index.js +0 -17
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/index.d.ts +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/index.js +0 -38
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/Client.d.ts +0 -46
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/Client.js +0 -127
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/index.js +0 -2
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/index.d.ts +0 -1
- package/dist/cjs/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/index.js +0 -17
- package/dist/cjs/api/types/Order1.d.ts +0 -43
- package/dist/cjs/api/types/Order1.js +0 -5
- package/dist/cjs/api/types/OrderTemplate1.d.ts +0 -35
- package/dist/cjs/api/types/OrderTemplate1.js +0 -5
- package/dist/cjs/api/types/OrderTemplateExpanded1.d.ts +0 -16
- package/dist/cjs/api/types/OrderTemplateExpanded1.js +0 -5
- package/dist/cjs/api/types/OrderTemplateListRes.d.ts +0 -8
- package/dist/cjs/api/types/OrderTemplateListRes.js +0 -5
- package/dist/cjs/api/types/OrderTemplateOrgInfo1.d.ts +0 -10
- package/dist/cjs/api/types/OrderTemplateOrgInfo1.js +0 -5
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.d.ts +0 -13
- package/dist/cjs/api/types/OrderTemplateReferenceColumnEnum1.js +0 -15
- package/dist/cjs/api/types/OrderTemplateSortByEnum.d.ts +0 -11
- package/dist/cjs/api/types/OrderTemplateSortByEnum.js +0 -13
- package/dist/cjs/api/types/OrdersDraftDeleteManyRes.js +0 -5
- package/dist/cjs/api/types/OrdersDraftUpdateRes.js +0 -5
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.d.mts +0 -182
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/Client.mjs +0 -683
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientCreate1.d.mts +0 -33
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateClientUpdate1.d.mts +0 -37
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.d.mts +0 -14
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/OrderTemplatesListV1Request.d.mts +0 -80
- package/dist/esm/api/resources/shipping/resources/orderTemplates/client/requests/index.d.mts +0 -4
- package/dist/esm/api/resources/shipping/resources/orderTemplates/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orderTemplates/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/client/requests/SetTaskGroupOrderingDraftReq.mjs +0 -4
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/Client.d.mts +0 -46
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/Client.mjs +0 -90
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/index.d.mts +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/index.mjs +0 -2
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/Client.d.mts +0 -46
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/Client.mjs +0 -90
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/client/index.mjs +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/index.d.mts +0 -1
- package/dist/esm/api/resources/shipping/resources/orders/resources/drafts/resources/taskGroup/index.mjs +0 -1
- package/dist/esm/api/types/Order1.d.mts +0 -43
- package/dist/esm/api/types/Order1.mjs +0 -4
- package/dist/esm/api/types/OrderTemplate1.d.mts +0 -35
- package/dist/esm/api/types/OrderTemplate1.mjs +0 -4
- package/dist/esm/api/types/OrderTemplateExpanded1.d.mts +0 -16
- package/dist/esm/api/types/OrderTemplateExpanded1.mjs +0 -4
- package/dist/esm/api/types/OrderTemplateListRes.d.mts +0 -8
- package/dist/esm/api/types/OrderTemplateListRes.mjs +0 -4
- package/dist/esm/api/types/OrderTemplateOrgInfo1.d.mts +0 -10
- package/dist/esm/api/types/OrderTemplateOrgInfo1.mjs +0 -4
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.d.mts +0 -13
- package/dist/esm/api/types/OrderTemplateReferenceColumnEnum1.mjs +0 -12
- package/dist/esm/api/types/OrderTemplateSortByEnum.d.mts +0 -11
- package/dist/esm/api/types/OrderTemplateSortByEnum.mjs +0 -10
- package/dist/esm/api/types/OrdersDraftDeleteManyRes.mjs +0 -4
- package/dist/esm/api/types/OrdersDraftUpdateRes.mjs +0 -4
- /package/dist/cjs/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplateClientCreate1.js → flights/client/requests/FlightsGetFlightTrackForFlightLegV1Request.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{orderTemplates → flights}/client/requests/index.js +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplateClientUpdate1.js → orders/client/requests/OrdersAddCoordinatorTaskListToApplyAtOrderStagingV1Request.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.js → orders/client/requests/OrdersDeleteManyDraftsReq.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplatesListV1Request.js → orders/client/requests/OrdersTaskGroupOrderingReq.js} +0 -0
- /package/dist/cjs/api/resources/shipping/resources/orders/{resources/drafts/client/requests/DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request.js → client/requests/OrdersUpdateDraftReq.js} +0 -0
- /package/dist/cjs/api/{resources/shipping/resources/orders/resources/drafts/client/requests/OrdersDraftDeleteManyReq.js → types/OrdersDeleteManyDraftsRes.js} +0 -0
- /package/dist/cjs/api/{resources/shipping/resources/orders/resources/drafts/client/requests/OrdersDraftUpdateReq.js → types/OrdersUpdateDraftRes.js} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplateClientCreate1.mjs → flights/client/requests/FlightsGetFlightTrackForFlightLegV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orderTemplates → flights}/client/requests/index.mjs +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplateClientUpdate1.mjs → orders/client/requests/OrdersAddCoordinatorTaskListToApplyAtOrderStagingV1Request.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplateRemoveReferenceReq.mjs → orders/client/requests/OrdersDeleteManyDraftsReq.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/{orderTemplates/client/requests/OrderTemplatesListV1Request.mjs → orders/client/requests/OrdersTaskGroupOrderingReq.mjs} +0 -0
- /package/dist/esm/api/resources/shipping/resources/orders/{resources/drafts/client/requests/DraftsAddCoordinatorTaskListToApplyAtOrderStagingV1Request.mjs → client/requests/OrdersUpdateDraftReq.mjs} +0 -0
- /package/dist/esm/api/{resources/shipping/resources/orders/resources/drafts/client/requests/OrdersDraftDeleteManyReq.mjs → types/OrdersDeleteManyDraftsRes.mjs} +0 -0
- /package/dist/esm/api/{resources/shipping/resources/orders/resources/drafts/client/requests/OrdersDraftUpdateReq.mjs → types/OrdersUpdateDraftRes.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -15856,7 +15856,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
15856
15856
|
</dl>
|
|
15857
15857
|
</details>
|
|
15858
15858
|
|
|
15859
|
-
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightTrackForFlightLegV1</a>(flightLegId) -> Chrt.FlightTrackRes</code></summary>
|
|
15859
|
+
<details><summary><code>client.shipping.flights.<a href="/src/api/resources/shipping/resources/flights/client/Client.ts">getFlightTrackForFlightLegV1</a>(flightLegId, { ...params }) -> Chrt.FlightTrackRes</code></summary>
|
|
15860
15860
|
<dl>
|
|
15861
15861
|
<dd>
|
|
15862
15862
|
|
|
@@ -15868,7 +15868,7 @@ await client.shipping.flights.getFlightStatusForFlightLegV1("flight_leg_id");
|
|
|
15868
15868
|
<dl>
|
|
15869
15869
|
<dd>
|
|
15870
15870
|
|
|
15871
|
-
Returns the Cirium
|
|
15871
|
+
Returns the raw Cirium positional track for a flight leg; pass force_refresh=true to bypass the cache. | authz_personas=[driver_for_executor, coordinator_org_operators, executor_org_operators, order_executor_org_operators, shipper_org_operators] | () -> (FlightTrackRes)
|
|
15872
15872
|
|
|
15873
15873
|
</dd>
|
|
15874
15874
|
</dl>
|
|
@@ -15884,7 +15884,9 @@ Returns the Cirium-sourced positional track for a flight leg — the live breadc
|
|
|
15884
15884
|
<dd>
|
|
15885
15885
|
|
|
15886
15886
|
```typescript
|
|
15887
|
-
await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id"
|
|
15887
|
+
await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id", {
|
|
15888
|
+
force_refresh: true,
|
|
15889
|
+
});
|
|
15888
15890
|
```
|
|
15889
15891
|
|
|
15890
15892
|
</dd>
|
|
@@ -15908,6 +15910,14 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
15908
15910
|
<dl>
|
|
15909
15911
|
<dd>
|
|
15910
15912
|
|
|
15913
|
+
**request:** `Chrt.shipping.FlightsGetFlightTrackForFlightLegV1Request`
|
|
15914
|
+
|
|
15915
|
+
</dd>
|
|
15916
|
+
</dl>
|
|
15917
|
+
|
|
15918
|
+
<dl>
|
|
15919
|
+
<dd>
|
|
15920
|
+
|
|
15911
15921
|
**requestOptions:** `Flights.RequestOptions`
|
|
15912
15922
|
|
|
15913
15923
|
</dd>
|
|
@@ -15919,9 +15929,9 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
15919
15929
|
</dl>
|
|
15920
15930
|
</details>
|
|
15921
15931
|
|
|
15922
|
-
## Shipping
|
|
15932
|
+
## Shipping OrderTemplatesNew
|
|
15923
15933
|
|
|
15924
|
-
<details><summary><code>client.shipping.
|
|
15934
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">postArchiveV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
15925
15935
|
<dl>
|
|
15926
15936
|
<dd>
|
|
15927
15937
|
|
|
@@ -15933,7 +15943,7 @@ await client.shipping.flights.getFlightTrackForFlightLegV1("flight_leg_id");
|
|
|
15933
15943
|
<dl>
|
|
15934
15944
|
<dd>
|
|
15935
15945
|
|
|
15936
|
-
Archives an order template by
|
|
15946
|
+
Archives an order template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
|
|
15937
15947
|
|
|
15938
15948
|
</dd>
|
|
15939
15949
|
</dl>
|
|
@@ -15949,7 +15959,7 @@ Archives an order template by setting archived_at_timestamp. | authz: min_org_ro
|
|
|
15949
15959
|
<dd>
|
|
15950
15960
|
|
|
15951
15961
|
```typescript
|
|
15952
|
-
await client.shipping.
|
|
15962
|
+
await client.shipping.orderTemplatesNew.postArchiveV1("order_template_id");
|
|
15953
15963
|
```
|
|
15954
15964
|
|
|
15955
15965
|
</dd>
|
|
@@ -15973,7 +15983,7 @@ await client.shipping.orderTemplates.archiveV1("order_template_id");
|
|
|
15973
15983
|
<dl>
|
|
15974
15984
|
<dd>
|
|
15975
15985
|
|
|
15976
|
-
**requestOptions:** `
|
|
15986
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
15977
15987
|
|
|
15978
15988
|
</dd>
|
|
15979
15989
|
</dl>
|
|
@@ -15984,7 +15994,7 @@ await client.shipping.orderTemplates.archiveV1("order_template_id");
|
|
|
15984
15994
|
</dl>
|
|
15985
15995
|
</details>
|
|
15986
15996
|
|
|
15987
|
-
<details><summary><code>client.shipping.
|
|
15997
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">putReplaceCoreV1</a>(orderTemplateId, { ...params }) -> Chrt.OrderTemplateNew1</code></summary>
|
|
15988
15998
|
<dl>
|
|
15989
15999
|
<dd>
|
|
15990
16000
|
|
|
@@ -15996,7 +16006,7 @@ await client.shipping.orderTemplates.archiveV1("order_template_id");
|
|
|
15996
16006
|
<dl>
|
|
15997
16007
|
<dd>
|
|
15998
16008
|
|
|
15999
|
-
|
|
16009
|
+
Atomically replaces an active order template core. | authz: min_org_role=operator | (OrderTemplateNewCore1) -> (OrderTemplateNew1)
|
|
16000
16010
|
|
|
16001
16011
|
</dd>
|
|
16002
16012
|
</dl>
|
|
@@ -16012,7 +16022,9 @@ Retrieves an order template with resolved references, recent orders, and total o
|
|
|
16012
16022
|
<dd>
|
|
16013
16023
|
|
|
16014
16024
|
```typescript
|
|
16015
|
-
await client.shipping.
|
|
16025
|
+
await client.shipping.orderTemplatesNew.putReplaceCoreV1("order_template_id", {
|
|
16026
|
+
schema_version: 1,
|
|
16027
|
+
});
|
|
16016
16028
|
```
|
|
16017
16029
|
|
|
16018
16030
|
</dd>
|
|
@@ -16036,7 +16048,15 @@ await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
|
16036
16048
|
<dl>
|
|
16037
16049
|
<dd>
|
|
16038
16050
|
|
|
16039
|
-
**
|
|
16051
|
+
**request:** `Chrt.OrderTemplateNewCore1`
|
|
16052
|
+
|
|
16053
|
+
</dd>
|
|
16054
|
+
</dl>
|
|
16055
|
+
|
|
16056
|
+
<dl>
|
|
16057
|
+
<dd>
|
|
16058
|
+
|
|
16059
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16040
16060
|
|
|
16041
16061
|
</dd>
|
|
16042
16062
|
</dl>
|
|
@@ -16047,7 +16067,7 @@ await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
|
16047
16067
|
</dl>
|
|
16048
16068
|
</details>
|
|
16049
16069
|
|
|
16050
|
-
<details><summary><code>client.shipping.
|
|
16070
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">resolveDateparserV1</a>({ ...params }) -> Chrt.OrderTemplateNewDateparserResolveRes</code></summary>
|
|
16051
16071
|
<dl>
|
|
16052
16072
|
<dd>
|
|
16053
16073
|
|
|
@@ -16059,7 +16079,7 @@ await client.shipping.orderTemplates.getExpandedByIdV1("order_template_id");
|
|
|
16059
16079
|
<dl>
|
|
16060
16080
|
<dd>
|
|
16061
16081
|
|
|
16062
|
-
|
|
16082
|
+
Validates a natural-language date string and resolves it to a UTC timestamp. | authz: min_org_role=operator | (OrderTemplateNewDateparserResolveReq) -> (OrderTemplateNewDateparserResolveRes)
|
|
16063
16083
|
|
|
16064
16084
|
</dd>
|
|
16065
16085
|
</dl>
|
|
@@ -16075,32 +16095,9 @@ Lists order templates for the caller's organization with filtering, sorting, pag
|
|
|
16075
16095
|
<dd>
|
|
16076
16096
|
|
|
16077
16097
|
```typescript
|
|
16078
|
-
await client.shipping.
|
|
16079
|
-
|
|
16080
|
-
|
|
16081
|
-
page: 1,
|
|
16082
|
-
page_size: 1,
|
|
16083
|
-
search: "search",
|
|
16084
|
-
filter_archived: true,
|
|
16085
|
-
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16086
|
-
filter_off_chrt_reference_id_str: "filter_off_chrt_reference_id_str",
|
|
16087
|
-
filter_shipper_org_id: "filter_shipper_org_id",
|
|
16088
|
-
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
16089
|
-
filter_coordinator_org_id: "filter_coordinator_org_id",
|
|
16090
|
-
filter_department_id: "filter_department_id",
|
|
16091
|
-
filter_coordinator_label: "filter_coordinator_label",
|
|
16092
|
-
filter_driver_id: "filter_driver_id",
|
|
16093
|
-
filter_contact_id: "filter_contact_id",
|
|
16094
|
-
filter_task_lists_to_apply_at_order_creation_task_list_id:
|
|
16095
|
-
"filter_task_lists_to_apply_at_order_creation_task_list_id",
|
|
16096
|
-
filter_task_lists_to_apply_at_order_staging_task_list_id:
|
|
16097
|
-
"filter_task_lists_to_apply_at_order_staging_task_list_id",
|
|
16098
|
-
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16099
|
-
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16100
|
-
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16101
|
-
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16102
|
-
filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16103
|
-
filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16098
|
+
await client.shipping.orderTemplatesNew.resolveDateparserV1({
|
|
16099
|
+
dateparser_str: "dateparser_str",
|
|
16100
|
+
time_zone_name: "America/New_York",
|
|
16104
16101
|
});
|
|
16105
16102
|
```
|
|
16106
16103
|
|
|
@@ -16117,7 +16114,7 @@ await client.shipping.orderTemplates.listV1({
|
|
|
16117
16114
|
<dl>
|
|
16118
16115
|
<dd>
|
|
16119
16116
|
|
|
16120
|
-
**request:** `Chrt.shipping.
|
|
16117
|
+
**request:** `Chrt.shipping.OrderTemplateNewDateparserResolveReq`
|
|
16121
16118
|
|
|
16122
16119
|
</dd>
|
|
16123
16120
|
</dl>
|
|
@@ -16125,7 +16122,7 @@ await client.shipping.orderTemplates.listV1({
|
|
|
16125
16122
|
<dl>
|
|
16126
16123
|
<dd>
|
|
16127
16124
|
|
|
16128
|
-
**requestOptions:** `
|
|
16125
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16129
16126
|
|
|
16130
16127
|
</dd>
|
|
16131
16128
|
</dl>
|
|
@@ -16136,7 +16133,7 @@ await client.shipping.orderTemplates.listV1({
|
|
|
16136
16133
|
</dl>
|
|
16137
16134
|
</details>
|
|
16138
16135
|
|
|
16139
|
-
<details><summary><code>client.shipping.
|
|
16136
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OrderTemplateNewListRes</code></summary>
|
|
16140
16137
|
<dl>
|
|
16141
16138
|
<dd>
|
|
16142
16139
|
|
|
@@ -16148,7 +16145,7 @@ await client.shipping.orderTemplates.listV1({
|
|
|
16148
16145
|
<dl>
|
|
16149
16146
|
<dd>
|
|
16150
16147
|
|
|
16151
|
-
|
|
16148
|
+
Lists order templates with filtering, sorting, pagination, full-text search, and party/account expansion. | authz: min_org_role=operator | () -> (OrderTemplateNewListRes)
|
|
16152
16149
|
|
|
16153
16150
|
</dd>
|
|
16154
16151
|
</dl>
|
|
@@ -16164,8 +16161,24 @@ Removes a (possibly dangling) reference id from a template column. | authz: min_
|
|
|
16164
16161
|
<dd>
|
|
16165
16162
|
|
|
16166
16163
|
```typescript
|
|
16167
|
-
await client.shipping.
|
|
16168
|
-
|
|
16164
|
+
await client.shipping.orderTemplatesNew.listV1({
|
|
16165
|
+
sort_by: "created_at_timestamp",
|
|
16166
|
+
sort_order: "asc",
|
|
16167
|
+
page: 1,
|
|
16168
|
+
page_size: 1,
|
|
16169
|
+
search: "search",
|
|
16170
|
+
filter_archived: true,
|
|
16171
|
+
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16172
|
+
filter_executor_org_id: "filter_executor_org_id",
|
|
16173
|
+
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
16174
|
+
filter_shipper_org_id: "filter_shipper_org_id",
|
|
16175
|
+
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
16176
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16177
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16178
|
+
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16179
|
+
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16180
|
+
filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16181
|
+
filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16169
16182
|
});
|
|
16170
16183
|
```
|
|
16171
16184
|
|
|
@@ -16182,15 +16195,7 @@ await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
|
|
|
16182
16195
|
<dl>
|
|
16183
16196
|
<dd>
|
|
16184
16197
|
|
|
16185
|
-
**
|
|
16186
|
-
|
|
16187
|
-
</dd>
|
|
16188
|
-
</dl>
|
|
16189
|
-
|
|
16190
|
-
<dl>
|
|
16191
|
-
<dd>
|
|
16192
|
-
|
|
16193
|
-
**request:** `Chrt.shipping.OrderTemplateRemoveReferenceReq`
|
|
16198
|
+
**request:** `Chrt.shipping.OrderTemplatesNewListV1Request`
|
|
16194
16199
|
|
|
16195
16200
|
</dd>
|
|
16196
16201
|
</dl>
|
|
@@ -16198,7 +16203,7 @@ await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
|
|
|
16198
16203
|
<dl>
|
|
16199
16204
|
<dd>
|
|
16200
16205
|
|
|
16201
|
-
**requestOptions:** `
|
|
16206
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16202
16207
|
|
|
16203
16208
|
</dd>
|
|
16204
16209
|
</dl>
|
|
@@ -16209,7 +16214,7 @@ await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
|
|
|
16209
16214
|
</dl>
|
|
16210
16215
|
</details>
|
|
16211
16216
|
|
|
16212
|
-
<details><summary><code>client.shipping.
|
|
16217
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">postUnarchiveV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
16213
16218
|
<dl>
|
|
16214
16219
|
<dd>
|
|
16215
16220
|
|
|
@@ -16221,7 +16226,7 @@ await client.shipping.orderTemplates.referencesRemoveV1("order_template_id", {
|
|
|
16221
16226
|
<dl>
|
|
16222
16227
|
<dd>
|
|
16223
16228
|
|
|
16224
|
-
Restores an archived order template by
|
|
16229
|
+
Restores an archived order template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
|
|
16225
16230
|
|
|
16226
16231
|
</dd>
|
|
16227
16232
|
</dl>
|
|
@@ -16237,7 +16242,7 @@ Restores an archived order template by clearing archived_at_timestamp. | authz:
|
|
|
16237
16242
|
<dd>
|
|
16238
16243
|
|
|
16239
16244
|
```typescript
|
|
16240
|
-
await client.shipping.
|
|
16245
|
+
await client.shipping.orderTemplatesNew.postUnarchiveV1("order_template_id");
|
|
16241
16246
|
```
|
|
16242
16247
|
|
|
16243
16248
|
</dd>
|
|
@@ -16261,7 +16266,7 @@ await client.shipping.orderTemplates.unarchiveV1("order_template_id");
|
|
|
16261
16266
|
<dl>
|
|
16262
16267
|
<dd>
|
|
16263
16268
|
|
|
16264
|
-
**requestOptions:** `
|
|
16269
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16265
16270
|
|
|
16266
16271
|
</dd>
|
|
16267
16272
|
</dl>
|
|
@@ -16272,7 +16277,7 @@ await client.shipping.orderTemplates.unarchiveV1("order_template_id");
|
|
|
16272
16277
|
</dl>
|
|
16273
16278
|
</details>
|
|
16274
16279
|
|
|
16275
|
-
<details><summary><code>client.shipping.
|
|
16280
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">updateV1</a>(orderTemplateId, { ...params }) -> Chrt.OrderTemplateNew1</code></summary>
|
|
16276
16281
|
<dl>
|
|
16277
16282
|
<dd>
|
|
16278
16283
|
|
|
@@ -16284,7 +16289,7 @@ await client.shipping.orderTemplates.unarchiveV1("order_template_id");
|
|
|
16284
16289
|
<dl>
|
|
16285
16290
|
<dd>
|
|
16286
16291
|
|
|
16287
|
-
Updates an order template. | authz: min_org_role=operator | (
|
|
16292
|
+
Updates an order template owned by the caller's organization. | authz: min_org_role=operator | (OrderTemplateNewClientUpdate1) -> (OrderTemplateNew1)
|
|
16288
16293
|
|
|
16289
16294
|
</dd>
|
|
16290
16295
|
</dl>
|
|
@@ -16300,7 +16305,7 @@ Updates an order template. | authz: min_org_role=operator | (OrderTemplateClient
|
|
|
16300
16305
|
<dd>
|
|
16301
16306
|
|
|
16302
16307
|
```typescript
|
|
16303
|
-
await client.shipping.
|
|
16308
|
+
await client.shipping.orderTemplatesNew.updateV1("order_template_id");
|
|
16304
16309
|
```
|
|
16305
16310
|
|
|
16306
16311
|
</dd>
|
|
@@ -16324,7 +16329,7 @@ await client.shipping.orderTemplates.updateV1("order_template_id");
|
|
|
16324
16329
|
<dl>
|
|
16325
16330
|
<dd>
|
|
16326
16331
|
|
|
16327
|
-
**request:** `Chrt.shipping.
|
|
16332
|
+
**request:** `Chrt.shipping.OrderTemplateNewClientUpdate1`
|
|
16328
16333
|
|
|
16329
16334
|
</dd>
|
|
16330
16335
|
</dl>
|
|
@@ -16332,7 +16337,7 @@ await client.shipping.orderTemplates.updateV1("order_template_id");
|
|
|
16332
16337
|
<dl>
|
|
16333
16338
|
<dd>
|
|
16334
16339
|
|
|
16335
|
-
**requestOptions:** `
|
|
16340
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16336
16341
|
|
|
16337
16342
|
</dd>
|
|
16338
16343
|
</dl>
|
|
@@ -16343,7 +16348,7 @@ await client.shipping.orderTemplates.updateV1("order_template_id");
|
|
|
16343
16348
|
</dl>
|
|
16344
16349
|
</details>
|
|
16345
16350
|
|
|
16346
|
-
<details><summary><code>client.shipping.
|
|
16351
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">createV1</a>({ ...params }) -> Chrt.OrderTemplateNew1</code></summary>
|
|
16347
16352
|
<dl>
|
|
16348
16353
|
<dd>
|
|
16349
16354
|
|
|
@@ -16355,7 +16360,7 @@ await client.shipping.orderTemplates.updateV1("order_template_id");
|
|
|
16355
16360
|
<dl>
|
|
16356
16361
|
<dd>
|
|
16357
16362
|
|
|
16358
|
-
Creates
|
|
16363
|
+
Creates an order template owned by the caller's organization. | authz: min_org_role=operator | (OrderTemplateNewClientCreate1) -> (OrderTemplateNew1)
|
|
16359
16364
|
|
|
16360
16365
|
</dd>
|
|
16361
16366
|
</dl>
|
|
@@ -16371,7 +16376,7 @@ Creates a new order template. | authz: min_org_role=operator | (OrderTemplateCli
|
|
|
16371
16376
|
<dd>
|
|
16372
16377
|
|
|
16373
16378
|
```typescript
|
|
16374
|
-
await client.shipping.
|
|
16379
|
+
await client.shipping.orderTemplatesNew.createV1({
|
|
16375
16380
|
name: "name",
|
|
16376
16381
|
schema_version: 1,
|
|
16377
16382
|
});
|
|
@@ -16390,7 +16395,7 @@ await client.shipping.orderTemplates.createV1({
|
|
|
16390
16395
|
<dl>
|
|
16391
16396
|
<dd>
|
|
16392
16397
|
|
|
16393
|
-
**request:** `Chrt.shipping.
|
|
16398
|
+
**request:** `Chrt.shipping.OrderTemplateNewClientCreate1`
|
|
16394
16399
|
|
|
16395
16400
|
</dd>
|
|
16396
16401
|
</dl>
|
|
@@ -16398,7 +16403,7 @@ await client.shipping.orderTemplates.createV1({
|
|
|
16398
16403
|
<dl>
|
|
16399
16404
|
<dd>
|
|
16400
16405
|
|
|
16401
|
-
**requestOptions:** `
|
|
16406
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16402
16407
|
|
|
16403
16408
|
</dd>
|
|
16404
16409
|
</dl>
|
|
@@ -16409,7 +16414,7 @@ await client.shipping.orderTemplates.createV1({
|
|
|
16409
16414
|
</dl>
|
|
16410
16415
|
</details>
|
|
16411
16416
|
|
|
16412
|
-
<details><summary><code>client.shipping.
|
|
16417
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">getByIdV1</a>(orderTemplateId) -> Chrt.OrderTemplateNew1</code></summary>
|
|
16413
16418
|
<dl>
|
|
16414
16419
|
<dd>
|
|
16415
16420
|
|
|
@@ -16421,7 +16426,7 @@ await client.shipping.orderTemplates.createV1({
|
|
|
16421
16426
|
<dl>
|
|
16422
16427
|
<dd>
|
|
16423
16428
|
|
|
16424
|
-
Retrieves an order template by ID. | authz: min_org_role=operator | () -> (
|
|
16429
|
+
Retrieves an order template by ID. | authz: min_org_role=operator | () -> (OrderTemplateNew1)
|
|
16425
16430
|
|
|
16426
16431
|
</dd>
|
|
16427
16432
|
</dl>
|
|
@@ -16437,7 +16442,7 @@ Retrieves an order template by ID. | authz: min_org_role=operator | () -> (Order
|
|
|
16437
16442
|
<dd>
|
|
16438
16443
|
|
|
16439
16444
|
```typescript
|
|
16440
|
-
await client.shipping.
|
|
16445
|
+
await client.shipping.orderTemplatesNew.getByIdV1("order_template_id");
|
|
16441
16446
|
```
|
|
16442
16447
|
|
|
16443
16448
|
</dd>
|
|
@@ -16461,7 +16466,7 @@ await client.shipping.orderTemplates.getByIdV1("order_template_id");
|
|
|
16461
16466
|
<dl>
|
|
16462
16467
|
<dd>
|
|
16463
16468
|
|
|
16464
|
-
**requestOptions:** `
|
|
16469
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16465
16470
|
|
|
16466
16471
|
</dd>
|
|
16467
16472
|
</dl>
|
|
@@ -16472,7 +16477,7 @@ await client.shipping.orderTemplates.getByIdV1("order_template_id");
|
|
|
16472
16477
|
</dl>
|
|
16473
16478
|
</details>
|
|
16474
16479
|
|
|
16475
|
-
<details><summary><code>client.shipping.
|
|
16480
|
+
<details><summary><code>client.shipping.orderTemplatesNew.<a href="/src/api/resources/shipping/resources/orderTemplatesNew/client/Client.ts">deleteV1</a>(orderTemplateId) -> boolean</code></summary>
|
|
16476
16481
|
<dl>
|
|
16477
16482
|
<dd>
|
|
16478
16483
|
|
|
@@ -16484,7 +16489,7 @@ await client.shipping.orderTemplates.getByIdV1("order_template_id");
|
|
|
16484
16489
|
<dl>
|
|
16485
16490
|
<dd>
|
|
16486
16491
|
|
|
16487
|
-
Deletes an order template
|
|
16492
|
+
Deletes an order template owned by the caller's organization. | authz: min_org_role=operator | () -> (bool)
|
|
16488
16493
|
|
|
16489
16494
|
</dd>
|
|
16490
16495
|
</dl>
|
|
@@ -16500,7 +16505,7 @@ Deletes an order template, but only when no orders were built from it (otherwise
|
|
|
16500
16505
|
<dd>
|
|
16501
16506
|
|
|
16502
16507
|
```typescript
|
|
16503
|
-
await client.shipping.
|
|
16508
|
+
await client.shipping.orderTemplatesNew.deleteV1("order_template_id");
|
|
16504
16509
|
```
|
|
16505
16510
|
|
|
16506
16511
|
</dd>
|
|
@@ -16524,7 +16529,7 @@ await client.shipping.orderTemplates.deleteV1("order_template_id");
|
|
|
16524
16529
|
<dl>
|
|
16525
16530
|
<dd>
|
|
16526
16531
|
|
|
16527
|
-
**requestOptions:** `
|
|
16532
|
+
**requestOptions:** `OrderTemplatesNew.RequestOptions`
|
|
16528
16533
|
|
|
16529
16534
|
</dd>
|
|
16530
16535
|
</dl>
|
|
@@ -16535,9 +16540,9 @@ await client.shipping.orderTemplates.deleteV1("order_template_id");
|
|
|
16535
16540
|
</dl>
|
|
16536
16541
|
</details>
|
|
16537
16542
|
|
|
16538
|
-
## Shipping
|
|
16543
|
+
## Shipping Orders
|
|
16539
16544
|
|
|
16540
|
-
<details><summary><code>client.shipping.
|
|
16545
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">assignV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
16541
16546
|
<dl>
|
|
16542
16547
|
<dd>
|
|
16543
16548
|
|
|
@@ -16549,7 +16554,7 @@ await client.shipping.orderTemplates.deleteV1("order_template_id");
|
|
|
16549
16554
|
<dl>
|
|
16550
16555
|
<dd>
|
|
16551
16556
|
|
|
16552
|
-
|
|
16557
|
+
Adds operator(s) to the caller's assignees on the order. Coordinator writes coordinator_assigned_user_ids; executor writes executor_assigned_user_ids on matching task_group_details. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersAssignReq) -> (bool)
|
|
16553
16558
|
|
|
16554
16559
|
</dd>
|
|
16555
16560
|
</dl>
|
|
@@ -16565,7 +16570,9 @@ Archives an order template owned by the caller's organization. | authz: min_org_
|
|
|
16565
16570
|
<dd>
|
|
16566
16571
|
|
|
16567
16572
|
```typescript
|
|
16568
|
-
await client.shipping.
|
|
16573
|
+
await client.shipping.orders.assignV1("order_id", {
|
|
16574
|
+
operator_user_ids: ["operator_user_ids"],
|
|
16575
|
+
});
|
|
16569
16576
|
```
|
|
16570
16577
|
|
|
16571
16578
|
</dd>
|
|
@@ -16581,7 +16588,7 @@ await client.shipping.orderTemplatesNew.postArchiveV1("order_template_id");
|
|
|
16581
16588
|
<dl>
|
|
16582
16589
|
<dd>
|
|
16583
16590
|
|
|
16584
|
-
**
|
|
16591
|
+
**orderId:** `string`
|
|
16585
16592
|
|
|
16586
16593
|
</dd>
|
|
16587
16594
|
</dl>
|
|
@@ -16589,7 +16596,15 @@ await client.shipping.orderTemplatesNew.postArchiveV1("order_template_id");
|
|
|
16589
16596
|
<dl>
|
|
16590
16597
|
<dd>
|
|
16591
16598
|
|
|
16592
|
-
**
|
|
16599
|
+
**request:** `Chrt.shipping.OrdersAssignReq`
|
|
16600
|
+
|
|
16601
|
+
</dd>
|
|
16602
|
+
</dl>
|
|
16603
|
+
|
|
16604
|
+
<dl>
|
|
16605
|
+
<dd>
|
|
16606
|
+
|
|
16607
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
16593
16608
|
|
|
16594
16609
|
</dd>
|
|
16595
16610
|
</dl>
|
|
@@ -16600,7 +16615,7 @@ await client.shipping.orderTemplatesNew.postArchiveV1("order_template_id");
|
|
|
16600
16615
|
</dl>
|
|
16601
16616
|
</details>
|
|
16602
16617
|
|
|
16603
|
-
<details><summary><code>client.shipping.
|
|
16618
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelV1</a>(orderId) -> boolean</code></summary>
|
|
16604
16619
|
<dl>
|
|
16605
16620
|
<dd>
|
|
16606
16621
|
|
|
@@ -16612,7 +16627,7 @@ await client.shipping.orderTemplatesNew.postArchiveV1("order_template_id");
|
|
|
16612
16627
|
<dl>
|
|
16613
16628
|
<dd>
|
|
16614
16629
|
|
|
16615
|
-
|
|
16630
|
+
Cancels an order and non-terminal child entities in a transaction. | authz_personas=[task_group_operating_org_operators] | () -> (bool)
|
|
16616
16631
|
|
|
16617
16632
|
</dd>
|
|
16618
16633
|
</dl>
|
|
@@ -16628,9 +16643,7 @@ Atomically replaces an active order template core. | authz: min_org_role=operato
|
|
|
16628
16643
|
<dd>
|
|
16629
16644
|
|
|
16630
16645
|
```typescript
|
|
16631
|
-
await client.shipping.
|
|
16632
|
-
schema_version: 1,
|
|
16633
|
-
});
|
|
16646
|
+
await client.shipping.orders.cancelV1("order_id");
|
|
16634
16647
|
```
|
|
16635
16648
|
|
|
16636
16649
|
</dd>
|
|
@@ -16646,15 +16659,7 @@ await client.shipping.orderTemplatesNew.putReplaceCoreV1("order_template_id", {
|
|
|
16646
16659
|
<dl>
|
|
16647
16660
|
<dd>
|
|
16648
16661
|
|
|
16649
|
-
**
|
|
16650
|
-
|
|
16651
|
-
</dd>
|
|
16652
|
-
</dl>
|
|
16653
|
-
|
|
16654
|
-
<dl>
|
|
16655
|
-
<dd>
|
|
16656
|
-
|
|
16657
|
-
**request:** `Chrt.OrderTemplateNewCore1`
|
|
16662
|
+
**orderId:** `string`
|
|
16658
16663
|
|
|
16659
16664
|
</dd>
|
|
16660
16665
|
</dl>
|
|
@@ -16662,7 +16667,7 @@ await client.shipping.orderTemplatesNew.putReplaceCoreV1("order_template_id", {
|
|
|
16662
16667
|
<dl>
|
|
16663
16668
|
<dd>
|
|
16664
16669
|
|
|
16665
|
-
**requestOptions:** `
|
|
16670
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
16666
16671
|
|
|
16667
16672
|
</dd>
|
|
16668
16673
|
</dl>
|
|
@@ -16673,7 +16678,7 @@ await client.shipping.orderTemplatesNew.putReplaceCoreV1("order_template_id", {
|
|
|
16673
16678
|
</dl>
|
|
16674
16679
|
</details>
|
|
16675
16680
|
|
|
16676
|
-
<details><summary><code>client.shipping.
|
|
16681
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">cancelManyV1</a>({ ...params }) -> boolean</code></summary>
|
|
16677
16682
|
<dl>
|
|
16678
16683
|
<dd>
|
|
16679
16684
|
|
|
@@ -16685,7 +16690,7 @@ await client.shipping.orderTemplatesNew.putReplaceCoreV1("order_template_id", {
|
|
|
16685
16690
|
<dl>
|
|
16686
16691
|
<dd>
|
|
16687
16692
|
|
|
16688
|
-
|
|
16693
|
+
Cancels multiple orders and their non-terminal child entities in a transaction. | authz_personas=[task_group_operating_org_operators] | (OrdersCancelManyReq) -> (bool)
|
|
16689
16694
|
|
|
16690
16695
|
</dd>
|
|
16691
16696
|
</dl>
|
|
@@ -16701,9 +16706,8 @@ Validates a natural-language date string and resolves it to a UTC timestamp. | a
|
|
|
16701
16706
|
<dd>
|
|
16702
16707
|
|
|
16703
16708
|
```typescript
|
|
16704
|
-
await client.shipping.
|
|
16705
|
-
|
|
16706
|
-
time_zone_name: "America/New_York",
|
|
16709
|
+
await client.shipping.orders.cancelManyV1({
|
|
16710
|
+
order_ids: ["order_ids"],
|
|
16707
16711
|
});
|
|
16708
16712
|
```
|
|
16709
16713
|
|
|
@@ -16720,7 +16724,7 @@ await client.shipping.orderTemplatesNew.resolveDateparserV1({
|
|
|
16720
16724
|
<dl>
|
|
16721
16725
|
<dd>
|
|
16722
16726
|
|
|
16723
|
-
**request:** `Chrt.shipping.
|
|
16727
|
+
**request:** `Chrt.shipping.OrdersCancelManyReq`
|
|
16724
16728
|
|
|
16725
16729
|
</dd>
|
|
16726
16730
|
</dl>
|
|
@@ -16728,7 +16732,7 @@ await client.shipping.orderTemplatesNew.resolveDateparserV1({
|
|
|
16728
16732
|
<dl>
|
|
16729
16733
|
<dd>
|
|
16730
16734
|
|
|
16731
|
-
**requestOptions:** `
|
|
16735
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
16732
16736
|
|
|
16733
16737
|
</dd>
|
|
16734
16738
|
</dl>
|
|
@@ -16739,7 +16743,7 @@ await client.shipping.orderTemplatesNew.resolveDateparserV1({
|
|
|
16739
16743
|
</dl>
|
|
16740
16744
|
</details>
|
|
16741
16745
|
|
|
16742
|
-
<details><summary><code>client.shipping.
|
|
16746
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">addCoordinatorTaskListToApplyAtOrderStagingV1</a>(orderId, taskListId, { ...params }) -> boolean</code></summary>
|
|
16743
16747
|
<dl>
|
|
16744
16748
|
<dd>
|
|
16745
16749
|
|
|
@@ -16751,7 +16755,7 @@ await client.shipping.orderTemplatesNew.resolveDateparserV1({
|
|
|
16751
16755
|
<dl>
|
|
16752
16756
|
<dd>
|
|
16753
16757
|
|
|
16754
|
-
|
|
16758
|
+
Adds or updates a coordinator task list to apply when the draft is staged. | authz_personas=[coordinator_org_operators] | (UTCDatetime | None) -> (bool)
|
|
16755
16759
|
|
|
16756
16760
|
</dd>
|
|
16757
16761
|
</dl>
|
|
@@ -16767,24 +16771,9 @@ Lists order templates with filtering, sorting, pagination, full-text search, and
|
|
|
16767
16771
|
<dd>
|
|
16768
16772
|
|
|
16769
16773
|
```typescript
|
|
16770
|
-
await client.shipping.
|
|
16771
|
-
|
|
16772
|
-
|
|
16773
|
-
page: 1,
|
|
16774
|
-
page_size: 1,
|
|
16775
|
-
search: "search",
|
|
16776
|
-
filter_archived: true,
|
|
16777
|
-
filter_owned_by_user_id: "filter_owned_by_user_id",
|
|
16778
|
-
filter_executor_org_id: "filter_executor_org_id",
|
|
16779
|
-
filter_off_chrt_executor_org_data_id: "filter_off_chrt_executor_org_data_id",
|
|
16780
|
-
filter_shipper_org_id: "filter_shipper_org_id",
|
|
16781
|
-
filter_off_chrt_shipper_org_data_id: "filter_off_chrt_shipper_org_data_id",
|
|
16782
|
-
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16783
|
-
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16784
|
-
filter_last_edited_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16785
|
-
filter_last_edited_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16786
|
-
filter_last_used_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
16787
|
-
filter_last_used_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
16774
|
+
await client.shipping.orders.addCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id", {
|
|
16775
|
+
department_id: "department_id",
|
|
16776
|
+
body: "2024-01-15T09:30:00Z",
|
|
16788
16777
|
});
|
|
16789
16778
|
```
|
|
16790
16779
|
|
|
@@ -16801,7 +16790,7 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16801
16790
|
<dl>
|
|
16802
16791
|
<dd>
|
|
16803
16792
|
|
|
16804
|
-
**
|
|
16793
|
+
**orderId:** `string`
|
|
16805
16794
|
|
|
16806
16795
|
</dd>
|
|
16807
16796
|
</dl>
|
|
@@ -16809,7 +16798,23 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16809
16798
|
<dl>
|
|
16810
16799
|
<dd>
|
|
16811
16800
|
|
|
16812
|
-
**
|
|
16801
|
+
**taskListId:** `string`
|
|
16802
|
+
|
|
16803
|
+
</dd>
|
|
16804
|
+
</dl>
|
|
16805
|
+
|
|
16806
|
+
<dl>
|
|
16807
|
+
<dd>
|
|
16808
|
+
|
|
16809
|
+
**request:** `Chrt.shipping.OrdersAddCoordinatorTaskListToApplyAtOrderStagingV1Request`
|
|
16810
|
+
|
|
16811
|
+
</dd>
|
|
16812
|
+
</dl>
|
|
16813
|
+
|
|
16814
|
+
<dl>
|
|
16815
|
+
<dd>
|
|
16816
|
+
|
|
16817
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
16813
16818
|
|
|
16814
16819
|
</dd>
|
|
16815
16820
|
</dl>
|
|
@@ -16820,7 +16825,7 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16820
16825
|
</dl>
|
|
16821
16826
|
</details>
|
|
16822
16827
|
|
|
16823
|
-
<details><summary><code>client.shipping.
|
|
16828
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">removeCoordinatorTaskListToApplyAtOrderStagingV1</a>(orderId, taskListId) -> boolean</code></summary>
|
|
16824
16829
|
<dl>
|
|
16825
16830
|
<dd>
|
|
16826
16831
|
|
|
@@ -16832,7 +16837,7 @@ await client.shipping.orderTemplatesNew.listV1({
|
|
|
16832
16837
|
<dl>
|
|
16833
16838
|
<dd>
|
|
16834
16839
|
|
|
16835
|
-
|
|
16840
|
+
Removes a coordinator task list pending application at draft staging. | authz_personas=[coordinator_org_operators] | () -> (bool)
|
|
16836
16841
|
|
|
16837
16842
|
</dd>
|
|
16838
16843
|
</dl>
|
|
@@ -16848,7 +16853,7 @@ Restores an archived order template owned by the caller's organization. | authz:
|
|
|
16848
16853
|
<dd>
|
|
16849
16854
|
|
|
16850
16855
|
```typescript
|
|
16851
|
-
await client.shipping.
|
|
16856
|
+
await client.shipping.orders.removeCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id");
|
|
16852
16857
|
```
|
|
16853
16858
|
|
|
16854
16859
|
</dd>
|
|
@@ -16864,7 +16869,7 @@ await client.shipping.orderTemplatesNew.postUnarchiveV1("order_template_id");
|
|
|
16864
16869
|
<dl>
|
|
16865
16870
|
<dd>
|
|
16866
16871
|
|
|
16867
|
-
**
|
|
16872
|
+
**orderId:** `string`
|
|
16868
16873
|
|
|
16869
16874
|
</dd>
|
|
16870
16875
|
</dl>
|
|
@@ -16872,7 +16877,15 @@ await client.shipping.orderTemplatesNew.postUnarchiveV1("order_template_id");
|
|
|
16872
16877
|
<dl>
|
|
16873
16878
|
<dd>
|
|
16874
16879
|
|
|
16875
|
-
**
|
|
16880
|
+
**taskListId:** `string`
|
|
16881
|
+
|
|
16882
|
+
</dd>
|
|
16883
|
+
</dl>
|
|
16884
|
+
|
|
16885
|
+
<dl>
|
|
16886
|
+
<dd>
|
|
16887
|
+
|
|
16888
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
16876
16889
|
|
|
16877
16890
|
</dd>
|
|
16878
16891
|
</dl>
|
|
@@ -16883,7 +16896,7 @@ await client.shipping.orderTemplatesNew.postUnarchiveV1("order_template_id");
|
|
|
16883
16896
|
</dl>
|
|
16884
16897
|
</details>
|
|
16885
16898
|
|
|
16886
|
-
<details><summary><code>client.shipping.
|
|
16899
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">deleteDraftV1</a>(orderId) -> boolean</code></summary>
|
|
16887
16900
|
<dl>
|
|
16888
16901
|
<dd>
|
|
16889
16902
|
|
|
@@ -16895,7 +16908,7 @@ await client.shipping.orderTemplatesNew.postUnarchiveV1("order_template_id");
|
|
|
16895
16908
|
<dl>
|
|
16896
16909
|
<dd>
|
|
16897
16910
|
|
|
16898
|
-
|
|
16911
|
+
Hard-deletes a draft order and all dependent entities. | authz_personas=[draft_creator_org_operator] | () -> (bool)
|
|
16899
16912
|
|
|
16900
16913
|
</dd>
|
|
16901
16914
|
</dl>
|
|
@@ -16911,7 +16924,7 @@ Updates an order template owned by the caller's organization. | authz: min_org_r
|
|
|
16911
16924
|
<dd>
|
|
16912
16925
|
|
|
16913
16926
|
```typescript
|
|
16914
|
-
await client.shipping.
|
|
16927
|
+
await client.shipping.orders.deleteDraftV1("order_id");
|
|
16915
16928
|
```
|
|
16916
16929
|
|
|
16917
16930
|
</dd>
|
|
@@ -16927,15 +16940,7 @@ await client.shipping.orderTemplatesNew.updateV1("order_template_id");
|
|
|
16927
16940
|
<dl>
|
|
16928
16941
|
<dd>
|
|
16929
16942
|
|
|
16930
|
-
**
|
|
16931
|
-
|
|
16932
|
-
</dd>
|
|
16933
|
-
</dl>
|
|
16934
|
-
|
|
16935
|
-
<dl>
|
|
16936
|
-
<dd>
|
|
16937
|
-
|
|
16938
|
-
**request:** `Chrt.shipping.OrderTemplateNewClientUpdate1`
|
|
16943
|
+
**orderId:** `string`
|
|
16939
16944
|
|
|
16940
16945
|
</dd>
|
|
16941
16946
|
</dl>
|
|
@@ -16943,7 +16948,7 @@ await client.shipping.orderTemplatesNew.updateV1("order_template_id");
|
|
|
16943
16948
|
<dl>
|
|
16944
16949
|
<dd>
|
|
16945
16950
|
|
|
16946
|
-
**requestOptions:** `
|
|
16951
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
16947
16952
|
|
|
16948
16953
|
</dd>
|
|
16949
16954
|
</dl>
|
|
@@ -16954,7 +16959,7 @@ await client.shipping.orderTemplatesNew.updateV1("order_template_id");
|
|
|
16954
16959
|
</dl>
|
|
16955
16960
|
</details>
|
|
16956
16961
|
|
|
16957
|
-
<details><summary><code>client.shipping.
|
|
16962
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">deleteManyDraftsV1</a>({ ...params }) -> Chrt.OrdersDeleteManyDraftsRes</code></summary>
|
|
16958
16963
|
<dl>
|
|
16959
16964
|
<dd>
|
|
16960
16965
|
|
|
@@ -16966,7 +16971,7 @@ await client.shipping.orderTemplatesNew.updateV1("order_template_id");
|
|
|
16966
16971
|
<dl>
|
|
16967
16972
|
<dd>
|
|
16968
16973
|
|
|
16969
|
-
|
|
16974
|
+
Hard-deletes multiple draft orders and all dependent entities. | authz_personas=[draft_creator_org_operator] | (OrdersDeleteManyDraftsReq) -> (OrdersDeleteManyDraftsRes)
|
|
16970
16975
|
|
|
16971
16976
|
</dd>
|
|
16972
16977
|
</dl>
|
|
@@ -16982,9 +16987,8 @@ Creates an order template owned by the caller's organization. | authz: min_org_r
|
|
|
16982
16987
|
<dd>
|
|
16983
16988
|
|
|
16984
16989
|
```typescript
|
|
16985
|
-
await client.shipping.
|
|
16986
|
-
|
|
16987
|
-
schema_version: 1,
|
|
16990
|
+
await client.shipping.orders.deleteManyDraftsV1({
|
|
16991
|
+
order_ids: ["order_ids"],
|
|
16988
16992
|
});
|
|
16989
16993
|
```
|
|
16990
16994
|
|
|
@@ -17001,7 +17005,7 @@ await client.shipping.orderTemplatesNew.createV1({
|
|
|
17001
17005
|
<dl>
|
|
17002
17006
|
<dd>
|
|
17003
17007
|
|
|
17004
|
-
**request:** `Chrt.shipping.
|
|
17008
|
+
**request:** `Chrt.shipping.OrdersDeleteManyDraftsReq`
|
|
17005
17009
|
|
|
17006
17010
|
</dd>
|
|
17007
17011
|
</dl>
|
|
@@ -17009,7 +17013,7 @@ await client.shipping.orderTemplatesNew.createV1({
|
|
|
17009
17013
|
<dl>
|
|
17010
17014
|
<dd>
|
|
17011
17015
|
|
|
17012
|
-
**requestOptions:** `
|
|
17016
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17013
17017
|
|
|
17014
17018
|
</dd>
|
|
17015
17019
|
</dl>
|
|
@@ -17020,7 +17024,7 @@ await client.shipping.orderTemplatesNew.createV1({
|
|
|
17020
17024
|
</dl>
|
|
17021
17025
|
</details>
|
|
17022
17026
|
|
|
17023
|
-
<details><summary><code>client.shipping.
|
|
17027
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">stageV1</a>(orderId) -> boolean</code></summary>
|
|
17024
17028
|
<dl>
|
|
17025
17029
|
<dd>
|
|
17026
17030
|
|
|
@@ -17032,7 +17036,7 @@ await client.shipping.orderTemplatesNew.createV1({
|
|
|
17032
17036
|
<dl>
|
|
17033
17037
|
<dd>
|
|
17034
17038
|
|
|
17035
|
-
|
|
17039
|
+
Validates a draft order and stages all related entities in a transaction. | authz_personas=[draft_creator_org_operator] | () -> (bool)
|
|
17036
17040
|
|
|
17037
17041
|
</dd>
|
|
17038
17042
|
</dl>
|
|
@@ -17048,7 +17052,7 @@ Retrieves an order template by ID. | authz: min_org_role=operator | () -> (Order
|
|
|
17048
17052
|
<dd>
|
|
17049
17053
|
|
|
17050
17054
|
```typescript
|
|
17051
|
-
await client.shipping.
|
|
17055
|
+
await client.shipping.orders.stageV1("order_id");
|
|
17052
17056
|
```
|
|
17053
17057
|
|
|
17054
17058
|
</dd>
|
|
@@ -17064,7 +17068,7 @@ await client.shipping.orderTemplatesNew.getByIdV1("order_template_id");
|
|
|
17064
17068
|
<dl>
|
|
17065
17069
|
<dd>
|
|
17066
17070
|
|
|
17067
|
-
**
|
|
17071
|
+
**orderId:** `string`
|
|
17068
17072
|
|
|
17069
17073
|
</dd>
|
|
17070
17074
|
</dl>
|
|
@@ -17072,7 +17076,7 @@ await client.shipping.orderTemplatesNew.getByIdV1("order_template_id");
|
|
|
17072
17076
|
<dl>
|
|
17073
17077
|
<dd>
|
|
17074
17078
|
|
|
17075
|
-
**requestOptions:** `
|
|
17079
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17076
17080
|
|
|
17077
17081
|
</dd>
|
|
17078
17082
|
</dl>
|
|
@@ -17083,7 +17087,7 @@ await client.shipping.orderTemplatesNew.getByIdV1("order_template_id");
|
|
|
17083
17087
|
</dl>
|
|
17084
17088
|
</details>
|
|
17085
17089
|
|
|
17086
|
-
<details><summary><code>client.shipping.
|
|
17090
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">getSuggestedDepartmentV1</a>(orderId) -> (string | null) | undefined</code></summary>
|
|
17087
17091
|
<dl>
|
|
17088
17092
|
<dd>
|
|
17089
17093
|
|
|
@@ -17095,7 +17099,7 @@ await client.shipping.orderTemplatesNew.getByIdV1("order_template_id");
|
|
|
17095
17099
|
<dl>
|
|
17096
17100
|
<dd>
|
|
17097
17101
|
|
|
17098
|
-
|
|
17102
|
+
Returns the coordinator's account-level default department for the order's shipper. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
|
|
17099
17103
|
|
|
17100
17104
|
</dd>
|
|
17101
17105
|
</dl>
|
|
@@ -17111,7 +17115,7 @@ Deletes an order template owned by the caller's organization. | authz: min_org_r
|
|
|
17111
17115
|
<dd>
|
|
17112
17116
|
|
|
17113
17117
|
```typescript
|
|
17114
|
-
await client.shipping.
|
|
17118
|
+
await client.shipping.orders.getSuggestedDepartmentV1("order_id");
|
|
17115
17119
|
```
|
|
17116
17120
|
|
|
17117
17121
|
</dd>
|
|
@@ -17127,7 +17131,7 @@ await client.shipping.orderTemplatesNew.deleteV1("order_template_id");
|
|
|
17127
17131
|
<dl>
|
|
17128
17132
|
<dd>
|
|
17129
17133
|
|
|
17130
|
-
**
|
|
17134
|
+
**orderId:** `string`
|
|
17131
17135
|
|
|
17132
17136
|
</dd>
|
|
17133
17137
|
</dl>
|
|
@@ -17135,7 +17139,7 @@ await client.shipping.orderTemplatesNew.deleteV1("order_template_id");
|
|
|
17135
17139
|
<dl>
|
|
17136
17140
|
<dd>
|
|
17137
17141
|
|
|
17138
|
-
**requestOptions:** `
|
|
17142
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
17139
17143
|
|
|
17140
17144
|
</dd>
|
|
17141
17145
|
</dl>
|
|
@@ -17146,9 +17150,7 @@ await client.shipping.orderTemplatesNew.deleteV1("order_template_id");
|
|
|
17146
17150
|
</dl>
|
|
17147
17151
|
</details>
|
|
17148
17152
|
|
|
17149
|
-
|
|
17150
|
-
|
|
17151
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">assignV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17153
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">taskGroupOrderingV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17152
17154
|
<dl>
|
|
17153
17155
|
<dd>
|
|
17154
17156
|
|
|
@@ -17160,7 +17162,7 @@ await client.shipping.orderTemplatesNew.deleteV1("order_template_id");
|
|
|
17160
17162
|
<dl>
|
|
17161
17163
|
<dd>
|
|
17162
17164
|
|
|
17163
|
-
|
|
17165
|
+
Sets task-group ordering on an active order unless a task group or task is completed. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | (OrdersTaskGroupOrderingReq) -> (bool)
|
|
17164
17166
|
|
|
17165
17167
|
</dd>
|
|
17166
17168
|
</dl>
|
|
@@ -17176,8 +17178,8 @@ Adds operator(s) to the caller's assignees on the order. Coordinator writes coor
|
|
|
17176
17178
|
<dd>
|
|
17177
17179
|
|
|
17178
17180
|
```typescript
|
|
17179
|
-
await client.shipping.orders.
|
|
17180
|
-
|
|
17181
|
+
await client.shipping.orders.taskGroupOrderingV1("order_id", {
|
|
17182
|
+
task_group_ids: ["task_group_ids"],
|
|
17181
17183
|
});
|
|
17182
17184
|
```
|
|
17183
17185
|
|
|
@@ -17202,7 +17204,7 @@ await client.shipping.orders.assignV1("order_id", {
|
|
|
17202
17204
|
<dl>
|
|
17203
17205
|
<dd>
|
|
17204
17206
|
|
|
17205
|
-
**request:** `Chrt.shipping.
|
|
17207
|
+
**request:** `Chrt.shipping.OrdersTaskGroupOrderingReq`
|
|
17206
17208
|
|
|
17207
17209
|
</dd>
|
|
17208
17210
|
</dl>
|
|
@@ -17221,7 +17223,7 @@ await client.shipping.orders.assignV1("order_id", {
|
|
|
17221
17223
|
</dl>
|
|
17222
17224
|
</details>
|
|
17223
17225
|
|
|
17224
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17226
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadLabelV1</a>({ ...params }) -> string[]</code></summary>
|
|
17225
17227
|
<dl>
|
|
17226
17228
|
<dd>
|
|
17227
17229
|
|
|
@@ -17233,7 +17235,7 @@ await client.shipping.orders.assignV1("order_id", {
|
|
|
17233
17235
|
<dl>
|
|
17234
17236
|
<dd>
|
|
17235
17237
|
|
|
17236
|
-
|
|
17238
|
+
Returns distinct label values matching the query for orders where the caller is coordinator (coordinator_label) or executor (task_group_details.executor_label). | authz: allowed_org_types=[provider], min_org_role=operator | () -> (list[str])
|
|
17237
17239
|
|
|
17238
17240
|
</dd>
|
|
17239
17241
|
</dl>
|
|
@@ -17249,7 +17251,10 @@ Cancels an order and non-terminal child entities in a transaction. | authz_perso
|
|
|
17249
17251
|
<dd>
|
|
17250
17252
|
|
|
17251
17253
|
```typescript
|
|
17252
|
-
await client.shipping.orders.
|
|
17254
|
+
await client.shipping.orders.typeaheadLabelV1({
|
|
17255
|
+
query: "query",
|
|
17256
|
+
limit: 1,
|
|
17257
|
+
});
|
|
17253
17258
|
```
|
|
17254
17259
|
|
|
17255
17260
|
</dd>
|
|
@@ -17265,7 +17270,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
17265
17270
|
<dl>
|
|
17266
17271
|
<dd>
|
|
17267
17272
|
|
|
17268
|
-
**
|
|
17273
|
+
**request:** `Chrt.shipping.OrdersTypeaheadLabelV1Request`
|
|
17269
17274
|
|
|
17270
17275
|
</dd>
|
|
17271
17276
|
</dl>
|
|
@@ -17284,7 +17289,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
17284
17289
|
</dl>
|
|
17285
17290
|
</details>
|
|
17286
17291
|
|
|
17287
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17292
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
17288
17293
|
<dl>
|
|
17289
17294
|
<dd>
|
|
17290
17295
|
|
|
@@ -17296,7 +17301,7 @@ await client.shipping.orders.cancelV1("order_id");
|
|
|
17296
17301
|
<dl>
|
|
17297
17302
|
<dd>
|
|
17298
17303
|
|
|
17299
|
-
|
|
17304
|
+
Returns distinct order short ID, off-CHRT reference ID, and AWB values matching the query via case-insensitive regex. Searches visible non-draft orders and caller-created draft orders. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
17300
17305
|
|
|
17301
17306
|
</dd>
|
|
17302
17307
|
</dl>
|
|
@@ -17312,8 +17317,9 @@ Cancels multiple orders and their non-terminal child entities in a transaction.
|
|
|
17312
17317
|
<dd>
|
|
17313
17318
|
|
|
17314
17319
|
```typescript
|
|
17315
|
-
await client.shipping.orders.
|
|
17316
|
-
|
|
17320
|
+
await client.shipping.orders.typeaheadV1({
|
|
17321
|
+
query: "query",
|
|
17322
|
+
limit: 1,
|
|
17317
17323
|
});
|
|
17318
17324
|
```
|
|
17319
17325
|
|
|
@@ -17330,7 +17336,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
17330
17336
|
<dl>
|
|
17331
17337
|
<dd>
|
|
17332
17338
|
|
|
17333
|
-
**request:** `Chrt.shipping.
|
|
17339
|
+
**request:** `Chrt.shipping.OrdersTypeaheadV1Request`
|
|
17334
17340
|
|
|
17335
17341
|
</dd>
|
|
17336
17342
|
</dl>
|
|
@@ -17349,7 +17355,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
17349
17355
|
</dl>
|
|
17350
17356
|
</details>
|
|
17351
17357
|
|
|
17352
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17358
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">unassignV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17353
17359
|
<dl>
|
|
17354
17360
|
<dd>
|
|
17355
17361
|
|
|
@@ -17361,7 +17367,7 @@ await client.shipping.orders.cancelManyV1({
|
|
|
17361
17367
|
<dl>
|
|
17362
17368
|
<dd>
|
|
17363
17369
|
|
|
17364
|
-
|
|
17370
|
+
Removes operator(s) from the caller's assignees on the order. Coordinator writes coordinator_assigned_user_ids; executor writes executor_assigned_user_ids on matching task_group_details. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUnassignReq) -> (bool)
|
|
17365
17371
|
|
|
17366
17372
|
</dd>
|
|
17367
17373
|
</dl>
|
|
@@ -17377,7 +17383,9 @@ Validates a draft order and stages all related entities in a transaction. | auth
|
|
|
17377
17383
|
<dd>
|
|
17378
17384
|
|
|
17379
17385
|
```typescript
|
|
17380
|
-
await client.shipping.orders.
|
|
17386
|
+
await client.shipping.orders.unassignV1("order_id", {
|
|
17387
|
+
operator_user_ids: ["operator_user_ids"],
|
|
17388
|
+
});
|
|
17381
17389
|
```
|
|
17382
17390
|
|
|
17383
17391
|
</dd>
|
|
@@ -17401,62 +17409,7 @@ await client.shipping.orders.stageV1("order_id");
|
|
|
17401
17409
|
<dl>
|
|
17402
17410
|
<dd>
|
|
17403
17411
|
|
|
17404
|
-
**
|
|
17405
|
-
|
|
17406
|
-
</dd>
|
|
17407
|
-
</dl>
|
|
17408
|
-
</dd>
|
|
17409
|
-
</dl>
|
|
17410
|
-
|
|
17411
|
-
</dd>
|
|
17412
|
-
</dl>
|
|
17413
|
-
</details>
|
|
17414
|
-
|
|
17415
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">getSuggestedDepartmentV1</a>(orderId) -> (string | null) | undefined</code></summary>
|
|
17416
|
-
<dl>
|
|
17417
|
-
<dd>
|
|
17418
|
-
|
|
17419
|
-
#### 📝 Description
|
|
17420
|
-
|
|
17421
|
-
<dl>
|
|
17422
|
-
<dd>
|
|
17423
|
-
|
|
17424
|
-
<dl>
|
|
17425
|
-
<dd>
|
|
17426
|
-
|
|
17427
|
-
Returns the coordinator's account-level default department for the order's shipper. | authz: min_org_role=operator | () -> (PydanticObjectId | None)
|
|
17428
|
-
|
|
17429
|
-
</dd>
|
|
17430
|
-
</dl>
|
|
17431
|
-
</dd>
|
|
17432
|
-
</dl>
|
|
17433
|
-
|
|
17434
|
-
#### 🔌 Usage
|
|
17435
|
-
|
|
17436
|
-
<dl>
|
|
17437
|
-
<dd>
|
|
17438
|
-
|
|
17439
|
-
<dl>
|
|
17440
|
-
<dd>
|
|
17441
|
-
|
|
17442
|
-
```typescript
|
|
17443
|
-
await client.shipping.orders.getSuggestedDepartmentV1("order_id");
|
|
17444
|
-
```
|
|
17445
|
-
|
|
17446
|
-
</dd>
|
|
17447
|
-
</dl>
|
|
17448
|
-
</dd>
|
|
17449
|
-
</dl>
|
|
17450
|
-
|
|
17451
|
-
#### ⚙️ Parameters
|
|
17452
|
-
|
|
17453
|
-
<dl>
|
|
17454
|
-
<dd>
|
|
17455
|
-
|
|
17456
|
-
<dl>
|
|
17457
|
-
<dd>
|
|
17458
|
-
|
|
17459
|
-
**orderId:** `string`
|
|
17412
|
+
**request:** `Chrt.shipping.OrdersUnassignReq`
|
|
17460
17413
|
|
|
17461
17414
|
</dd>
|
|
17462
17415
|
</dl>
|
|
@@ -17475,7 +17428,7 @@ await client.shipping.orders.getSuggestedDepartmentV1("order_id");
|
|
|
17475
17428
|
</dl>
|
|
17476
17429
|
</details>
|
|
17477
17430
|
|
|
17478
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17431
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateDepartmentV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17479
17432
|
<dl>
|
|
17480
17433
|
<dd>
|
|
17481
17434
|
|
|
@@ -17487,7 +17440,7 @@ await client.shipping.orders.getSuggestedDepartmentV1("order_id");
|
|
|
17487
17440
|
<dl>
|
|
17488
17441
|
<dd>
|
|
17489
17442
|
|
|
17490
|
-
|
|
17443
|
+
Updates department_id for the caller's role on the order. Coordinator writes coordinator_department_id; executor writes executor_department_id on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateDepartmentReq) -> (bool)
|
|
17491
17444
|
|
|
17492
17445
|
</dd>
|
|
17493
17446
|
</dl>
|
|
@@ -17503,10 +17456,7 @@ Returns distinct label values matching the query for orders where the caller is
|
|
|
17503
17456
|
<dd>
|
|
17504
17457
|
|
|
17505
17458
|
```typescript
|
|
17506
|
-
await client.shipping.orders.
|
|
17507
|
-
query: "query",
|
|
17508
|
-
limit: 1,
|
|
17509
|
-
});
|
|
17459
|
+
await client.shipping.orders.updateDepartmentV1("order_id");
|
|
17510
17460
|
```
|
|
17511
17461
|
|
|
17512
17462
|
</dd>
|
|
@@ -17522,73 +17472,15 @@ await client.shipping.orders.typeaheadLabelV1({
|
|
|
17522
17472
|
<dl>
|
|
17523
17473
|
<dd>
|
|
17524
17474
|
|
|
17525
|
-
**
|
|
17526
|
-
|
|
17527
|
-
</dd>
|
|
17528
|
-
</dl>
|
|
17529
|
-
|
|
17530
|
-
<dl>
|
|
17531
|
-
<dd>
|
|
17532
|
-
|
|
17533
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
17534
|
-
|
|
17535
|
-
</dd>
|
|
17536
|
-
</dl>
|
|
17537
|
-
</dd>
|
|
17538
|
-
</dl>
|
|
17539
|
-
|
|
17540
|
-
</dd>
|
|
17541
|
-
</dl>
|
|
17542
|
-
</details>
|
|
17543
|
-
|
|
17544
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.OrderTypeaheadResult[]</code></summary>
|
|
17545
|
-
<dl>
|
|
17546
|
-
<dd>
|
|
17547
|
-
|
|
17548
|
-
#### 📝 Description
|
|
17549
|
-
|
|
17550
|
-
<dl>
|
|
17551
|
-
<dd>
|
|
17552
|
-
|
|
17553
|
-
<dl>
|
|
17554
|
-
<dd>
|
|
17555
|
-
|
|
17556
|
-
Returns distinct order short ID, off-CHRT reference ID, and AWB values matching the query via case-insensitive regex. Searches visible non-draft orders and caller-created draft orders. | authz: allowed_org_types=[provider, shipper], min_org_role=operator | () -> (list[OrderTypeaheadResult])
|
|
17557
|
-
|
|
17558
|
-
</dd>
|
|
17559
|
-
</dl>
|
|
17560
|
-
</dd>
|
|
17561
|
-
</dl>
|
|
17562
|
-
|
|
17563
|
-
#### 🔌 Usage
|
|
17564
|
-
|
|
17565
|
-
<dl>
|
|
17566
|
-
<dd>
|
|
17567
|
-
|
|
17568
|
-
<dl>
|
|
17569
|
-
<dd>
|
|
17570
|
-
|
|
17571
|
-
```typescript
|
|
17572
|
-
await client.shipping.orders.typeaheadV1({
|
|
17573
|
-
query: "query",
|
|
17574
|
-
limit: 1,
|
|
17575
|
-
});
|
|
17576
|
-
```
|
|
17475
|
+
**orderId:** `string`
|
|
17577
17476
|
|
|
17578
17477
|
</dd>
|
|
17579
17478
|
</dl>
|
|
17580
|
-
</dd>
|
|
17581
|
-
</dl>
|
|
17582
|
-
|
|
17583
|
-
#### ⚙️ Parameters
|
|
17584
|
-
|
|
17585
|
-
<dl>
|
|
17586
|
-
<dd>
|
|
17587
17479
|
|
|
17588
17480
|
<dl>
|
|
17589
17481
|
<dd>
|
|
17590
17482
|
|
|
17591
|
-
**request:** `Chrt.shipping.
|
|
17483
|
+
**request:** `Chrt.shipping.OrdersUpdateDepartmentReq`
|
|
17592
17484
|
|
|
17593
17485
|
</dd>
|
|
17594
17486
|
</dl>
|
|
@@ -17607,7 +17499,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
17607
17499
|
</dl>
|
|
17608
17500
|
</details>
|
|
17609
17501
|
|
|
17610
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17502
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateDraftV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateDraftRes</code></summary>
|
|
17611
17503
|
<dl>
|
|
17612
17504
|
<dd>
|
|
17613
17505
|
|
|
@@ -17619,7 +17511,7 @@ await client.shipping.orders.typeaheadV1({
|
|
|
17619
17511
|
<dl>
|
|
17620
17512
|
<dd>
|
|
17621
17513
|
|
|
17622
|
-
|
|
17514
|
+
Updates service-line and organization assignments on a draft order. | authz_personas=[draft_creator_org_operator] | (OrdersUpdateDraftReq) -> (OrdersUpdateDraftRes)
|
|
17623
17515
|
|
|
17624
17516
|
</dd>
|
|
17625
17517
|
</dl>
|
|
@@ -17635,9 +17527,7 @@ Removes operator(s) from the caller's assignees on the order. Coordinator writes
|
|
|
17635
17527
|
<dd>
|
|
17636
17528
|
|
|
17637
17529
|
```typescript
|
|
17638
|
-
await client.shipping.orders.
|
|
17639
|
-
operator_user_ids: ["operator_user_ids"],
|
|
17640
|
-
});
|
|
17530
|
+
await client.shipping.orders.updateDraftV1("order_id");
|
|
17641
17531
|
```
|
|
17642
17532
|
|
|
17643
17533
|
</dd>
|
|
@@ -17661,7 +17551,7 @@ await client.shipping.orders.unassignV1("order_id", {
|
|
|
17661
17551
|
<dl>
|
|
17662
17552
|
<dd>
|
|
17663
17553
|
|
|
17664
|
-
**request:** `Chrt.shipping.
|
|
17554
|
+
**request:** `Chrt.shipping.OrdersUpdateDraftReq`
|
|
17665
17555
|
|
|
17666
17556
|
</dd>
|
|
17667
17557
|
</dl>
|
|
@@ -17680,7 +17570,7 @@ await client.shipping.orders.unassignV1("order_id", {
|
|
|
17680
17570
|
</dl>
|
|
17681
17571
|
</details>
|
|
17682
17572
|
|
|
17683
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17573
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateLabelV1</a>(orderId, { ...params }) -> boolean</code></summary>
|
|
17684
17574
|
<dl>
|
|
17685
17575
|
<dd>
|
|
17686
17576
|
|
|
@@ -17692,7 +17582,7 @@ await client.shipping.orders.unassignV1("order_id", {
|
|
|
17692
17582
|
<dl>
|
|
17693
17583
|
<dd>
|
|
17694
17584
|
|
|
17695
|
-
Updates
|
|
17585
|
+
Updates label for the caller's role on the order. Coordinator writes coordinator_label; executor writes executor_label on matching task_group_details rows. | authz_personas=[coordinator_org_operators, order_executor_org_operators] | (OrdersUpdateLabelReq) -> (bool)
|
|
17696
17586
|
|
|
17697
17587
|
</dd>
|
|
17698
17588
|
</dl>
|
|
@@ -17708,7 +17598,7 @@ Updates department_id for the caller's role on the order. Coordinator writes coo
|
|
|
17708
17598
|
<dd>
|
|
17709
17599
|
|
|
17710
17600
|
```typescript
|
|
17711
|
-
await client.shipping.orders.
|
|
17601
|
+
await client.shipping.orders.updateLabelV1("order_id");
|
|
17712
17602
|
```
|
|
17713
17603
|
|
|
17714
17604
|
</dd>
|
|
@@ -17732,7 +17622,7 @@ await client.shipping.orders.updateDepartmentV1("order_id");
|
|
|
17732
17622
|
<dl>
|
|
17733
17623
|
<dd>
|
|
17734
17624
|
|
|
17735
|
-
**request:** `Chrt.shipping.
|
|
17625
|
+
**request:** `Chrt.shipping.OrdersUpdateLabelReq`
|
|
17736
17626
|
|
|
17737
17627
|
</dd>
|
|
17738
17628
|
</dl>
|
|
@@ -17751,7 +17641,7 @@ await client.shipping.orders.updateDepartmentV1("order_id");
|
|
|
17751
17641
|
</dl>
|
|
17752
17642
|
</details>
|
|
17753
17643
|
|
|
17754
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17644
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">updateOffChrtReferenceIdV1</a>(orderId, { ...params }) -> Chrt.OrdersUpdateOffChrtReferenceIdRes</code></summary>
|
|
17755
17645
|
<dl>
|
|
17756
17646
|
<dd>
|
|
17757
17647
|
|
|
@@ -17763,7 +17653,7 @@ await client.shipping.orders.updateDepartmentV1("order_id");
|
|
|
17763
17653
|
<dl>
|
|
17764
17654
|
<dd>
|
|
17765
17655
|
|
|
17766
|
-
Updates
|
|
17656
|
+
Updates off_chrt_reference_id on an order. Drafts require the creating org's operator; operational orders require the order creator org's operator. | authz_personas=[draft_creator_org_operator, order_creator_org_operators] | (OrdersUpdateOffChrtReferenceIdReq) -> (OrdersUpdateOffChrtReferenceIdRes)
|
|
17767
17657
|
|
|
17768
17658
|
</dd>
|
|
17769
17659
|
</dl>
|
|
@@ -17779,7 +17669,7 @@ Updates label for the caller's role on the order. Coordinator writes coordinator
|
|
|
17779
17669
|
<dd>
|
|
17780
17670
|
|
|
17781
17671
|
```typescript
|
|
17782
|
-
await client.shipping.orders.
|
|
17672
|
+
await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
17783
17673
|
```
|
|
17784
17674
|
|
|
17785
17675
|
</dd>
|
|
@@ -17803,7 +17693,7 @@ await client.shipping.orders.updateLabelV1("order_id");
|
|
|
17803
17693
|
<dl>
|
|
17804
17694
|
<dd>
|
|
17805
17695
|
|
|
17806
|
-
**request:** `Chrt.shipping.
|
|
17696
|
+
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
17807
17697
|
|
|
17808
17698
|
</dd>
|
|
17809
17699
|
</dl>
|
|
@@ -17822,7 +17712,7 @@ await client.shipping.orders.updateLabelV1("order_id");
|
|
|
17822
17712
|
</dl>
|
|
17823
17713
|
</details>
|
|
17824
17714
|
|
|
17825
|
-
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">
|
|
17715
|
+
<details><summary><code>client.shipping.orders.<a href="/src/api/resources/shipping/resources/orders/client/Client.ts">validateDraftV1</a>(orderId) -> Chrt.OrderDraftValidationResult</code></summary>
|
|
17826
17716
|
<dl>
|
|
17827
17717
|
<dd>
|
|
17828
17718
|
|
|
@@ -17834,7 +17724,7 @@ await client.shipping.orders.updateLabelV1("order_id");
|
|
|
17834
17724
|
<dl>
|
|
17835
17725
|
<dd>
|
|
17836
17726
|
|
|
17837
|
-
|
|
17727
|
+
Validates a draft order for staging and returns requirement results. | authz_personas=[draft_creator_org_operator] | () -> (OrderDraftValidationResult)
|
|
17838
17728
|
|
|
17839
17729
|
</dd>
|
|
17840
17730
|
</dl>
|
|
@@ -17850,7 +17740,7 @@ Updates off_chrt_reference_id on an order. Drafts require the creating org's ope
|
|
|
17850
17740
|
<dd>
|
|
17851
17741
|
|
|
17852
17742
|
```typescript
|
|
17853
|
-
await client.shipping.orders.
|
|
17743
|
+
await client.shipping.orders.validateDraftV1("order_id");
|
|
17854
17744
|
```
|
|
17855
17745
|
|
|
17856
17746
|
</dd>
|
|
@@ -17874,14 +17764,6 @@ await client.shipping.orders.updateOffChrtReferenceIdV1("order_id");
|
|
|
17874
17764
|
<dl>
|
|
17875
17765
|
<dd>
|
|
17876
17766
|
|
|
17877
|
-
**request:** `Chrt.shipping.OrdersUpdateOffChrtReferenceIdReq`
|
|
17878
|
-
|
|
17879
|
-
</dd>
|
|
17880
|
-
</dl>
|
|
17881
|
-
|
|
17882
|
-
<dl>
|
|
17883
|
-
<dd>
|
|
17884
|
-
|
|
17885
17767
|
**requestOptions:** `Orders.RequestOptions`
|
|
17886
17768
|
|
|
17887
17769
|
</dd>
|
|
@@ -20911,432 +20793,9 @@ Updates a task in an active order template. | authz: min_org_role=operator | (Or
|
|
|
20911
20793
|
|
|
20912
20794
|
<dl>
|
|
20913
20795
|
<dd>
|
|
20914
|
-
|
|
20915
|
-
```typescript
|
|
20916
|
-
await client.shipping.orderTemplatesNew.tasks.patchUpdateV1("order_template_id", "task_key");
|
|
20917
|
-
```
|
|
20918
|
-
|
|
20919
|
-
</dd>
|
|
20920
|
-
</dl>
|
|
20921
|
-
</dd>
|
|
20922
|
-
</dl>
|
|
20923
|
-
|
|
20924
|
-
#### ⚙️ Parameters
|
|
20925
|
-
|
|
20926
|
-
<dl>
|
|
20927
|
-
<dd>
|
|
20928
|
-
|
|
20929
|
-
<dl>
|
|
20930
|
-
<dd>
|
|
20931
|
-
|
|
20932
|
-
**orderTemplateId:** `string`
|
|
20933
|
-
|
|
20934
|
-
</dd>
|
|
20935
|
-
</dl>
|
|
20936
|
-
|
|
20937
|
-
<dl>
|
|
20938
|
-
<dd>
|
|
20939
|
-
|
|
20940
|
-
**taskKey:** `string`
|
|
20941
|
-
|
|
20942
|
-
</dd>
|
|
20943
|
-
</dl>
|
|
20944
|
-
|
|
20945
|
-
<dl>
|
|
20946
|
-
<dd>
|
|
20947
|
-
|
|
20948
|
-
**request:** `Chrt.shipping.orderTemplatesNew.OrderTemplateNewTaskClientUpdate1`
|
|
20949
|
-
|
|
20950
|
-
</dd>
|
|
20951
|
-
</dl>
|
|
20952
|
-
|
|
20953
|
-
<dl>
|
|
20954
|
-
<dd>
|
|
20955
|
-
|
|
20956
|
-
**requestOptions:** `Tasks.RequestOptions`
|
|
20957
|
-
|
|
20958
|
-
</dd>
|
|
20959
|
-
</dl>
|
|
20960
|
-
</dd>
|
|
20961
|
-
</dl>
|
|
20962
|
-
|
|
20963
|
-
</dd>
|
|
20964
|
-
</dl>
|
|
20965
|
-
</details>
|
|
20966
|
-
|
|
20967
|
-
## Shipping Orders Cargo
|
|
20968
|
-
|
|
20969
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
20970
|
-
<dl>
|
|
20971
|
-
<dd>
|
|
20972
|
-
|
|
20973
|
-
#### 📝 Description
|
|
20974
|
-
|
|
20975
|
-
<dl>
|
|
20976
|
-
<dd>
|
|
20977
|
-
|
|
20978
|
-
<dl>
|
|
20979
|
-
<dd>
|
|
20980
|
-
|
|
20981
|
-
Adds cargo to an order with lifecycle-specific authorization and initial status. | (OrdersAddCargoReq) -> (PydanticObjectId)
|
|
20982
|
-
|
|
20983
|
-
</dd>
|
|
20984
|
-
</dl>
|
|
20985
|
-
</dd>
|
|
20986
|
-
</dl>
|
|
20987
|
-
|
|
20988
|
-
#### 🔌 Usage
|
|
20989
|
-
|
|
20990
|
-
<dl>
|
|
20991
|
-
<dd>
|
|
20992
|
-
|
|
20993
|
-
<dl>
|
|
20994
|
-
<dd>
|
|
20995
|
-
|
|
20996
|
-
```typescript
|
|
20997
|
-
await client.shipping.orders.cargo.addV1({
|
|
20998
|
-
cargo: {
|
|
20999
|
-
cargo_type: "spare_parts",
|
|
21000
|
-
schema_version: 1,
|
|
21001
|
-
},
|
|
21002
|
-
order_id: "order_id",
|
|
21003
|
-
});
|
|
21004
|
-
```
|
|
21005
|
-
|
|
21006
|
-
</dd>
|
|
21007
|
-
</dl>
|
|
21008
|
-
</dd>
|
|
21009
|
-
</dl>
|
|
21010
|
-
|
|
21011
|
-
#### ⚙️ Parameters
|
|
21012
|
-
|
|
21013
|
-
<dl>
|
|
21014
|
-
<dd>
|
|
21015
|
-
|
|
21016
|
-
<dl>
|
|
21017
|
-
<dd>
|
|
21018
|
-
|
|
21019
|
-
**request:** `Chrt.shipping.orders.OrdersAddCargoReq`
|
|
21020
|
-
|
|
21021
|
-
</dd>
|
|
21022
|
-
</dl>
|
|
21023
|
-
|
|
21024
|
-
<dl>
|
|
21025
|
-
<dd>
|
|
21026
|
-
|
|
21027
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
21028
|
-
|
|
21029
|
-
</dd>
|
|
21030
|
-
</dl>
|
|
21031
|
-
</dd>
|
|
21032
|
-
</dl>
|
|
21033
|
-
|
|
21034
|
-
</dd>
|
|
21035
|
-
</dl>
|
|
21036
|
-
</details>
|
|
21037
|
-
|
|
21038
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
21039
|
-
<dl>
|
|
21040
|
-
<dd>
|
|
21041
|
-
|
|
21042
|
-
#### 📝 Description
|
|
21043
|
-
|
|
21044
|
-
<dl>
|
|
21045
|
-
<dd>
|
|
21046
|
-
|
|
21047
|
-
<dl>
|
|
21048
|
-
<dd>
|
|
21049
|
-
|
|
21050
|
-
Associates cargo with an order task and updates operational cargo status when applicable. | (OrdersAssociateCargoWithTaskReq) -> (bool)
|
|
21051
|
-
|
|
21052
|
-
</dd>
|
|
21053
|
-
</dl>
|
|
21054
|
-
</dd>
|
|
21055
|
-
</dl>
|
|
21056
|
-
|
|
21057
|
-
#### 🔌 Usage
|
|
21058
|
-
|
|
21059
|
-
<dl>
|
|
21060
|
-
<dd>
|
|
21061
|
-
|
|
21062
|
-
<dl>
|
|
21063
|
-
<dd>
|
|
21064
|
-
|
|
21065
|
-
```typescript
|
|
21066
|
-
await client.shipping.orders.cargo.associateWithTaskV1({
|
|
21067
|
-
cargo_id: "cargo_id",
|
|
21068
|
-
order_id: "order_id",
|
|
21069
|
-
task_id: "task_id",
|
|
21070
|
-
});
|
|
21071
|
-
```
|
|
21072
|
-
|
|
21073
|
-
</dd>
|
|
21074
|
-
</dl>
|
|
21075
|
-
</dd>
|
|
21076
|
-
</dl>
|
|
21077
|
-
|
|
21078
|
-
#### ⚙️ Parameters
|
|
21079
|
-
|
|
21080
|
-
<dl>
|
|
21081
|
-
<dd>
|
|
21082
|
-
|
|
21083
|
-
<dl>
|
|
21084
|
-
<dd>
|
|
21085
|
-
|
|
21086
|
-
**request:** `Chrt.shipping.orders.OrdersAssociateCargoWithTaskReq`
|
|
21087
|
-
|
|
21088
|
-
</dd>
|
|
21089
|
-
</dl>
|
|
21090
|
-
|
|
21091
|
-
<dl>
|
|
21092
|
-
<dd>
|
|
21093
|
-
|
|
21094
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
21095
|
-
|
|
21096
|
-
</dd>
|
|
21097
|
-
</dl>
|
|
21098
|
-
</dd>
|
|
21099
|
-
</dl>
|
|
21100
|
-
|
|
21101
|
-
</dd>
|
|
21102
|
-
</dl>
|
|
21103
|
-
</details>
|
|
21104
|
-
|
|
21105
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">duplicateV1</a>(cargoId) -> string</code></summary>
|
|
21106
|
-
<dl>
|
|
21107
|
-
<dd>
|
|
21108
|
-
|
|
21109
|
-
#### 📝 Description
|
|
21110
|
-
|
|
21111
|
-
<dl>
|
|
21112
|
-
<dd>
|
|
21113
|
-
|
|
21114
|
-
<dl>
|
|
21115
|
-
<dd>
|
|
21116
|
-
|
|
21117
|
-
Duplicates cargo and all of its task associations within an order. | () -> (PydanticObjectId)
|
|
21118
|
-
|
|
21119
|
-
</dd>
|
|
21120
|
-
</dl>
|
|
21121
|
-
</dd>
|
|
21122
|
-
</dl>
|
|
21123
|
-
|
|
21124
|
-
#### 🔌 Usage
|
|
21125
|
-
|
|
21126
|
-
<dl>
|
|
21127
|
-
<dd>
|
|
21128
|
-
|
|
21129
|
-
<dl>
|
|
21130
|
-
<dd>
|
|
21131
|
-
|
|
21132
|
-
```typescript
|
|
21133
|
-
await client.shipping.orders.cargo.duplicateV1("cargo_id");
|
|
21134
|
-
```
|
|
21135
|
-
|
|
21136
|
-
</dd>
|
|
21137
|
-
</dl>
|
|
21138
|
-
</dd>
|
|
21139
|
-
</dl>
|
|
21140
|
-
|
|
21141
|
-
#### ⚙️ Parameters
|
|
21142
|
-
|
|
21143
|
-
<dl>
|
|
21144
|
-
<dd>
|
|
21145
|
-
|
|
21146
|
-
<dl>
|
|
21147
|
-
<dd>
|
|
21148
|
-
|
|
21149
|
-
**cargoId:** `string`
|
|
21150
|
-
|
|
21151
|
-
</dd>
|
|
21152
|
-
</dl>
|
|
21153
|
-
|
|
21154
|
-
<dl>
|
|
21155
|
-
<dd>
|
|
21156
|
-
|
|
21157
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
21158
|
-
|
|
21159
|
-
</dd>
|
|
21160
|
-
</dl>
|
|
21161
|
-
</dd>
|
|
21162
|
-
</dl>
|
|
21163
|
-
|
|
21164
|
-
</dd>
|
|
21165
|
-
</dl>
|
|
21166
|
-
</details>
|
|
21167
|
-
|
|
21168
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">unassociateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
21169
|
-
<dl>
|
|
21170
|
-
<dd>
|
|
21171
|
-
|
|
21172
|
-
#### 📝 Description
|
|
21173
|
-
|
|
21174
|
-
<dl>
|
|
21175
|
-
<dd>
|
|
21176
|
-
|
|
21177
|
-
<dl>
|
|
21178
|
-
<dd>
|
|
21179
|
-
|
|
21180
|
-
Removes cargo from an order task and updates operational cargo status when applicable. | (OrdersUnassociateCargoWithTaskReq) -> (bool)
|
|
21181
|
-
|
|
21182
|
-
</dd>
|
|
21183
|
-
</dl>
|
|
21184
|
-
</dd>
|
|
21185
|
-
</dl>
|
|
21186
|
-
|
|
21187
|
-
#### 🔌 Usage
|
|
21188
|
-
|
|
21189
|
-
<dl>
|
|
21190
|
-
<dd>
|
|
21191
|
-
|
|
21192
|
-
<dl>
|
|
21193
|
-
<dd>
|
|
21194
|
-
|
|
21195
|
-
```typescript
|
|
21196
|
-
await client.shipping.orders.cargo.unassociateWithTaskV1({
|
|
21197
|
-
cargo_id: "cargo_id",
|
|
21198
|
-
order_id: "order_id",
|
|
21199
|
-
task_id: "task_id",
|
|
21200
|
-
});
|
|
21201
|
-
```
|
|
21202
|
-
|
|
21203
|
-
</dd>
|
|
21204
|
-
</dl>
|
|
21205
|
-
</dd>
|
|
21206
|
-
</dl>
|
|
21207
|
-
|
|
21208
|
-
#### ⚙️ Parameters
|
|
21209
|
-
|
|
21210
|
-
<dl>
|
|
21211
|
-
<dd>
|
|
21212
|
-
|
|
21213
|
-
<dl>
|
|
21214
|
-
<dd>
|
|
21215
|
-
|
|
21216
|
-
**request:** `Chrt.shipping.orders.OrdersUnassociateCargoWithTaskReq`
|
|
21217
|
-
|
|
21218
|
-
</dd>
|
|
21219
|
-
</dl>
|
|
21220
|
-
|
|
21221
|
-
<dl>
|
|
21222
|
-
<dd>
|
|
21223
|
-
|
|
21224
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
21225
|
-
|
|
21226
|
-
</dd>
|
|
21227
|
-
</dl>
|
|
21228
|
-
</dd>
|
|
21229
|
-
</dl>
|
|
21230
|
-
|
|
21231
|
-
</dd>
|
|
21232
|
-
</dl>
|
|
21233
|
-
</details>
|
|
21234
|
-
|
|
21235
|
-
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
21236
|
-
<dl>
|
|
21237
|
-
<dd>
|
|
21238
|
-
|
|
21239
|
-
#### 📝 Description
|
|
21240
|
-
|
|
21241
|
-
<dl>
|
|
21242
|
-
<dd>
|
|
21243
|
-
|
|
21244
|
-
<dl>
|
|
21245
|
-
<dd>
|
|
21246
|
-
|
|
21247
|
-
Updates cargo details and synchronizes the parent order's AWB list. | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
21248
|
-
|
|
21249
|
-
</dd>
|
|
21250
|
-
</dl>
|
|
21251
|
-
</dd>
|
|
21252
|
-
</dl>
|
|
21253
|
-
|
|
21254
|
-
#### 🔌 Usage
|
|
21255
|
-
|
|
21256
|
-
<dl>
|
|
21257
|
-
<dd>
|
|
21258
|
-
|
|
21259
|
-
<dl>
|
|
21260
|
-
<dd>
|
|
21261
|
-
|
|
21262
|
-
```typescript
|
|
21263
|
-
await client.shipping.orders.cargo.updateV1("cargo_id");
|
|
21264
|
-
```
|
|
21265
|
-
|
|
21266
|
-
</dd>
|
|
21267
|
-
</dl>
|
|
21268
|
-
</dd>
|
|
21269
|
-
</dl>
|
|
21270
|
-
|
|
21271
|
-
#### ⚙️ Parameters
|
|
21272
|
-
|
|
21273
|
-
<dl>
|
|
21274
|
-
<dd>
|
|
21275
|
-
|
|
21276
|
-
<dl>
|
|
21277
|
-
<dd>
|
|
21278
|
-
|
|
21279
|
-
**cargoId:** `string`
|
|
21280
|
-
|
|
21281
|
-
</dd>
|
|
21282
|
-
</dl>
|
|
21283
|
-
|
|
21284
|
-
<dl>
|
|
21285
|
-
<dd>
|
|
21286
|
-
|
|
21287
|
-
**request:** `Chrt.shipping.orders.CargoClientUpdate1`
|
|
21288
|
-
|
|
21289
|
-
</dd>
|
|
21290
|
-
</dl>
|
|
21291
|
-
|
|
21292
|
-
<dl>
|
|
21293
|
-
<dd>
|
|
21294
|
-
|
|
21295
|
-
**requestOptions:** `Cargo.RequestOptions`
|
|
21296
|
-
|
|
21297
|
-
</dd>
|
|
21298
|
-
</dl>
|
|
21299
|
-
</dd>
|
|
21300
|
-
</dl>
|
|
21301
|
-
|
|
21302
|
-
</dd>
|
|
21303
|
-
</dl>
|
|
21304
|
-
</details>
|
|
21305
|
-
|
|
21306
|
-
## Shipping Orders Drafts
|
|
21307
|
-
|
|
21308
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">addCoordinatorTaskListToApplyAtOrderStagingV1</a>(orderId, taskListId, { ...params }) -> boolean</code></summary>
|
|
21309
|
-
<dl>
|
|
21310
|
-
<dd>
|
|
21311
|
-
|
|
21312
|
-
#### 📝 Description
|
|
21313
|
-
|
|
21314
|
-
<dl>
|
|
21315
|
-
<dd>
|
|
21316
|
-
|
|
21317
|
-
<dl>
|
|
21318
|
-
<dd>
|
|
21319
|
-
|
|
21320
|
-
Adds a coordinator task list with an optional department override to apply when the draft order is staged. | authz_personas=[coordinator_org_operators] | (UTCDatetime | None) -> (bool)
|
|
21321
|
-
|
|
21322
|
-
</dd>
|
|
21323
|
-
</dl>
|
|
21324
|
-
</dd>
|
|
21325
|
-
</dl>
|
|
21326
|
-
|
|
21327
|
-
#### 🔌 Usage
|
|
21328
|
-
|
|
21329
|
-
<dl>
|
|
21330
|
-
<dd>
|
|
21331
|
-
|
|
21332
|
-
<dl>
|
|
21333
|
-
<dd>
|
|
21334
|
-
|
|
21335
|
-
```typescript
|
|
21336
|
-
await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV1("order_id", "task_list_id", {
|
|
21337
|
-
department_id: "department_id",
|
|
21338
|
-
body: "2024-01-15T09:30:00Z",
|
|
21339
|
-
});
|
|
20796
|
+
|
|
20797
|
+
```typescript
|
|
20798
|
+
await client.shipping.orderTemplatesNew.tasks.patchUpdateV1("order_template_id", "task_key");
|
|
21340
20799
|
```
|
|
21341
20800
|
|
|
21342
20801
|
</dd>
|
|
@@ -21352,7 +20811,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
21352
20811
|
<dl>
|
|
21353
20812
|
<dd>
|
|
21354
20813
|
|
|
21355
|
-
**
|
|
20814
|
+
**orderTemplateId:** `string`
|
|
21356
20815
|
|
|
21357
20816
|
</dd>
|
|
21358
20817
|
</dl>
|
|
@@ -21360,7 +20819,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
21360
20819
|
<dl>
|
|
21361
20820
|
<dd>
|
|
21362
20821
|
|
|
21363
|
-
**
|
|
20822
|
+
**taskKey:** `string`
|
|
21364
20823
|
|
|
21365
20824
|
</dd>
|
|
21366
20825
|
</dl>
|
|
@@ -21368,7 +20827,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
21368
20827
|
<dl>
|
|
21369
20828
|
<dd>
|
|
21370
20829
|
|
|
21371
|
-
**request:** `Chrt.shipping.
|
|
20830
|
+
**request:** `Chrt.shipping.orderTemplatesNew.OrderTemplateNewTaskClientUpdate1`
|
|
21372
20831
|
|
|
21373
20832
|
</dd>
|
|
21374
20833
|
</dl>
|
|
@@ -21376,7 +20835,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
21376
20835
|
<dl>
|
|
21377
20836
|
<dd>
|
|
21378
20837
|
|
|
21379
|
-
**requestOptions:** `
|
|
20838
|
+
**requestOptions:** `Tasks.RequestOptions`
|
|
21380
20839
|
|
|
21381
20840
|
</dd>
|
|
21382
20841
|
</dl>
|
|
@@ -21387,7 +20846,9 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
21387
20846
|
</dl>
|
|
21388
20847
|
</details>
|
|
21389
20848
|
|
|
21390
|
-
|
|
20849
|
+
## Shipping Orders Cargo
|
|
20850
|
+
|
|
20851
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">addV1</a>({ ...params }) -> string</code></summary>
|
|
21391
20852
|
<dl>
|
|
21392
20853
|
<dd>
|
|
21393
20854
|
|
|
@@ -21399,7 +20860,7 @@ await client.shipping.orders.drafts.addCoordinatorTaskListToApplyAtOrderStagingV
|
|
|
21399
20860
|
<dl>
|
|
21400
20861
|
<dd>
|
|
21401
20862
|
|
|
21402
|
-
|
|
20863
|
+
Adds cargo to an order with lifecycle-specific authorization and initial status. | (OrdersAddCargoReq) -> (PydanticObjectId)
|
|
21403
20864
|
|
|
21404
20865
|
</dd>
|
|
21405
20866
|
</dl>
|
|
@@ -21415,7 +20876,13 @@ Removes a pending coordinator staging task list from a draft order. | authz_pers
|
|
|
21415
20876
|
<dd>
|
|
21416
20877
|
|
|
21417
20878
|
```typescript
|
|
21418
|
-
await client.shipping.orders.
|
|
20879
|
+
await client.shipping.orders.cargo.addV1({
|
|
20880
|
+
cargo: {
|
|
20881
|
+
cargo_type: "spare_parts",
|
|
20882
|
+
schema_version: 1,
|
|
20883
|
+
},
|
|
20884
|
+
order_id: "order_id",
|
|
20885
|
+
});
|
|
21419
20886
|
```
|
|
21420
20887
|
|
|
21421
20888
|
</dd>
|
|
@@ -21431,15 +20898,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
21431
20898
|
<dl>
|
|
21432
20899
|
<dd>
|
|
21433
20900
|
|
|
21434
|
-
**
|
|
21435
|
-
|
|
21436
|
-
</dd>
|
|
21437
|
-
</dl>
|
|
21438
|
-
|
|
21439
|
-
<dl>
|
|
21440
|
-
<dd>
|
|
21441
|
-
|
|
21442
|
-
**taskListId:** `string`
|
|
20901
|
+
**request:** `Chrt.shipping.orders.OrdersAddCargoReq`
|
|
21443
20902
|
|
|
21444
20903
|
</dd>
|
|
21445
20904
|
</dl>
|
|
@@ -21447,7 +20906,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
21447
20906
|
<dl>
|
|
21448
20907
|
<dd>
|
|
21449
20908
|
|
|
21450
|
-
**requestOptions:** `
|
|
20909
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
21451
20910
|
|
|
21452
20911
|
</dd>
|
|
21453
20912
|
</dl>
|
|
@@ -21458,7 +20917,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
21458
20917
|
</dl>
|
|
21459
20918
|
</details>
|
|
21460
20919
|
|
|
21461
|
-
<details><summary><code>client.shipping.orders.
|
|
20920
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">associateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
21462
20921
|
<dl>
|
|
21463
20922
|
<dd>
|
|
21464
20923
|
|
|
@@ -21470,7 +20929,7 @@ await client.shipping.orders.drafts.removeCoordinatorTaskListToApplyAtOrderStagi
|
|
|
21470
20929
|
<dl>
|
|
21471
20930
|
<dd>
|
|
21472
20931
|
|
|
21473
|
-
|
|
20932
|
+
Associates cargo with an order task and updates operational cargo status when applicable. | (OrdersAssociateCargoWithTaskReq) -> (bool)
|
|
21474
20933
|
|
|
21475
20934
|
</dd>
|
|
21476
20935
|
</dl>
|
|
@@ -21486,7 +20945,11 @@ Creates a draft Order through one of three paths: (1) provide only order_templat
|
|
|
21486
20945
|
<dd>
|
|
21487
20946
|
|
|
21488
20947
|
```typescript
|
|
21489
|
-
await client.shipping.orders.
|
|
20948
|
+
await client.shipping.orders.cargo.associateWithTaskV1({
|
|
20949
|
+
cargo_id: "cargo_id",
|
|
20950
|
+
order_id: "order_id",
|
|
20951
|
+
task_id: "task_id",
|
|
20952
|
+
});
|
|
21490
20953
|
```
|
|
21491
20954
|
|
|
21492
20955
|
</dd>
|
|
@@ -21502,7 +20965,7 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
|
21502
20965
|
<dl>
|
|
21503
20966
|
<dd>
|
|
21504
20967
|
|
|
21505
|
-
**request:** `Chrt.shipping.orders.
|
|
20968
|
+
**request:** `Chrt.shipping.orders.OrdersAssociateCargoWithTaskReq`
|
|
21506
20969
|
|
|
21507
20970
|
</dd>
|
|
21508
20971
|
</dl>
|
|
@@ -21510,7 +20973,7 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
|
21510
20973
|
<dl>
|
|
21511
20974
|
<dd>
|
|
21512
20975
|
|
|
21513
|
-
**requestOptions:** `
|
|
20976
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
21514
20977
|
|
|
21515
20978
|
</dd>
|
|
21516
20979
|
</dl>
|
|
@@ -21521,7 +20984,7 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
|
21521
20984
|
</dl>
|
|
21522
20985
|
</details>
|
|
21523
20986
|
|
|
21524
|
-
<details><summary><code>client.shipping.orders.
|
|
20987
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">deleteV1</a>(cargoId) -> boolean</code></summary>
|
|
21525
20988
|
<dl>
|
|
21526
20989
|
<dd>
|
|
21527
20990
|
|
|
@@ -21533,7 +20996,7 @@ await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
|
21533
20996
|
<dl>
|
|
21534
20997
|
<dd>
|
|
21535
20998
|
|
|
21536
|
-
Deletes
|
|
20999
|
+
Deletes active cargo without completed task associations and resynchronizes the order AWB cache. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
|
|
21537
21000
|
|
|
21538
21001
|
</dd>
|
|
21539
21002
|
</dl>
|
|
@@ -21549,7 +21012,7 @@ Deletes a draft order and all associated entities. | authz_personas=[draft_creat
|
|
|
21549
21012
|
<dd>
|
|
21550
21013
|
|
|
21551
21014
|
```typescript
|
|
21552
|
-
await client.shipping.orders.
|
|
21015
|
+
await client.shipping.orders.cargo.deleteV1("cargo_id");
|
|
21553
21016
|
```
|
|
21554
21017
|
|
|
21555
21018
|
</dd>
|
|
@@ -21565,7 +21028,7 @@ await client.shipping.orders.drafts.deleteV1("order_id");
|
|
|
21565
21028
|
<dl>
|
|
21566
21029
|
<dd>
|
|
21567
21030
|
|
|
21568
|
-
**
|
|
21031
|
+
**cargoId:** `string`
|
|
21569
21032
|
|
|
21570
21033
|
</dd>
|
|
21571
21034
|
</dl>
|
|
@@ -21573,7 +21036,7 @@ await client.shipping.orders.drafts.deleteV1("order_id");
|
|
|
21573
21036
|
<dl>
|
|
21574
21037
|
<dd>
|
|
21575
21038
|
|
|
21576
|
-
**requestOptions:** `
|
|
21039
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
21577
21040
|
|
|
21578
21041
|
</dd>
|
|
21579
21042
|
</dl>
|
|
@@ -21584,7 +21047,7 @@ await client.shipping.orders.drafts.deleteV1("order_id");
|
|
|
21584
21047
|
</dl>
|
|
21585
21048
|
</details>
|
|
21586
21049
|
|
|
21587
|
-
<details><summary><code>client.shipping.orders.
|
|
21050
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">duplicateV1</a>(cargoId) -> string</code></summary>
|
|
21588
21051
|
<dl>
|
|
21589
21052
|
<dd>
|
|
21590
21053
|
|
|
@@ -21596,7 +21059,7 @@ await client.shipping.orders.drafts.deleteV1("order_id");
|
|
|
21596
21059
|
<dl>
|
|
21597
21060
|
<dd>
|
|
21598
21061
|
|
|
21599
|
-
|
|
21062
|
+
Duplicates cargo and all of its task associations within an order. | () -> (PydanticObjectId)
|
|
21600
21063
|
|
|
21601
21064
|
</dd>
|
|
21602
21065
|
</dl>
|
|
@@ -21612,9 +21075,7 @@ Deletes multiple draft orders and associated entities. | authz_personas=[draft_c
|
|
|
21612
21075
|
<dd>
|
|
21613
21076
|
|
|
21614
21077
|
```typescript
|
|
21615
|
-
await client.shipping.orders.
|
|
21616
|
-
order_ids: ["order_ids"],
|
|
21617
|
-
});
|
|
21078
|
+
await client.shipping.orders.cargo.duplicateV1("cargo_id");
|
|
21618
21079
|
```
|
|
21619
21080
|
|
|
21620
21081
|
</dd>
|
|
@@ -21630,7 +21091,7 @@ await client.shipping.orders.drafts.deleteManyV1({
|
|
|
21630
21091
|
<dl>
|
|
21631
21092
|
<dd>
|
|
21632
21093
|
|
|
21633
|
-
**
|
|
21094
|
+
**cargoId:** `string`
|
|
21634
21095
|
|
|
21635
21096
|
</dd>
|
|
21636
21097
|
</dl>
|
|
@@ -21638,7 +21099,7 @@ await client.shipping.orders.drafts.deleteManyV1({
|
|
|
21638
21099
|
<dl>
|
|
21639
21100
|
<dd>
|
|
21640
21101
|
|
|
21641
|
-
**requestOptions:** `
|
|
21102
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
21642
21103
|
|
|
21643
21104
|
</dd>
|
|
21644
21105
|
</dl>
|
|
@@ -21649,7 +21110,7 @@ await client.shipping.orders.drafts.deleteManyV1({
|
|
|
21649
21110
|
</dl>
|
|
21650
21111
|
</details>
|
|
21651
21112
|
|
|
21652
|
-
<details><summary><code>client.shipping.orders.
|
|
21113
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">unassociateWithTaskV1</a>({ ...params }) -> boolean</code></summary>
|
|
21653
21114
|
<dl>
|
|
21654
21115
|
<dd>
|
|
21655
21116
|
|
|
@@ -21661,7 +21122,7 @@ await client.shipping.orders.drafts.deleteManyV1({
|
|
|
21661
21122
|
<dl>
|
|
21662
21123
|
<dd>
|
|
21663
21124
|
|
|
21664
|
-
|
|
21125
|
+
Removes cargo from an order task and updates operational cargo status when applicable. | (OrdersUnassociateCargoWithTaskReq) -> (bool)
|
|
21665
21126
|
|
|
21666
21127
|
</dd>
|
|
21667
21128
|
</dl>
|
|
@@ -21677,7 +21138,11 @@ Opens a new draft order shell with org assignments based on caller's organizatio
|
|
|
21677
21138
|
<dd>
|
|
21678
21139
|
|
|
21679
21140
|
```typescript
|
|
21680
|
-
await client.shipping.orders.
|
|
21141
|
+
await client.shipping.orders.cargo.unassociateWithTaskV1({
|
|
21142
|
+
cargo_id: "cargo_id",
|
|
21143
|
+
order_id: "order_id",
|
|
21144
|
+
task_id: "task_id",
|
|
21145
|
+
});
|
|
21681
21146
|
```
|
|
21682
21147
|
|
|
21683
21148
|
</dd>
|
|
@@ -21693,7 +21158,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21693
21158
|
<dl>
|
|
21694
21159
|
<dd>
|
|
21695
21160
|
|
|
21696
|
-
**request:** `Chrt.shipping.orders.
|
|
21161
|
+
**request:** `Chrt.shipping.orders.OrdersUnassociateCargoWithTaskReq`
|
|
21697
21162
|
|
|
21698
21163
|
</dd>
|
|
21699
21164
|
</dl>
|
|
@@ -21701,7 +21166,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21701
21166
|
<dl>
|
|
21702
21167
|
<dd>
|
|
21703
21168
|
|
|
21704
|
-
**requestOptions:** `
|
|
21169
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
21705
21170
|
|
|
21706
21171
|
</dd>
|
|
21707
21172
|
</dl>
|
|
@@ -21712,7 +21177,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21712
21177
|
</dl>
|
|
21713
21178
|
</details>
|
|
21714
21179
|
|
|
21715
|
-
<details><summary><code>client.shipping.orders.
|
|
21180
|
+
<details><summary><code>client.shipping.orders.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/cargo/client/Client.ts">updateV1</a>(cargoId, { ...params }) -> string</code></summary>
|
|
21716
21181
|
<dl>
|
|
21717
21182
|
<dd>
|
|
21718
21183
|
|
|
@@ -21724,7 +21189,7 @@ await client.shipping.orders.drafts.openV1();
|
|
|
21724
21189
|
<dl>
|
|
21725
21190
|
<dd>
|
|
21726
21191
|
|
|
21727
|
-
|
|
21192
|
+
Updates cargo details and synchronizes the parent order's AWB list. | (CargoClientUpdate1) -> (PydanticObjectId)
|
|
21728
21193
|
|
|
21729
21194
|
</dd>
|
|
21730
21195
|
</dl>
|
|
@@ -21740,9 +21205,7 @@ Sets the ordering of task groups within a draft order. Must provide all task gro
|
|
|
21740
21205
|
<dd>
|
|
21741
21206
|
|
|
21742
21207
|
```typescript
|
|
21743
|
-
await client.shipping.orders.
|
|
21744
|
-
task_group_ids: ["task_group_ids"],
|
|
21745
|
-
});
|
|
21208
|
+
await client.shipping.orders.cargo.updateV1("cargo_id");
|
|
21746
21209
|
```
|
|
21747
21210
|
|
|
21748
21211
|
</dd>
|
|
@@ -21758,7 +21221,7 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21758
21221
|
<dl>
|
|
21759
21222
|
<dd>
|
|
21760
21223
|
|
|
21761
|
-
**
|
|
21224
|
+
**cargoId:** `string`
|
|
21762
21225
|
|
|
21763
21226
|
</dd>
|
|
21764
21227
|
</dl>
|
|
@@ -21766,7 +21229,7 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21766
21229
|
<dl>
|
|
21767
21230
|
<dd>
|
|
21768
21231
|
|
|
21769
|
-
**request:** `Chrt.shipping.orders.
|
|
21232
|
+
**request:** `Chrt.shipping.orders.CargoClientUpdate1`
|
|
21770
21233
|
|
|
21771
21234
|
</dd>
|
|
21772
21235
|
</dl>
|
|
@@ -21774,7 +21237,7 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21774
21237
|
<dl>
|
|
21775
21238
|
<dd>
|
|
21776
21239
|
|
|
21777
|
-
**requestOptions:** `
|
|
21240
|
+
**requestOptions:** `Cargo.RequestOptions`
|
|
21778
21241
|
|
|
21779
21242
|
</dd>
|
|
21780
21243
|
</dl>
|
|
@@ -21785,7 +21248,9 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21785
21248
|
</dl>
|
|
21786
21249
|
</details>
|
|
21787
21250
|
|
|
21788
|
-
|
|
21251
|
+
## Shipping Orders Drafts
|
|
21252
|
+
|
|
21253
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">createFromOrderTemplateNewV1</a>({ ...params }) -> Chrt.OrdersOpenDraftRes</code></summary>
|
|
21789
21254
|
<dl>
|
|
21790
21255
|
<dd>
|
|
21791
21256
|
|
|
@@ -21797,7 +21262,7 @@ await client.shipping.orders.drafts.setTaskGroupOrderingV1("order_id", {
|
|
|
21797
21262
|
<dl>
|
|
21798
21263
|
<dd>
|
|
21799
21264
|
|
|
21800
|
-
|
|
21265
|
+
Creates a draft Order through one of three paths: (1) provide only order_template_new_id to load the saved template's core and record that template as the Order's provenance; (2) provide only order_template_new_core to materialize an ad hoc submitted core without template provenance; (3) provide both to record and validate the saved template as provenance while materializing the submitted core, without modifying the saved template. | authz: min_org_role=operator | (OrdersCreateDraftFromOrderTemplateNewReq) -> (OrdersOpenDraftRes)
|
|
21801
21266
|
|
|
21802
21267
|
</dd>
|
|
21803
21268
|
</dl>
|
|
@@ -21813,7 +21278,7 @@ Updates coordinator and/or shipper org assignments for a draft order. | authz_pe
|
|
|
21813
21278
|
<dd>
|
|
21814
21279
|
|
|
21815
21280
|
```typescript
|
|
21816
|
-
await client.shipping.orders.drafts.
|
|
21281
|
+
await client.shipping.orders.drafts.createFromOrderTemplateNewV1();
|
|
21817
21282
|
```
|
|
21818
21283
|
|
|
21819
21284
|
</dd>
|
|
@@ -21829,15 +21294,7 @@ await client.shipping.orders.drafts.updateV1("order_id");
|
|
|
21829
21294
|
<dl>
|
|
21830
21295
|
<dd>
|
|
21831
21296
|
|
|
21832
|
-
**
|
|
21833
|
-
|
|
21834
|
-
</dd>
|
|
21835
|
-
</dl>
|
|
21836
|
-
|
|
21837
|
-
<dl>
|
|
21838
|
-
<dd>
|
|
21839
|
-
|
|
21840
|
-
**request:** `Chrt.shipping.orders.OrdersDraftUpdateReq`
|
|
21297
|
+
**request:** `Chrt.shipping.orders.OrdersCreateDraftFromOrderTemplateNewReq`
|
|
21841
21298
|
|
|
21842
21299
|
</dd>
|
|
21843
21300
|
</dl>
|
|
@@ -21856,7 +21313,7 @@ await client.shipping.orders.drafts.updateV1("order_id");
|
|
|
21856
21313
|
</dl>
|
|
21857
21314
|
</details>
|
|
21858
21315
|
|
|
21859
|
-
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">
|
|
21316
|
+
<details><summary><code>client.shipping.orders.drafts.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/client/Client.ts">openV1</a>({ ...params }) -> Chrt.OrdersOpenDraftRes</code></summary>
|
|
21860
21317
|
<dl>
|
|
21861
21318
|
<dd>
|
|
21862
21319
|
|
|
@@ -21868,7 +21325,7 @@ await client.shipping.orders.drafts.updateV1("order_id");
|
|
|
21868
21325
|
<dl>
|
|
21869
21326
|
<dd>
|
|
21870
21327
|
|
|
21871
|
-
|
|
21328
|
+
Opens a new draft order shell with org assignments based on caller's organization type. | authz: min_org_role=operator | (OrdersOpenDraftReq) -> (OrdersOpenDraftRes)
|
|
21872
21329
|
|
|
21873
21330
|
</dd>
|
|
21874
21331
|
</dl>
|
|
@@ -21884,7 +21341,7 @@ Validates the draft order for staging and returns requirement results. | () -> (
|
|
|
21884
21341
|
<dd>
|
|
21885
21342
|
|
|
21886
21343
|
```typescript
|
|
21887
|
-
await client.shipping.orders.drafts.
|
|
21344
|
+
await client.shipping.orders.drafts.openV1();
|
|
21888
21345
|
```
|
|
21889
21346
|
|
|
21890
21347
|
</dd>
|
|
@@ -21900,7 +21357,7 @@ await client.shipping.orders.drafts.validateV1("order_id");
|
|
|
21900
21357
|
<dl>
|
|
21901
21358
|
<dd>
|
|
21902
21359
|
|
|
21903
|
-
**
|
|
21360
|
+
**request:** `Chrt.shipping.orders.OrdersOpenDraftReq`
|
|
21904
21361
|
|
|
21905
21362
|
</dd>
|
|
21906
21363
|
</dl>
|
|
@@ -22725,7 +22182,7 @@ await client.shipping.orders.taskGroup.addExecutorV1("task_group_id");
|
|
|
22725
22182
|
</dl>
|
|
22726
22183
|
</details>
|
|
22727
22184
|
|
|
22728
|
-
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">
|
|
22185
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">deleteV1</a>(taskGroupId) -> boolean</code></summary>
|
|
22729
22186
|
<dl>
|
|
22730
22187
|
<dd>
|
|
22731
22188
|
|
|
@@ -22737,7 +22194,7 @@ await client.shipping.orders.taskGroup.addExecutorV1("task_group_id");
|
|
|
22737
22194
|
<dl>
|
|
22738
22195
|
<dd>
|
|
22739
22196
|
|
|
22740
|
-
|
|
22197
|
+
Deletes a task group from an active order and synchronizes affected order, driver, cargo, and account state. | authz_personas=[draft_creator_org_operator, coordinator_org_operators] | () -> (bool)
|
|
22741
22198
|
|
|
22742
22199
|
</dd>
|
|
22743
22200
|
</dl>
|
|
@@ -22753,7 +22210,7 @@ Clears the driver from an order task group. DRAFT task groups require executor_o
|
|
|
22753
22210
|
<dd>
|
|
22754
22211
|
|
|
22755
22212
|
```typescript
|
|
22756
|
-
await client.shipping.orders.taskGroup.
|
|
22213
|
+
await client.shipping.orders.taskGroup.deleteV1("task_group_id");
|
|
22757
22214
|
```
|
|
22758
22215
|
|
|
22759
22216
|
</dd>
|
|
@@ -22788,7 +22245,7 @@ await client.shipping.orders.taskGroup.removeDriverV1("task_group_id");
|
|
|
22788
22245
|
</dl>
|
|
22789
22246
|
</details>
|
|
22790
22247
|
|
|
22791
|
-
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">
|
|
22248
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">removeDriverV1</a>(taskGroupId) -> boolean</code></summary>
|
|
22792
22249
|
<dl>
|
|
22793
22250
|
<dd>
|
|
22794
22251
|
|
|
@@ -22800,7 +22257,7 @@ await client.shipping.orders.taskGroup.removeDriverV1("task_group_id");
|
|
|
22800
22257
|
<dl>
|
|
22801
22258
|
<dd>
|
|
22802
22259
|
|
|
22803
|
-
Clears the
|
|
22260
|
+
Clears the driver from an order task group. DRAFT task groups require executor_org_operators; operational task groups require executor_org_operators or driver_for_executor and STAGED or IN_PROGRESS status. | authz_personas=[executor_org_operators, driver_for_executor] | () -> (bool)
|
|
22804
22261
|
|
|
22805
22262
|
</dd>
|
|
22806
22263
|
</dl>
|
|
@@ -22816,7 +22273,7 @@ Clears the executor and assigned driver from an order task group. DRAFT task gro
|
|
|
22816
22273
|
<dd>
|
|
22817
22274
|
|
|
22818
22275
|
```typescript
|
|
22819
|
-
await client.shipping.orders.taskGroup.
|
|
22276
|
+
await client.shipping.orders.taskGroup.removeDriverV1("task_group_id");
|
|
22820
22277
|
```
|
|
22821
22278
|
|
|
22822
22279
|
</dd>
|
|
@@ -22851,7 +22308,7 @@ await client.shipping.orders.taskGroup.removeExecutorV1("task_group_id");
|
|
|
22851
22308
|
</dl>
|
|
22852
22309
|
</details>
|
|
22853
22310
|
|
|
22854
|
-
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">
|
|
22311
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">removeExecutorV1</a>(taskGroupId) -> boolean</code></summary>
|
|
22855
22312
|
<dl>
|
|
22856
22313
|
<dd>
|
|
22857
22314
|
|
|
@@ -22863,7 +22320,7 @@ await client.shipping.orders.taskGroup.removeExecutorV1("task_group_id");
|
|
|
22863
22320
|
<dl>
|
|
22864
22321
|
<dd>
|
|
22865
22322
|
|
|
22866
|
-
|
|
22323
|
+
Clears the executor and assigned driver from an order task group. DRAFT task groups require task_group_coordinator_operators; operational task groups require coordinator_org_operators and STAGED or IN_PROGRESS status. | authz_personas=[task_group_coordinator_operators, coordinator_org_operators] | () -> (bool)
|
|
22867
22324
|
|
|
22868
22325
|
</dd>
|
|
22869
22326
|
</dl>
|
|
@@ -22879,19 +22336,7 @@ Replaces the ordered flight legs on an order task group. | (OrdersSetTaskGroupFl
|
|
|
22879
22336
|
<dd>
|
|
22880
22337
|
|
|
22881
22338
|
```typescript
|
|
22882
|
-
await client.shipping.orders.taskGroup.
|
|
22883
|
-
flight_legs: [
|
|
22884
|
-
{
|
|
22885
|
-
carrier_iata: "carrier_iata",
|
|
22886
|
-
destination_iata: "destination_iata",
|
|
22887
|
-
flight_number: "flight_number",
|
|
22888
|
-
origin_iata: "origin_iata",
|
|
22889
|
-
provenance: "manual",
|
|
22890
|
-
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
22891
|
-
schema_version: 1,
|
|
22892
|
-
},
|
|
22893
|
-
],
|
|
22894
|
-
});
|
|
22339
|
+
await client.shipping.orders.taskGroup.removeExecutorV1("task_group_id");
|
|
22895
22340
|
```
|
|
22896
22341
|
|
|
22897
22342
|
</dd>
|
|
@@ -22915,14 +22360,6 @@ await client.shipping.orders.taskGroup.setFlightInfoV1("task_group_id", {
|
|
|
22915
22360
|
<dl>
|
|
22916
22361
|
<dd>
|
|
22917
22362
|
|
|
22918
|
-
**request:** `Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq`
|
|
22919
|
-
|
|
22920
|
-
</dd>
|
|
22921
|
-
</dl>
|
|
22922
|
-
|
|
22923
|
-
<dl>
|
|
22924
|
-
<dd>
|
|
22925
|
-
|
|
22926
22363
|
**requestOptions:** `TaskGroup.RequestOptions`
|
|
22927
22364
|
|
|
22928
22365
|
</dd>
|
|
@@ -22934,7 +22371,7 @@ await client.shipping.orders.taskGroup.setFlightInfoV1("task_group_id", {
|
|
|
22934
22371
|
</dl>
|
|
22935
22372
|
</details>
|
|
22936
22373
|
|
|
22937
|
-
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">
|
|
22374
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">setFlightInfoV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
22938
22375
|
<dl>
|
|
22939
22376
|
<dd>
|
|
22940
22377
|
|
|
@@ -22946,7 +22383,7 @@ await client.shipping.orders.taskGroup.setFlightInfoV1("task_group_id", {
|
|
|
22946
22383
|
<dl>
|
|
22947
22384
|
<dd>
|
|
22948
22385
|
|
|
22949
|
-
|
|
22386
|
+
Replaces the ordered flight legs on an order task group. | (OrdersSetTaskGroupFlightInfoReq) -> (bool)
|
|
22950
22387
|
|
|
22951
22388
|
</dd>
|
|
22952
22389
|
</dl>
|
|
@@ -22962,8 +22399,18 @@ Sets the ordering of tasks within an order task group and recalculates estimated
|
|
|
22962
22399
|
<dd>
|
|
22963
22400
|
|
|
22964
22401
|
```typescript
|
|
22965
|
-
await client.shipping.orders.taskGroup.
|
|
22966
|
-
|
|
22402
|
+
await client.shipping.orders.taskGroup.setFlightInfoV1("task_group_id", {
|
|
22403
|
+
flight_legs: [
|
|
22404
|
+
{
|
|
22405
|
+
carrier_iata: "carrier_iata",
|
|
22406
|
+
destination_iata: "destination_iata",
|
|
22407
|
+
flight_number: "flight_number",
|
|
22408
|
+
origin_iata: "origin_iata",
|
|
22409
|
+
provenance: "manual",
|
|
22410
|
+
scheduled_departure_utc: "2024-01-15T09:30:00Z",
|
|
22411
|
+
schema_version: 1,
|
|
22412
|
+
},
|
|
22413
|
+
],
|
|
22967
22414
|
});
|
|
22968
22415
|
```
|
|
22969
22416
|
|
|
@@ -22988,7 +22435,7 @@ await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
|
|
|
22988
22435
|
<dl>
|
|
22989
22436
|
<dd>
|
|
22990
22437
|
|
|
22991
|
-
**request:** `Chrt.shipping.orders.
|
|
22438
|
+
**request:** `Chrt.shipping.orders.OrdersSetTaskGroupFlightInfoReq`
|
|
22992
22439
|
|
|
22993
22440
|
</dd>
|
|
22994
22441
|
</dl>
|
|
@@ -23007,7 +22454,7 @@ await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
|
|
|
23007
22454
|
</dl>
|
|
23008
22455
|
</details>
|
|
23009
22456
|
|
|
23010
|
-
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">
|
|
22457
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">setTaskOrderingV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
23011
22458
|
<dl>
|
|
23012
22459
|
<dd>
|
|
23013
22460
|
|
|
@@ -23019,7 +22466,7 @@ await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
|
|
|
23019
22466
|
<dl>
|
|
23020
22467
|
<dd>
|
|
23021
22468
|
|
|
23022
|
-
Sets the
|
|
22469
|
+
Sets the ordering of tasks within an order task group and recalculates estimated mileage. DRAFT orders require draft_creator_org_operator; operational orders require task_group_operating_org_operators and a STAGED or IN_PROGRESS task group. | authz_personas=[draft_creator_org_operator, task_group_operating_org_operators] | (OrdersSetTaskGroupTaskOrderingReq) -> (bool)
|
|
23023
22470
|
|
|
23024
22471
|
</dd>
|
|
23025
22472
|
</dl>
|
|
@@ -23035,8 +22482,8 @@ Sets the vehicle type until the task group reaches a terminal status. | authz_pe
|
|
|
23035
22482
|
<dd>
|
|
23036
22483
|
|
|
23037
22484
|
```typescript
|
|
23038
|
-
await client.shipping.orders.taskGroup.
|
|
23039
|
-
|
|
22485
|
+
await client.shipping.orders.taskGroup.setTaskOrderingV1("task_group_id", {
|
|
22486
|
+
task_ids: ["task_ids"],
|
|
23040
22487
|
});
|
|
23041
22488
|
```
|
|
23042
22489
|
|
|
@@ -23061,7 +22508,7 @@ await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id", {
|
|
|
23061
22508
|
<dl>
|
|
23062
22509
|
<dd>
|
|
23063
22510
|
|
|
23064
|
-
**request:** `Chrt.shipping.orders.
|
|
22511
|
+
**request:** `Chrt.shipping.orders.OrdersSetTaskGroupTaskOrderingReq`
|
|
23065
22512
|
|
|
23066
22513
|
</dd>
|
|
23067
22514
|
</dl>
|
|
@@ -23080,7 +22527,7 @@ await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id", {
|
|
|
23080
22527
|
</dl>
|
|
23081
22528
|
</details>
|
|
23082
22529
|
|
|
23083
|
-
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">
|
|
22530
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">setVehicleTypeV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
23084
22531
|
<dl>
|
|
23085
22532
|
<dd>
|
|
23086
22533
|
|
|
@@ -23092,7 +22539,7 @@ await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id", {
|
|
|
23092
22539
|
<dl>
|
|
23093
22540
|
<dd>
|
|
23094
22541
|
|
|
23095
|
-
|
|
22542
|
+
Sets the vehicle type until the task group reaches a terminal status. | authz_personas=[draft_creator_org_operator, task_group_coordinator_operators] | (OrdersSetTaskGroupVehicleTypeReq) -> (bool)
|
|
23096
22543
|
|
|
23097
22544
|
</dd>
|
|
23098
22545
|
</dl>
|
|
@@ -23108,8 +22555,8 @@ Assigns or swaps the driver on an order task group. The driver must belong to th
|
|
|
23108
22555
|
<dd>
|
|
23109
22556
|
|
|
23110
22557
|
```typescript
|
|
23111
|
-
await client.shipping.orders.taskGroup.
|
|
23112
|
-
|
|
22558
|
+
await client.shipping.orders.taskGroup.setVehicleTypeV1("task_group_id", {
|
|
22559
|
+
vehicle_type: "sedan",
|
|
23113
22560
|
});
|
|
23114
22561
|
```
|
|
23115
22562
|
|
|
@@ -23134,7 +22581,7 @@ await client.shipping.orders.taskGroup.updateDriverV1("task_group_id", {
|
|
|
23134
22581
|
<dl>
|
|
23135
22582
|
<dd>
|
|
23136
22583
|
|
|
23137
|
-
**request:** `Chrt.shipping.orders.
|
|
22584
|
+
**request:** `Chrt.shipping.orders.OrdersSetTaskGroupVehicleTypeReq`
|
|
23138
22585
|
|
|
23139
22586
|
</dd>
|
|
23140
22587
|
</dl>
|
|
@@ -23153,9 +22600,7 @@ await client.shipping.orders.taskGroup.updateDriverV1("task_group_id", {
|
|
|
23153
22600
|
</dl>
|
|
23154
22601
|
</details>
|
|
23155
22602
|
|
|
23156
|
-
|
|
23157
|
-
|
|
23158
|
-
<details><summary><code>client.shipping.orders.utils.<a href="/src/api/resources/shipping/resources/orders/resources/utils/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
|
|
22603
|
+
<details><summary><code>client.shipping.orders.taskGroup.<a href="/src/api/resources/shipping/resources/orders/resources/taskGroup/client/Client.ts">updateDriverV1</a>(taskGroupId, { ...params }) -> boolean</code></summary>
|
|
23159
22604
|
<dl>
|
|
23160
22605
|
<dd>
|
|
23161
22606
|
|
|
@@ -23167,7 +22612,7 @@ await client.shipping.orders.taskGroup.updateDriverV1("task_group_id", {
|
|
|
23167
22612
|
<dl>
|
|
23168
22613
|
<dd>
|
|
23169
22614
|
|
|
23170
|
-
|
|
22615
|
+
Assigns or swaps the driver on an order task group. The driver must belong to the task group's executor organization and permit direct assignment. | authz_personas=[executor_org_operators] | (OrdersUpdateTaskGroupDriverReq) -> (bool)
|
|
23171
22616
|
|
|
23172
22617
|
</dd>
|
|
23173
22618
|
</dl>
|
|
@@ -23183,8 +22628,8 @@ Converts a shipping-order screenshot into lightly structured text. | authz: min_
|
|
|
23183
22628
|
<dd>
|
|
23184
22629
|
|
|
23185
22630
|
```typescript
|
|
23186
|
-
await client.shipping.orders.
|
|
23187
|
-
|
|
22631
|
+
await client.shipping.orders.taskGroup.updateDriverV1("task_group_id", {
|
|
22632
|
+
driver_id: "driver_id",
|
|
23188
22633
|
});
|
|
23189
22634
|
```
|
|
23190
22635
|
|
|
@@ -23201,72 +22646,15 @@ await client.shipping.orders.utils.imageToTextV1({
|
|
|
23201
22646
|
<dl>
|
|
23202
22647
|
<dd>
|
|
23203
22648
|
|
|
23204
|
-
**
|
|
23205
|
-
|
|
23206
|
-
</dd>
|
|
23207
|
-
</dl>
|
|
23208
|
-
|
|
23209
|
-
<dl>
|
|
23210
|
-
<dd>
|
|
23211
|
-
|
|
23212
|
-
**requestOptions:** `Utils.RequestOptions`
|
|
23213
|
-
|
|
23214
|
-
</dd>
|
|
23215
|
-
</dl>
|
|
23216
|
-
</dd>
|
|
23217
|
-
</dl>
|
|
23218
|
-
|
|
23219
|
-
</dd>
|
|
23220
|
-
</dl>
|
|
23221
|
-
</details>
|
|
23222
|
-
|
|
23223
|
-
## Shipping Orders Drafts Cargo
|
|
23224
|
-
|
|
23225
|
-
<details><summary><code>client.shipping.orders.drafts.cargo.<a href="/src/api/resources/shipping/resources/orders/resources/drafts/resources/cargo/client/Client.ts">deleteV1</a>(cargoId) -> boolean</code></summary>
|
|
23226
|
-
<dl>
|
|
23227
|
-
<dd>
|
|
23228
|
-
|
|
23229
|
-
#### 📝 Description
|
|
23230
|
-
|
|
23231
|
-
<dl>
|
|
23232
|
-
<dd>
|
|
23233
|
-
|
|
23234
|
-
<dl>
|
|
23235
|
-
<dd>
|
|
23236
|
-
|
|
23237
|
-
Deletes a cargo item from a draft order and removes references from associated tasks. | () -> (bool)
|
|
23238
|
-
|
|
23239
|
-
</dd>
|
|
23240
|
-
</dl>
|
|
23241
|
-
</dd>
|
|
23242
|
-
</dl>
|
|
23243
|
-
|
|
23244
|
-
#### 🔌 Usage
|
|
23245
|
-
|
|
23246
|
-
<dl>
|
|
23247
|
-
<dd>
|
|
23248
|
-
|
|
23249
|
-
<dl>
|
|
23250
|
-
<dd>
|
|
23251
|
-
|
|
23252
|
-
```typescript
|
|
23253
|
-
await client.shipping.orders.drafts.cargo.deleteV1("cargo_id");
|
|
23254
|
-
```
|
|
22649
|
+
**taskGroupId:** `string`
|
|
23255
22650
|
|
|
23256
22651
|
</dd>
|
|
23257
22652
|
</dl>
|
|
23258
|
-
</dd>
|
|
23259
|
-
</dl>
|
|
23260
|
-
|
|
23261
|
-
#### ⚙️ Parameters
|
|
23262
|
-
|
|
23263
|
-
<dl>
|
|
23264
|
-
<dd>
|
|
23265
22653
|
|
|
23266
22654
|
<dl>
|
|
23267
22655
|
<dd>
|
|
23268
22656
|
|
|
23269
|
-
**
|
|
22657
|
+
**request:** `Chrt.shipping.orders.OrdersUpdateTaskGroupDriverReq`
|
|
23270
22658
|
|
|
23271
22659
|
</dd>
|
|
23272
22660
|
</dl>
|
|
@@ -23274,7 +22662,7 @@ await client.shipping.orders.drafts.cargo.deleteV1("cargo_id");
|
|
|
23274
22662
|
<dl>
|
|
23275
22663
|
<dd>
|
|
23276
22664
|
|
|
23277
|
-
**requestOptions:** `
|
|
22665
|
+
**requestOptions:** `TaskGroup.RequestOptions`
|
|
23278
22666
|
|
|
23279
22667
|
</dd>
|
|
23280
22668
|
</dl>
|
|
@@ -23285,9 +22673,9 @@ await client.shipping.orders.drafts.cargo.deleteV1("cargo_id");
|
|
|
23285
22673
|
</dl>
|
|
23286
22674
|
</details>
|
|
23287
22675
|
|
|
23288
|
-
## Shipping Orders
|
|
22676
|
+
## Shipping Orders Utils
|
|
23289
22677
|
|
|
23290
|
-
<details><summary><code>client.shipping.orders.
|
|
22678
|
+
<details><summary><code>client.shipping.orders.utils.<a href="/src/api/resources/shipping/resources/orders/resources/utils/client/Client.ts">imageToTextV1</a>({ ...params }) -> string</code></summary>
|
|
23291
22679
|
<dl>
|
|
23292
22680
|
<dd>
|
|
23293
22681
|
|
|
@@ -23299,7 +22687,7 @@ await client.shipping.orders.drafts.cargo.deleteV1("cargo_id");
|
|
|
23299
22687
|
<dl>
|
|
23300
22688
|
<dd>
|
|
23301
22689
|
|
|
23302
|
-
|
|
22690
|
+
Converts a shipping-order screenshot into lightly structured text. | authz: min_org_role=operator | (UploadFile) -> (str)
|
|
23303
22691
|
|
|
23304
22692
|
</dd>
|
|
23305
22693
|
</dl>
|
|
@@ -23315,7 +22703,9 @@ Deletes a task group and all associated entities (tasks, task artifacts, S3 meta
|
|
|
23315
22703
|
<dd>
|
|
23316
22704
|
|
|
23317
22705
|
```typescript
|
|
23318
|
-
await client.shipping.orders.
|
|
22706
|
+
await client.shipping.orders.utils.imageToTextV1({
|
|
22707
|
+
file: fs.createReadStream("/path/to/your/file"),
|
|
22708
|
+
});
|
|
23319
22709
|
```
|
|
23320
22710
|
|
|
23321
22711
|
</dd>
|
|
@@ -23331,7 +22721,7 @@ await client.shipping.orders.drafts.taskGroup.deleteV1("task_group_id");
|
|
|
23331
22721
|
<dl>
|
|
23332
22722
|
<dd>
|
|
23333
22723
|
|
|
23334
|
-
**
|
|
22724
|
+
**request:** `Chrt.shipping.orders.BodyPostShippingOrdersUtilsImageToTextV1`
|
|
23335
22725
|
|
|
23336
22726
|
</dd>
|
|
23337
22727
|
</dl>
|
|
@@ -23339,7 +22729,7 @@ await client.shipping.orders.drafts.taskGroup.deleteV1("task_group_id");
|
|
|
23339
22729
|
<dl>
|
|
23340
22730
|
<dd>
|
|
23341
22731
|
|
|
23342
|
-
**requestOptions:** `
|
|
22732
|
+
**requestOptions:** `Utils.RequestOptions`
|
|
23343
22733
|
|
|
23344
22734
|
</dd>
|
|
23345
22735
|
</dl>
|
|
@@ -25966,7 +25356,7 @@ await client.tracking.sessions.flightLegsV1({
|
|
|
25966
25356
|
<dl>
|
|
25967
25357
|
<dd>
|
|
25968
25358
|
|
|
25969
|
-
Returns the Cirium
|
|
25359
|
+
Returns the raw Cirium positional track for one of the session's flight legs; pass force_refresh=true to bypass the cache. Access restricted to the caller's organization or shared organizations. | auth: api_key | authz: min_org_role=operator | () -> (FlightTrackRes)
|
|
25970
25360
|
|
|
25971
25361
|
</dd>
|
|
25972
25362
|
</dl>
|
|
@@ -25985,6 +25375,7 @@ Returns the Cirium-sourced positional track for one of the session's flight legs
|
|
|
25985
25375
|
await client.tracking.sessions.flightTrackV1({
|
|
25986
25376
|
session_id: "session_id",
|
|
25987
25377
|
flight_leg_id: "flight_leg_id",
|
|
25378
|
+
force_refresh: true,
|
|
25988
25379
|
});
|
|
25989
25380
|
```
|
|
25990
25381
|
|