@chrt-inc/typescript-sdk 1.935.0 → 1.949.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/shippingIntegrations/client/Client.d.ts +6 -0
- package/dist/cjs/api/resources/shippingIntegrations/client/Client.js +22 -12
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.js +0 -71
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/client/Client.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/client/Client.js +22 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/index.js +18 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.d.ts +119 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.js +430 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/EcourierCredsClientCreate1.d.ts +26 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/EcourierCredsClientUpdate1.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/creds/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/index.d.ts +4 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/index.js +43 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.d.ts +104 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.js +371 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/EcourierOrderSyncOneReq.d.ts +15 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/EcourierOrderSyncOneReq.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/OrdersListV1Request.d.ts +48 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/OrdersListV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/ecourier/resources/orders/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/index.d.ts +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/index.js +3 -1
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.d.ts +44 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.js +121 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.js +2 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/integrationExecutors/index.js +17 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/Client.d.ts +35 -2
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/Client.js +152 -4
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.d.ts +54 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.js +5 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.d.ts +6 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.d.ts +6 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.ts +1 -0
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.d.ts +0 -16
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.js +0 -71
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.ts +0 -1
- package/dist/cjs/api/types/EcourierCredsLimited1.d.ts +29 -0
- package/dist/cjs/api/types/EcourierCredsLimited1.js +5 -0
- package/dist/cjs/api/types/EcourierCredsListRes.d.ts +8 -0
- package/dist/cjs/api/types/EcourierCredsListRes.js +5 -0
- package/dist/cjs/api/types/EcourierCredsTestRes.d.ts +11 -0
- package/dist/cjs/api/types/EcourierCredsTestRes.js +5 -0
- package/dist/cjs/api/types/EcourierOrder1.d.ts +19 -0
- package/dist/cjs/api/types/EcourierOrder1.js +5 -0
- package/dist/cjs/api/types/EcourierOrderCustomerResponse1.d.ts +16 -0
- package/dist/cjs/api/types/EcourierOrderCustomerResponse1.js +5 -0
- package/dist/cjs/api/types/EcourierOrderListRes.d.ts +8 -0
- package/dist/cjs/api/types/EcourierOrderListRes.js +5 -0
- package/dist/cjs/api/types/EcourierOrderResponse1.d.ts +43 -0
- package/dist/cjs/api/types/EcourierOrderResponse1.js +5 -0
- package/dist/cjs/api/types/EcourierOrderSortByEnum.d.ts +10 -0
- package/dist/cjs/api/types/EcourierOrderSortByEnum.js +12 -0
- package/dist/cjs/api/types/EcourierOrderStopResponse1.d.ts +27 -0
- package/dist/cjs/api/types/EcourierOrderStopResponse1.js +5 -0
- package/dist/cjs/api/types/FraytWebhookResponse.d.ts +7 -0
- package/dist/cjs/api/types/FraytWebhookResponse.js +5 -0
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.d.ts +6 -1
- package/dist/cjs/api/types/NotificationEventsForOrgsEnum.js +5 -0
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.d.ts +6 -1
- package/dist/cjs/api/types/NotificationEventsForUsersEnum.js +5 -0
- package/dist/cjs/api/types/OrgShippingIntegrationEnum1.d.ts +2 -1
- package/dist/cjs/api/types/OrgShippingIntegrationEnum1.js +1 -0
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutor.d.ts +17 -0
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutor.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutorListRes.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationIntegrationExecutorListRes.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.d.ts +8 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.js +10 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderExpanded1.d.ts +3 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderSortByEnum.d.ts +2 -1
- package/dist/cjs/api/types/ShippingIntegrationOrderSortByEnum.js +1 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChange1.d.ts +17 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChange1.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChangedReq.d.ts +12 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChangedReq.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChangedRes.d.ts +6 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChangedRes.js +5 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChangedWebhookPayload.d.ts +37 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderStatusChangedWebhookPayload.js +16 -0
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.d.ts +5 -1
- package/dist/cjs/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.js +5 -0
- package/dist/cjs/api/types/index.d.ts +17 -0
- package/dist/cjs/api/types/index.js +17 -0
- 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/shippingIntegrations/client/Client.d.mts +6 -0
- package/dist/esm/api/resources/shippingIntegrations/client/Client.mjs +10 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.mjs +0 -71
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/index.d.mts +0 -1
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/client/Client.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/client/Client.mjs +18 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.d.mts +119 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.mjs +393 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/EcourierCredsClientCreate1.d.mts +26 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/EcourierCredsClientUpdate1.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/creds/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/index.d.mts +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/index.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.d.mts +104 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.mjs +334 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/EcourierOrderSyncOneReq.d.mts +15 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/EcourierOrderSyncOneReq.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/OrdersListV1Request.d.mts +48 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/OrdersListV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/requests/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/ecourier/resources/orders/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/index.d.mts +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/index.mjs +2 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.d.mts +44 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.mjs +84 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/client/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/integrationExecutors/index.mjs +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/Client.d.mts +35 -2
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/Client.mjs +152 -4
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.d.mts +54 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListForIntegrationExecutorOperatorsV1Request.mjs +4 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersListV1Request.d.mts +6 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/OrdersStatusSummaryV1Request.d.mts +6 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/orders/client/requests/index.d.mts +1 -0
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.d.mts +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.mjs +0 -71
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/index.d.mts +0 -1
- package/dist/esm/api/types/EcourierCredsLimited1.d.mts +29 -0
- package/dist/esm/api/types/EcourierCredsLimited1.mjs +4 -0
- package/dist/esm/api/types/EcourierCredsListRes.d.mts +8 -0
- package/dist/esm/api/types/EcourierCredsListRes.mjs +4 -0
- package/dist/esm/api/types/EcourierCredsTestRes.d.mts +11 -0
- package/dist/esm/api/types/EcourierCredsTestRes.mjs +4 -0
- package/dist/esm/api/types/EcourierOrder1.d.mts +19 -0
- package/dist/esm/api/types/EcourierOrder1.mjs +4 -0
- package/dist/esm/api/types/EcourierOrderCustomerResponse1.d.mts +16 -0
- package/dist/esm/api/types/EcourierOrderCustomerResponse1.mjs +4 -0
- package/dist/esm/api/types/EcourierOrderListRes.d.mts +8 -0
- package/dist/esm/api/types/EcourierOrderListRes.mjs +4 -0
- package/dist/esm/api/types/EcourierOrderResponse1.d.mts +43 -0
- package/dist/esm/api/types/EcourierOrderResponse1.mjs +4 -0
- package/dist/esm/api/types/EcourierOrderSortByEnum.d.mts +10 -0
- package/dist/esm/api/types/EcourierOrderSortByEnum.mjs +9 -0
- package/dist/esm/api/types/EcourierOrderStopResponse1.d.mts +27 -0
- package/dist/esm/api/types/EcourierOrderStopResponse1.mjs +4 -0
- package/dist/esm/api/types/FraytWebhookResponse.d.mts +7 -0
- package/dist/esm/api/types/FraytWebhookResponse.mjs +4 -0
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.d.mts +6 -1
- package/dist/esm/api/types/NotificationEventsForOrgsEnum.mjs +5 -0
- package/dist/esm/api/types/NotificationEventsForUsersEnum.d.mts +6 -1
- package/dist/esm/api/types/NotificationEventsForUsersEnum.mjs +5 -0
- package/dist/esm/api/types/OrgShippingIntegrationEnum1.d.mts +2 -1
- package/dist/esm/api/types/OrgShippingIntegrationEnum1.mjs +1 -0
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutor.d.mts +17 -0
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutor.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutorListRes.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationIntegrationExecutorListRes.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.d.mts +8 -0
- package/dist/esm/api/types/ShippingIntegrationOrderCompletedAtProvenanceEnum1.mjs +7 -0
- package/dist/esm/api/types/ShippingIntegrationOrderExpanded1.d.mts +3 -0
- package/dist/esm/api/types/ShippingIntegrationOrderSortByEnum.d.mts +2 -1
- package/dist/esm/api/types/ShippingIntegrationOrderSortByEnum.mjs +1 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChange1.d.mts +17 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChange1.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChangedReq.d.mts +12 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChangedReq.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChangedRes.d.mts +6 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChangedRes.mjs +4 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChangedWebhookPayload.d.mts +37 -0
- package/dist/esm/api/types/ShippingIntegrationOrderStatusChangedWebhookPayload.mjs +13 -0
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.d.mts +5 -1
- package/dist/esm/api/types/ShippingIntegrationOrderTypeaheadFieldEnum.mjs +4 -1
- package/dist/esm/api/types/index.d.mts +17 -0
- package/dist/esm/api/types/index.mjs +17 -0
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +1 -1
- package/reference.md +848 -162
- package/dist/cjs/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +0 -16
- package/dist/cjs/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.d.ts +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +0 -16
- package/dist/esm/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.d.mts +0 -16
- /package/dist/cjs/api/resources/shippingIntegrations/resources/{atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.js → ecourier/resources/creds/client/requests/EcourierCredsClientCreate1.js} +0 -0
- /package/dist/cjs/api/resources/shippingIntegrations/resources/{xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.js → ecourier/resources/creds/client/requests/EcourierCredsClientUpdate1.js} +0 -0
- /package/dist/esm/api/resources/shippingIntegrations/resources/{atlas/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs → ecourier/resources/creds/client/requests/EcourierCredsClientCreate1.mjs} +0 -0
- /package/dist/esm/api/resources/shippingIntegrations/resources/{xcelerator/resources/orders/client/requests/OrdersTypeaheadV1Request.mjs → ecourier/resources/creds/client/requests/EcourierCredsClientUpdate1.mjs} +0 -0
package/reference.md
CHANGED
|
@@ -24208,6 +24208,63 @@ await client.shippingIntegrations.connections.listV1();
|
|
|
24208
24208
|
</dl>
|
|
24209
24209
|
</details>
|
|
24210
24210
|
|
|
24211
|
+
## ShippingIntegrations IntegrationExecutors
|
|
24212
|
+
|
|
24213
|
+
<details><summary><code>client.shippingIntegrations.integrationExecutors.<a href="/src/api/resources/shippingIntegrations/resources/integrationExecutors/client/Client.ts">listV1</a>() -> Chrt.ShippingIntegrationIntegrationExecutorListRes</code></summary>
|
|
24214
|
+
<dl>
|
|
24215
|
+
<dd>
|
|
24216
|
+
|
|
24217
|
+
#### 📝 Description
|
|
24218
|
+
|
|
24219
|
+
<dl>
|
|
24220
|
+
<dd>
|
|
24221
|
+
|
|
24222
|
+
<dl>
|
|
24223
|
+
<dd>
|
|
24224
|
+
|
|
24225
|
+
Lists all distinct integration executor organizations that have credentials configured across any shipping integration, with public organization data expanded. | authz: min_org_role=operator | () -> (ShippingIntegrationIntegrationExecutorListRes)
|
|
24226
|
+
|
|
24227
|
+
</dd>
|
|
24228
|
+
</dl>
|
|
24229
|
+
</dd>
|
|
24230
|
+
</dl>
|
|
24231
|
+
|
|
24232
|
+
#### 🔌 Usage
|
|
24233
|
+
|
|
24234
|
+
<dl>
|
|
24235
|
+
<dd>
|
|
24236
|
+
|
|
24237
|
+
<dl>
|
|
24238
|
+
<dd>
|
|
24239
|
+
|
|
24240
|
+
```typescript
|
|
24241
|
+
await client.shippingIntegrations.integrationExecutors.listV1();
|
|
24242
|
+
```
|
|
24243
|
+
|
|
24244
|
+
</dd>
|
|
24245
|
+
</dl>
|
|
24246
|
+
</dd>
|
|
24247
|
+
</dl>
|
|
24248
|
+
|
|
24249
|
+
#### ⚙️ Parameters
|
|
24250
|
+
|
|
24251
|
+
<dl>
|
|
24252
|
+
<dd>
|
|
24253
|
+
|
|
24254
|
+
<dl>
|
|
24255
|
+
<dd>
|
|
24256
|
+
|
|
24257
|
+
**requestOptions:** `IntegrationExecutors.RequestOptions`
|
|
24258
|
+
|
|
24259
|
+
</dd>
|
|
24260
|
+
</dl>
|
|
24261
|
+
</dd>
|
|
24262
|
+
</dl>
|
|
24263
|
+
|
|
24264
|
+
</dd>
|
|
24265
|
+
</dl>
|
|
24266
|
+
</details>
|
|
24267
|
+
|
|
24211
24268
|
## ShippingIntegrations Orders
|
|
24212
24269
|
|
|
24213
24270
|
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.ShippingIntegrationOrderExpanded1</code></summary>
|
|
@@ -24222,7 +24279,7 @@ await client.shippingIntegrations.connections.listV1();
|
|
|
24222
24279
|
<dl>
|
|
24223
24280
|
<dd>
|
|
24224
24281
|
|
|
24225
|
-
Returns one unified shipping integration order by its Mongo ObjectId with
|
|
24282
|
+
Returns one unified shipping integration order by its Mongo ObjectId with related organizations expanded. | () -> (ShippingIntegrationOrderExpanded1)
|
|
24226
24283
|
|
|
24227
24284
|
</dd>
|
|
24228
24285
|
</dl>
|
|
@@ -24273,6 +24330,85 @@ await client.shippingIntegrations.orders.detailV1("id");
|
|
|
24273
24330
|
</dl>
|
|
24274
24331
|
</details>
|
|
24275
24332
|
|
|
24333
|
+
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">listForIntegrationExecutorOperatorsV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderListRes</code></summary>
|
|
24334
|
+
<dl>
|
|
24335
|
+
<dd>
|
|
24336
|
+
|
|
24337
|
+
#### 📝 Description
|
|
24338
|
+
|
|
24339
|
+
<dl>
|
|
24340
|
+
<dd>
|
|
24341
|
+
|
|
24342
|
+
<dl>
|
|
24343
|
+
<dd>
|
|
24344
|
+
|
|
24345
|
+
Lists orders assigned to the caller's integration executor organization across all shipping integrations with integration coordinator organizations expanded, filtering, sorting, pagination, and optional search. | authz: allowed_org_types=[provider], min_org_role=operator | () -> (ShippingIntegrationOrderListRes)
|
|
24346
|
+
|
|
24347
|
+
</dd>
|
|
24348
|
+
</dl>
|
|
24349
|
+
</dd>
|
|
24350
|
+
</dl>
|
|
24351
|
+
|
|
24352
|
+
#### 🔌 Usage
|
|
24353
|
+
|
|
24354
|
+
<dl>
|
|
24355
|
+
<dd>
|
|
24356
|
+
|
|
24357
|
+
<dl>
|
|
24358
|
+
<dd>
|
|
24359
|
+
|
|
24360
|
+
```typescript
|
|
24361
|
+
await client.shippingIntegrations.orders.listForIntegrationExecutorOperatorsV1({
|
|
24362
|
+
sort_by: "ordered_at_timestamp",
|
|
24363
|
+
sort_order: "asc",
|
|
24364
|
+
page: 1,
|
|
24365
|
+
page_size: 1,
|
|
24366
|
+
search: "search",
|
|
24367
|
+
filter_shipping_integration: ["xcelerator"],
|
|
24368
|
+
filter_status: ["staged"],
|
|
24369
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
24370
|
+
filter_reference_number: "filter_reference_number",
|
|
24371
|
+
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24372
|
+
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24373
|
+
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24374
|
+
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24375
|
+
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24376
|
+
filter_first_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24377
|
+
});
|
|
24378
|
+
```
|
|
24379
|
+
|
|
24380
|
+
</dd>
|
|
24381
|
+
</dl>
|
|
24382
|
+
</dd>
|
|
24383
|
+
</dl>
|
|
24384
|
+
|
|
24385
|
+
#### ⚙️ Parameters
|
|
24386
|
+
|
|
24387
|
+
<dl>
|
|
24388
|
+
<dd>
|
|
24389
|
+
|
|
24390
|
+
<dl>
|
|
24391
|
+
<dd>
|
|
24392
|
+
|
|
24393
|
+
**request:** `Chrt.shippingIntegrations.OrdersListForIntegrationExecutorOperatorsV1Request`
|
|
24394
|
+
|
|
24395
|
+
</dd>
|
|
24396
|
+
</dl>
|
|
24397
|
+
|
|
24398
|
+
<dl>
|
|
24399
|
+
<dd>
|
|
24400
|
+
|
|
24401
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
24402
|
+
|
|
24403
|
+
</dd>
|
|
24404
|
+
</dl>
|
|
24405
|
+
</dd>
|
|
24406
|
+
</dl>
|
|
24407
|
+
|
|
24408
|
+
</dd>
|
|
24409
|
+
</dl>
|
|
24410
|
+
</details>
|
|
24411
|
+
|
|
24276
24412
|
<details><summary><code>client.shippingIntegrations.orders.<a href="/src/api/resources/shippingIntegrations/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderListRes</code></summary>
|
|
24277
24413
|
<dl>
|
|
24278
24414
|
<dd>
|
|
@@ -24314,6 +24450,8 @@ await client.shippingIntegrations.orders.listV1({
|
|
|
24314
24450
|
filter_reference_number: "filter_reference_number",
|
|
24315
24451
|
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24316
24452
|
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24453
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24454
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24317
24455
|
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24318
24456
|
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24319
24457
|
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -24389,6 +24527,8 @@ await client.shippingIntegrations.orders.statusSummaryV1({
|
|
|
24389
24527
|
filter_reference_number: "filter_reference_number",
|
|
24390
24528
|
filter_ordered_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24391
24529
|
filter_ordered_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24530
|
+
filter_completed_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24531
|
+
filter_completed_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24392
24532
|
filter_last_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
24393
24533
|
filter_last_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
24394
24534
|
filter_first_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -24440,7 +24580,7 @@ await client.shippingIntegrations.orders.statusSummaryV1({
|
|
|
24440
24580
|
<dl>
|
|
24441
24581
|
<dd>
|
|
24442
24582
|
|
|
24443
|
-
Returns distinct integration order IDs matching the query via case-insensitive regex within the caller's organization. |
|
|
24583
|
+
Returns distinct integration order IDs and reference numbers matching the query via case-insensitive regex within the caller's organization. | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
24444
24584
|
|
|
24445
24585
|
</dd>
|
|
24446
24586
|
</dl>
|
|
@@ -25164,72 +25304,6 @@ await client.shippingIntegrations.atlas.orders.syncOneV1({
|
|
|
25164
25304
|
</dl>
|
|
25165
25305
|
</details>
|
|
25166
25306
|
|
|
25167
|
-
<details><summary><code>client.shippingIntegrations.atlas.orders.<a href="/src/api/resources/shippingIntegrations/resources/atlas/resources/orders/client/Client.ts">typeaheadV1</a>({ ...params }) -> Chrt.ShippingIntegrationOrderTypeaheadResult[]</code></summary>
|
|
25168
|
-
<dl>
|
|
25169
|
-
<dd>
|
|
25170
|
-
|
|
25171
|
-
#### 📝 Description
|
|
25172
|
-
|
|
25173
|
-
<dl>
|
|
25174
|
-
<dd>
|
|
25175
|
-
|
|
25176
|
-
<dl>
|
|
25177
|
-
<dd>
|
|
25178
|
-
|
|
25179
|
-
Returns distinct Atlas integration order IDs matching the query via case-insensitive regex within the caller's organization. | authz: caller's organization scope | () -> (list[ShippingIntegrationOrderTypeaheadResult])
|
|
25180
|
-
|
|
25181
|
-
</dd>
|
|
25182
|
-
</dl>
|
|
25183
|
-
</dd>
|
|
25184
|
-
</dl>
|
|
25185
|
-
|
|
25186
|
-
#### 🔌 Usage
|
|
25187
|
-
|
|
25188
|
-
<dl>
|
|
25189
|
-
<dd>
|
|
25190
|
-
|
|
25191
|
-
<dl>
|
|
25192
|
-
<dd>
|
|
25193
|
-
|
|
25194
|
-
```typescript
|
|
25195
|
-
await client.shippingIntegrations.atlas.orders.typeaheadV1({
|
|
25196
|
-
query: "query",
|
|
25197
|
-
limit: 1,
|
|
25198
|
-
});
|
|
25199
|
-
```
|
|
25200
|
-
|
|
25201
|
-
</dd>
|
|
25202
|
-
</dl>
|
|
25203
|
-
</dd>
|
|
25204
|
-
</dl>
|
|
25205
|
-
|
|
25206
|
-
#### ⚙️ Parameters
|
|
25207
|
-
|
|
25208
|
-
<dl>
|
|
25209
|
-
<dd>
|
|
25210
|
-
|
|
25211
|
-
<dl>
|
|
25212
|
-
<dd>
|
|
25213
|
-
|
|
25214
|
-
**request:** `Chrt.shippingIntegrations.atlas.OrdersTypeaheadV1Request`
|
|
25215
|
-
|
|
25216
|
-
</dd>
|
|
25217
|
-
</dl>
|
|
25218
|
-
|
|
25219
|
-
<dl>
|
|
25220
|
-
<dd>
|
|
25221
|
-
|
|
25222
|
-
**requestOptions:** `Orders.RequestOptions`
|
|
25223
|
-
|
|
25224
|
-
</dd>
|
|
25225
|
-
</dl>
|
|
25226
|
-
</dd>
|
|
25227
|
-
</dl>
|
|
25228
|
-
|
|
25229
|
-
</dd>
|
|
25230
|
-
</dl>
|
|
25231
|
-
</details>
|
|
25232
|
-
|
|
25233
25307
|
## ShippingIntegrations Cxt Creds
|
|
25234
25308
|
|
|
25235
25309
|
<details><summary><code>client.shippingIntegrations.cxt.creds.<a href="/src/api/resources/shippingIntegrations/resources/cxt/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.CxtCredsLimited1</code></summary>
|
|
@@ -26579,9 +26653,9 @@ await client.shippingIntegrations.dispatchScience.orders.syncOneV1({
|
|
|
26579
26653
|
</dl>
|
|
26580
26654
|
</details>
|
|
26581
26655
|
|
|
26582
|
-
## ShippingIntegrations
|
|
26656
|
+
## ShippingIntegrations Ecourier Creds
|
|
26583
26657
|
|
|
26584
|
-
<details><summary><code>client.shippingIntegrations.
|
|
26658
|
+
<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.EcourierCredsLimited1</code></summary>
|
|
26585
26659
|
<dl>
|
|
26586
26660
|
<dd>
|
|
26587
26661
|
|
|
@@ -26593,7 +26667,7 @@ await client.shippingIntegrations.dispatchScience.orders.syncOneV1({
|
|
|
26593
26667
|
<dl>
|
|
26594
26668
|
<dd>
|
|
26595
26669
|
|
|
26596
|
-
Returns the caller's
|
|
26670
|
+
Returns the caller's e-Courier credential for one provider, without the password or session token. | () -> (EcourierCredsLimited1)
|
|
26597
26671
|
|
|
26598
26672
|
</dd>
|
|
26599
26673
|
</dl>
|
|
@@ -26609,7 +26683,7 @@ Returns the caller's OnTime360 credential for one provider, without the API key.
|
|
|
26609
26683
|
<dd>
|
|
26610
26684
|
|
|
26611
26685
|
```typescript
|
|
26612
|
-
await client.shippingIntegrations.
|
|
26686
|
+
await client.shippingIntegrations.ecourier.creds.detailV1("provider_org_id");
|
|
26613
26687
|
```
|
|
26614
26688
|
|
|
26615
26689
|
</dd>
|
|
@@ -26644,7 +26718,7 @@ await client.shippingIntegrations.ontime360.creds.detailV1("provider_org_id");
|
|
|
26644
26718
|
</dl>
|
|
26645
26719
|
</details>
|
|
26646
26720
|
|
|
26647
|
-
<details><summary><code>client.shippingIntegrations.
|
|
26721
|
+
<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">listV1</a>() -> Chrt.EcourierCredsListRes</code></summary>
|
|
26648
26722
|
<dl>
|
|
26649
26723
|
<dd>
|
|
26650
26724
|
|
|
@@ -26656,7 +26730,7 @@ await client.shippingIntegrations.ontime360.creds.detailV1("provider_org_id");
|
|
|
26656
26730
|
<dl>
|
|
26657
26731
|
<dd>
|
|
26658
26732
|
|
|
26659
|
-
Lists the caller's
|
|
26733
|
+
Lists the caller's e-Courier credentials, one per connected provider, without the password or session token. | () -> (EcourierCredsListRes)
|
|
26660
26734
|
|
|
26661
26735
|
</dd>
|
|
26662
26736
|
</dl>
|
|
@@ -26672,7 +26746,7 @@ Lists the caller's OnTime360 credentials, one per connected provider, without th
|
|
|
26672
26746
|
<dd>
|
|
26673
26747
|
|
|
26674
26748
|
```typescript
|
|
26675
|
-
await client.shippingIntegrations.
|
|
26749
|
+
await client.shippingIntegrations.ecourier.creds.listV1();
|
|
26676
26750
|
```
|
|
26677
26751
|
|
|
26678
26752
|
</dd>
|
|
@@ -26699,7 +26773,7 @@ await client.shippingIntegrations.ontime360.creds.listV1();
|
|
|
26699
26773
|
</dl>
|
|
26700
26774
|
</details>
|
|
26701
26775
|
|
|
26702
|
-
<details><summary><code>client.shippingIntegrations.
|
|
26776
|
+
<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.EcourierCredsTestRes</code></summary>
|
|
26703
26777
|
<dl>
|
|
26704
26778
|
<dd>
|
|
26705
26779
|
|
|
@@ -26711,7 +26785,7 @@ await client.shippingIntegrations.ontime360.creds.listV1();
|
|
|
26711
26785
|
<dl>
|
|
26712
26786
|
<dd>
|
|
26713
26787
|
|
|
26714
|
-
Confirms the caller's stored
|
|
26788
|
+
Confirms the caller's stored e-Courier credentials for one provider can still log in, and reports which customer the credential is scoped to. | authz: min_org_role=operator | () -> (EcourierCredsTestRes)
|
|
26715
26789
|
|
|
26716
26790
|
</dd>
|
|
26717
26791
|
</dl>
|
|
@@ -26727,7 +26801,7 @@ Confirms the caller's stored OnTime360 credentials for one provider can still pe
|
|
|
26727
26801
|
<dd>
|
|
26728
26802
|
|
|
26729
26803
|
```typescript
|
|
26730
|
-
await client.shippingIntegrations.
|
|
26804
|
+
await client.shippingIntegrations.ecourier.creds.testV1("provider_org_id");
|
|
26731
26805
|
```
|
|
26732
26806
|
|
|
26733
26807
|
</dd>
|
|
@@ -26762,7 +26836,7 @@ await client.shippingIntegrations.ontime360.creds.testV1("provider_org_id");
|
|
|
26762
26836
|
</dl>
|
|
26763
26837
|
</details>
|
|
26764
26838
|
|
|
26765
|
-
<details><summary><code>client.shippingIntegrations.
|
|
26839
|
+
<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
26766
26840
|
<dl>
|
|
26767
26841
|
<dd>
|
|
26768
26842
|
|
|
@@ -26774,7 +26848,7 @@ await client.shippingIntegrations.ontime360.creds.testV1("provider_org_id");
|
|
|
26774
26848
|
<dl>
|
|
26775
26849
|
<dd>
|
|
26776
26850
|
|
|
26777
|
-
Stores
|
|
26851
|
+
Stores e-Courier credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (EcourierCredsClientCreate1) -> (PydanticObjectId)
|
|
26778
26852
|
|
|
26779
26853
|
</dd>
|
|
26780
26854
|
</dl>
|
|
@@ -26790,11 +26864,14 @@ Stores OnTime360 credentials for one provider on behalf of the caller's organiza
|
|
|
26790
26864
|
<dd>
|
|
26791
26865
|
|
|
26792
26866
|
```typescript
|
|
26793
|
-
await client.shippingIntegrations.
|
|
26794
|
-
|
|
26795
|
-
|
|
26867
|
+
await client.shippingIntegrations.ecourier.creds.createV1("provider_org_id", {
|
|
26868
|
+
base_url: "https://bigtex.e-courier.com",
|
|
26869
|
+
ecourier_customer_code: "ecourier_customer_code",
|
|
26870
|
+
ecourier_customer_id: "ecourier_customer_id",
|
|
26871
|
+
ecourier_database: "ecourier_database",
|
|
26872
|
+
password: "password",
|
|
26796
26873
|
schema_version: 1,
|
|
26797
|
-
|
|
26874
|
+
username: "username",
|
|
26798
26875
|
});
|
|
26799
26876
|
```
|
|
26800
26877
|
|
|
@@ -26819,7 +26896,7 @@ await client.shippingIntegrations.ontime360.creds.createV1("provider_org_id", {
|
|
|
26819
26896
|
<dl>
|
|
26820
26897
|
<dd>
|
|
26821
26898
|
|
|
26822
|
-
**request:** `Chrt.shippingIntegrations.
|
|
26899
|
+
**request:** `Chrt.shippingIntegrations.ecourier.EcourierCredsClientCreate1`
|
|
26823
26900
|
|
|
26824
26901
|
</dd>
|
|
26825
26902
|
</dl>
|
|
@@ -26838,7 +26915,7 @@ await client.shippingIntegrations.ontime360.creds.createV1("provider_org_id", {
|
|
|
26838
26915
|
</dl>
|
|
26839
26916
|
</details>
|
|
26840
26917
|
|
|
26841
|
-
<details><summary><code>client.shippingIntegrations.
|
|
26918
|
+
<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
26842
26919
|
<dl>
|
|
26843
26920
|
<dd>
|
|
26844
26921
|
|
|
@@ -26850,7 +26927,7 @@ await client.shippingIntegrations.ontime360.creds.createV1("provider_org_id", {
|
|
|
26850
26927
|
<dl>
|
|
26851
26928
|
<dd>
|
|
26852
26929
|
|
|
26853
|
-
Deletes the caller's
|
|
26930
|
+
Deletes the caller's e-Courier credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
|
|
26854
26931
|
|
|
26855
26932
|
</dd>
|
|
26856
26933
|
</dl>
|
|
@@ -26866,7 +26943,7 @@ Deletes the caller's OnTime360 credentials for one provider, stopping future syn
|
|
|
26866
26943
|
<dd>
|
|
26867
26944
|
|
|
26868
26945
|
```typescript
|
|
26869
|
-
await client.shippingIntegrations.
|
|
26946
|
+
await client.shippingIntegrations.ecourier.creds.deleteV1("provider_org_id");
|
|
26870
26947
|
```
|
|
26871
26948
|
|
|
26872
26949
|
</dd>
|
|
@@ -26901,7 +26978,7 @@ await client.shippingIntegrations.ontime360.creds.deleteV1("provider_org_id");
|
|
|
26901
26978
|
</dl>
|
|
26902
26979
|
</details>
|
|
26903
26980
|
|
|
26904
|
-
<details><summary><code>client.shippingIntegrations.
|
|
26981
|
+
<details><summary><code>client.shippingIntegrations.ecourier.creds.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
26905
26982
|
<dl>
|
|
26906
26983
|
<dd>
|
|
26907
26984
|
|
|
@@ -26913,7 +26990,7 @@ await client.shippingIntegrations.ontime360.creds.deleteV1("provider_org_id");
|
|
|
26913
26990
|
<dl>
|
|
26914
26991
|
<dd>
|
|
26915
26992
|
|
|
26916
|
-
Updates the caller's
|
|
26993
|
+
Updates the caller's e-Courier credentials for one provider. | authz: min_org_role=administrator | (EcourierCredsClientUpdate1) -> (bool)
|
|
26917
26994
|
|
|
26918
26995
|
</dd>
|
|
26919
26996
|
</dl>
|
|
@@ -26929,7 +27006,7 @@ Updates the caller's OnTime360 credentials for one provider. | authz: min_org_ro
|
|
|
26929
27006
|
<dd>
|
|
26930
27007
|
|
|
26931
27008
|
```typescript
|
|
26932
|
-
await client.shippingIntegrations.
|
|
27009
|
+
await client.shippingIntegrations.ecourier.creds.updateV1("provider_org_id");
|
|
26933
27010
|
```
|
|
26934
27011
|
|
|
26935
27012
|
</dd>
|
|
@@ -26953,7 +27030,7 @@ await client.shippingIntegrations.ontime360.creds.updateV1("provider_org_id");
|
|
|
26953
27030
|
<dl>
|
|
26954
27031
|
<dd>
|
|
26955
27032
|
|
|
26956
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27033
|
+
**request:** `Chrt.shippingIntegrations.ecourier.EcourierCredsClientUpdate1`
|
|
26957
27034
|
|
|
26958
27035
|
</dd>
|
|
26959
27036
|
</dl>
|
|
@@ -26972,9 +27049,9 @@ await client.shippingIntegrations.ontime360.creds.updateV1("provider_org_id");
|
|
|
26972
27049
|
</dl>
|
|
26973
27050
|
</details>
|
|
26974
27051
|
|
|
26975
|
-
## ShippingIntegrations
|
|
27052
|
+
## ShippingIntegrations Ecourier Orders
|
|
26976
27053
|
|
|
26977
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27054
|
+
<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.EcourierOrder1</code></summary>
|
|
26978
27055
|
<dl>
|
|
26979
27056
|
<dd>
|
|
26980
27057
|
|
|
@@ -26986,7 +27063,7 @@ await client.shippingIntegrations.ontime360.creds.updateV1("provider_org_id");
|
|
|
26986
27063
|
<dl>
|
|
26987
27064
|
<dd>
|
|
26988
27065
|
|
|
26989
|
-
Returns one mirrored
|
|
27066
|
+
Returns one mirrored e-Courier order by the provider's own order number. | () -> (EcourierOrder1)
|
|
26990
27067
|
|
|
26991
27068
|
</dd>
|
|
26992
27069
|
</dl>
|
|
@@ -27002,7 +27079,7 @@ Returns one mirrored OnTime360 order by the provider's own order GUID. | () -> (
|
|
|
27002
27079
|
<dd>
|
|
27003
27080
|
|
|
27004
27081
|
```typescript
|
|
27005
|
-
await client.shippingIntegrations.
|
|
27082
|
+
await client.shippingIntegrations.ecourier.orders.detailByIntegrationOrderIdV1(
|
|
27006
27083
|
"provider_org_id",
|
|
27007
27084
|
"integration_order_id",
|
|
27008
27085
|
);
|
|
@@ -27021,7 +27098,7 @@ await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
|
27021
27098
|
<dl>
|
|
27022
27099
|
<dd>
|
|
27023
27100
|
|
|
27024
|
-
**providerOrgId:** `string` — CHRT org ID of the courier whose
|
|
27101
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose e-Courier database holds the order
|
|
27025
27102
|
|
|
27026
27103
|
</dd>
|
|
27027
27104
|
</dl>
|
|
@@ -27029,7 +27106,7 @@ await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
|
27029
27106
|
<dl>
|
|
27030
27107
|
<dd>
|
|
27031
27108
|
|
|
27032
|
-
**integrationOrderId:** `string` —
|
|
27109
|
+
**integrationOrderId:** `string` — e-Courier's own order number for the order, as carried on a unified order row
|
|
27033
27110
|
|
|
27034
27111
|
</dd>
|
|
27035
27112
|
</dl>
|
|
@@ -27048,7 +27125,7 @@ await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
|
27048
27125
|
</dl>
|
|
27049
27126
|
</details>
|
|
27050
27127
|
|
|
27051
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27128
|
+
<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.EcourierOrder1</code></summary>
|
|
27052
27129
|
<dl>
|
|
27053
27130
|
<dd>
|
|
27054
27131
|
|
|
@@ -27060,7 +27137,7 @@ await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
|
27060
27137
|
<dl>
|
|
27061
27138
|
<dd>
|
|
27062
27139
|
|
|
27063
|
-
Returns one mirrored
|
|
27140
|
+
Returns one mirrored e-Courier order by its Mongo ObjectId. | () -> (EcourierOrder1)
|
|
27064
27141
|
|
|
27065
27142
|
</dd>
|
|
27066
27143
|
</dl>
|
|
@@ -27076,7 +27153,7 @@ Returns one mirrored OnTime360 order by its Mongo ObjectId. | () -> (OnTime360Or
|
|
|
27076
27153
|
<dd>
|
|
27077
27154
|
|
|
27078
27155
|
```typescript
|
|
27079
|
-
await client.shippingIntegrations.
|
|
27156
|
+
await client.shippingIntegrations.ecourier.orders.detailV1("id");
|
|
27080
27157
|
```
|
|
27081
27158
|
|
|
27082
27159
|
</dd>
|
|
@@ -27092,7 +27169,7 @@ await client.shippingIntegrations.ontime360.orders.detailV1("id");
|
|
|
27092
27169
|
<dl>
|
|
27093
27170
|
<dd>
|
|
27094
27171
|
|
|
27095
|
-
**id:** `string` — Mongo ObjectId of the mirror document.
|
|
27172
|
+
**id:** `string` — Mongo ObjectId of the mirror document. e-Courier's own order number is the integration_order_id, accepted by the by_integration_order_id route.
|
|
27096
27173
|
|
|
27097
27174
|
</dd>
|
|
27098
27175
|
</dl>
|
|
@@ -27111,7 +27188,7 @@ await client.shippingIntegrations.ontime360.orders.detailV1("id");
|
|
|
27111
27188
|
</dl>
|
|
27112
27189
|
</details>
|
|
27113
27190
|
|
|
27114
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27191
|
+
<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.EcourierOrderListRes</code></summary>
|
|
27115
27192
|
<dl>
|
|
27116
27193
|
<dd>
|
|
27117
27194
|
|
|
@@ -27123,7 +27200,7 @@ await client.shippingIntegrations.ontime360.orders.detailV1("id");
|
|
|
27123
27200
|
<dl>
|
|
27124
27201
|
<dd>
|
|
27125
27202
|
|
|
27126
|
-
Lists mirrored
|
|
27203
|
+
Lists mirrored e-Courier orders for the caller's organization with filtering, sorting, and pagination. | () -> (EcourierOrderListRes)
|
|
27127
27204
|
|
|
27128
27205
|
</dd>
|
|
27129
27206
|
</dl>
|
|
@@ -27139,15 +27216,14 @@ Lists mirrored OnTime360 orders for the caller's organization with filtering, so
|
|
|
27139
27216
|
<dd>
|
|
27140
27217
|
|
|
27141
27218
|
```typescript
|
|
27142
|
-
await client.shippingIntegrations.
|
|
27219
|
+
await client.shippingIntegrations.ecourier.orders.listV1({
|
|
27143
27220
|
sort_by: "mirrored_at_timestamp",
|
|
27144
27221
|
sort_order: "asc",
|
|
27145
27222
|
page: 1,
|
|
27146
27223
|
page_size: 1,
|
|
27147
|
-
search: "search",
|
|
27148
27224
|
filter_provider_org_id: ["filter_provider_org_id"],
|
|
27149
27225
|
filter_integration_order_id: "filter_integration_order_id",
|
|
27150
|
-
|
|
27226
|
+
filter_provider_status_raw: "filter_provider_status_raw",
|
|
27151
27227
|
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27152
27228
|
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27153
27229
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -27170,7 +27246,7 @@ await client.shippingIntegrations.ontime360.orders.listV1({
|
|
|
27170
27246
|
<dl>
|
|
27171
27247
|
<dd>
|
|
27172
27248
|
|
|
27173
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27249
|
+
**request:** `Chrt.shippingIntegrations.ecourier.OrdersListV1Request`
|
|
27174
27250
|
|
|
27175
27251
|
</dd>
|
|
27176
27252
|
</dl>
|
|
@@ -27189,7 +27265,7 @@ await client.shippingIntegrations.ontime360.orders.listV1({
|
|
|
27189
27265
|
</dl>
|
|
27190
27266
|
</details>
|
|
27191
27267
|
|
|
27192
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27268
|
+
<details><summary><code>client.shippingIntegrations.ecourier.orders.<a href="/src/api/resources/shippingIntegrations/resources/ecourier/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.EcourierOrder1</code></summary>
|
|
27193
27269
|
<dl>
|
|
27194
27270
|
<dd>
|
|
27195
27271
|
|
|
@@ -27201,7 +27277,7 @@ await client.shippingIntegrations.ontime360.orders.listV1({
|
|
|
27201
27277
|
<dl>
|
|
27202
27278
|
<dd>
|
|
27203
27279
|
|
|
27204
|
-
Fetches and mirrors one
|
|
27280
|
+
Fetches and mirrors one e-Courier order by the provider's own order number, updating the unified order list alongside it. | authz: min_org_role=operator | (EcourierOrderSyncOneReq) -> (EcourierOrder1)
|
|
27205
27281
|
|
|
27206
27282
|
</dd>
|
|
27207
27283
|
</dl>
|
|
@@ -27217,7 +27293,7 @@ Fetches and mirrors one OnTime360 order by the provider's own order GUID, updati
|
|
|
27217
27293
|
<dd>
|
|
27218
27294
|
|
|
27219
27295
|
```typescript
|
|
27220
|
-
await client.shippingIntegrations.
|
|
27296
|
+
await client.shippingIntegrations.ecourier.orders.syncOneV1({
|
|
27221
27297
|
integration_order_id: "integration_order_id",
|
|
27222
27298
|
provider_org_id: "provider_org_id",
|
|
27223
27299
|
});
|
|
@@ -27236,7 +27312,7 @@ await client.shippingIntegrations.ontime360.orders.syncOneV1({
|
|
|
27236
27312
|
<dl>
|
|
27237
27313
|
<dd>
|
|
27238
27314
|
|
|
27239
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27315
|
+
**request:** `Chrt.shippingIntegrations.ecourier.EcourierOrderSyncOneReq`
|
|
27240
27316
|
|
|
27241
27317
|
</dd>
|
|
27242
27318
|
</dl>
|
|
@@ -27255,9 +27331,9 @@ await client.shippingIntegrations.ontime360.orders.syncOneV1({
|
|
|
27255
27331
|
</dl>
|
|
27256
27332
|
</details>
|
|
27257
27333
|
|
|
27258
|
-
## ShippingIntegrations
|
|
27334
|
+
## ShippingIntegrations Ontime360 Creds
|
|
27259
27335
|
|
|
27260
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27336
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.OnTime360CredsLimited1</code></summary>
|
|
27261
27337
|
<dl>
|
|
27262
27338
|
<dd>
|
|
27263
27339
|
|
|
@@ -27269,7 +27345,7 @@ await client.shippingIntegrations.ontime360.orders.syncOneV1({
|
|
|
27269
27345
|
<dl>
|
|
27270
27346
|
<dd>
|
|
27271
27347
|
|
|
27272
|
-
Returns the caller's
|
|
27348
|
+
Returns the caller's OnTime360 credential for one provider, without the API key. | () -> (OnTime360CredsLimited1)
|
|
27273
27349
|
|
|
27274
27350
|
</dd>
|
|
27275
27351
|
</dl>
|
|
@@ -27285,7 +27361,7 @@ Returns the caller's Xcelerator credential for one provider, without password or
|
|
|
27285
27361
|
<dd>
|
|
27286
27362
|
|
|
27287
27363
|
```typescript
|
|
27288
|
-
await client.shippingIntegrations.
|
|
27364
|
+
await client.shippingIntegrations.ontime360.creds.detailV1("provider_org_id");
|
|
27289
27365
|
```
|
|
27290
27366
|
|
|
27291
27367
|
</dd>
|
|
@@ -27320,7 +27396,7 @@ await client.shippingIntegrations.xcelerator.creds.detailV1("provider_org_id");
|
|
|
27320
27396
|
</dl>
|
|
27321
27397
|
</details>
|
|
27322
27398
|
|
|
27323
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27399
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">listV1</a>() -> Chrt.OnTime360CredsListRes</code></summary>
|
|
27324
27400
|
<dl>
|
|
27325
27401
|
<dd>
|
|
27326
27402
|
|
|
@@ -27332,7 +27408,7 @@ await client.shippingIntegrations.xcelerator.creds.detailV1("provider_org_id");
|
|
|
27332
27408
|
<dl>
|
|
27333
27409
|
<dd>
|
|
27334
27410
|
|
|
27335
|
-
Lists the caller's
|
|
27411
|
+
Lists the caller's OnTime360 credentials, one per connected provider, without the API key. | () -> (OnTime360CredsListRes)
|
|
27336
27412
|
|
|
27337
27413
|
</dd>
|
|
27338
27414
|
</dl>
|
|
@@ -27348,7 +27424,7 @@ Lists the caller's Xcelerator credentials, one per connected provider, without p
|
|
|
27348
27424
|
<dd>
|
|
27349
27425
|
|
|
27350
27426
|
```typescript
|
|
27351
|
-
await client.shippingIntegrations.
|
|
27427
|
+
await client.shippingIntegrations.ontime360.creds.listV1();
|
|
27352
27428
|
```
|
|
27353
27429
|
|
|
27354
27430
|
</dd>
|
|
@@ -27375,7 +27451,7 @@ await client.shippingIntegrations.xcelerator.creds.listV1();
|
|
|
27375
27451
|
</dl>
|
|
27376
27452
|
</details>
|
|
27377
27453
|
|
|
27378
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27454
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.OnTime360CredsTestRes</code></summary>
|
|
27379
27455
|
<dl>
|
|
27380
27456
|
<dd>
|
|
27381
27457
|
|
|
@@ -27387,7 +27463,7 @@ await client.shippingIntegrations.xcelerator.creds.listV1();
|
|
|
27387
27463
|
<dl>
|
|
27388
27464
|
<dd>
|
|
27389
27465
|
|
|
27390
|
-
Confirms the caller's stored
|
|
27466
|
+
Confirms the caller's stored OnTime360 credentials for one provider can still perform a scoped read, best-effort refreshes the provider's own account label for the caller to eyeball, and reports the provider's own reported time zones beside the stored one. | authz: min_org_role=operator | () -> (OnTime360CredsTestRes)
|
|
27391
27467
|
|
|
27392
27468
|
</dd>
|
|
27393
27469
|
</dl>
|
|
@@ -27403,7 +27479,7 @@ Confirms the caller's stored Xcelerator credentials for one provider can still o
|
|
|
27403
27479
|
<dd>
|
|
27404
27480
|
|
|
27405
27481
|
```typescript
|
|
27406
|
-
await client.shippingIntegrations.
|
|
27482
|
+
await client.shippingIntegrations.ontime360.creds.testV1("provider_org_id");
|
|
27407
27483
|
```
|
|
27408
27484
|
|
|
27409
27485
|
</dd>
|
|
@@ -27438,7 +27514,7 @@ await client.shippingIntegrations.xcelerator.creds.testV1("provider_org_id");
|
|
|
27438
27514
|
</dl>
|
|
27439
27515
|
</details>
|
|
27440
27516
|
|
|
27441
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27517
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
27442
27518
|
<dl>
|
|
27443
27519
|
<dd>
|
|
27444
27520
|
|
|
@@ -27450,7 +27526,7 @@ await client.shippingIntegrations.xcelerator.creds.testV1("provider_org_id");
|
|
|
27450
27526
|
<dl>
|
|
27451
27527
|
<dd>
|
|
27452
27528
|
|
|
27453
|
-
Stores
|
|
27529
|
+
Stores OnTime360 credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (OnTime360CredsClientCreate1) -> (PydanticObjectId)
|
|
27454
27530
|
|
|
27455
27531
|
</dd>
|
|
27456
27532
|
</dl>
|
|
@@ -27466,11 +27542,11 @@ Stores Xcelerator credentials for one provider on behalf of the caller's organiz
|
|
|
27466
27542
|
<dd>
|
|
27467
27543
|
|
|
27468
27544
|
```typescript
|
|
27469
|
-
await client.shippingIntegrations.
|
|
27470
|
-
|
|
27471
|
-
|
|
27545
|
+
await client.shippingIntegrations.ontime360.creds.createV1("provider_org_id", {
|
|
27546
|
+
api_key: "api_key",
|
|
27547
|
+
base_url: "base_url",
|
|
27472
27548
|
schema_version: 1,
|
|
27473
|
-
|
|
27549
|
+
site_time_zone: "America/New_York",
|
|
27474
27550
|
});
|
|
27475
27551
|
```
|
|
27476
27552
|
|
|
@@ -27495,7 +27571,7 @@ await client.shippingIntegrations.xcelerator.creds.createV1("provider_org_id", {
|
|
|
27495
27571
|
<dl>
|
|
27496
27572
|
<dd>
|
|
27497
27573
|
|
|
27498
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27574
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OnTime360CredsClientCreate1`
|
|
27499
27575
|
|
|
27500
27576
|
</dd>
|
|
27501
27577
|
</dl>
|
|
@@ -27514,7 +27590,7 @@ await client.shippingIntegrations.xcelerator.creds.createV1("provider_org_id", {
|
|
|
27514
27590
|
</dl>
|
|
27515
27591
|
</details>
|
|
27516
27592
|
|
|
27517
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27593
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
27518
27594
|
<dl>
|
|
27519
27595
|
<dd>
|
|
27520
27596
|
|
|
@@ -27526,7 +27602,7 @@ await client.shippingIntegrations.xcelerator.creds.createV1("provider_org_id", {
|
|
|
27526
27602
|
<dl>
|
|
27527
27603
|
<dd>
|
|
27528
27604
|
|
|
27529
|
-
Deletes the caller's
|
|
27605
|
+
Deletes the caller's OnTime360 credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
|
|
27530
27606
|
|
|
27531
27607
|
</dd>
|
|
27532
27608
|
</dl>
|
|
@@ -27542,7 +27618,7 @@ Deletes the caller's Xcelerator credentials for one provider, stopping future sy
|
|
|
27542
27618
|
<dd>
|
|
27543
27619
|
|
|
27544
27620
|
```typescript
|
|
27545
|
-
await client.shippingIntegrations.
|
|
27621
|
+
await client.shippingIntegrations.ontime360.creds.deleteV1("provider_org_id");
|
|
27546
27622
|
```
|
|
27547
27623
|
|
|
27548
27624
|
</dd>
|
|
@@ -27577,7 +27653,7 @@ await client.shippingIntegrations.xcelerator.creds.deleteV1("provider_org_id");
|
|
|
27577
27653
|
</dl>
|
|
27578
27654
|
</details>
|
|
27579
27655
|
|
|
27580
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27656
|
+
<details><summary><code>client.shippingIntegrations.ontime360.creds.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
27581
27657
|
<dl>
|
|
27582
27658
|
<dd>
|
|
27583
27659
|
|
|
@@ -27589,7 +27665,7 @@ await client.shippingIntegrations.xcelerator.creds.deleteV1("provider_org_id");
|
|
|
27589
27665
|
<dl>
|
|
27590
27666
|
<dd>
|
|
27591
27667
|
|
|
27592
|
-
Updates the caller's
|
|
27668
|
+
Updates the caller's OnTime360 credentials for one provider. | authz: min_org_role=administrator | (OnTime360CredsClientUpdate1) -> (bool)
|
|
27593
27669
|
|
|
27594
27670
|
</dd>
|
|
27595
27671
|
</dl>
|
|
@@ -27605,7 +27681,7 @@ Updates the caller's Xcelerator credentials for one provider. | authz: min_org_r
|
|
|
27605
27681
|
<dd>
|
|
27606
27682
|
|
|
27607
27683
|
```typescript
|
|
27608
|
-
await client.shippingIntegrations.
|
|
27684
|
+
await client.shippingIntegrations.ontime360.creds.updateV1("provider_org_id");
|
|
27609
27685
|
```
|
|
27610
27686
|
|
|
27611
27687
|
</dd>
|
|
@@ -27629,7 +27705,7 @@ await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id");
|
|
|
27629
27705
|
<dl>
|
|
27630
27706
|
<dd>
|
|
27631
27707
|
|
|
27632
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27708
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OnTime360CredsClientUpdate1`
|
|
27633
27709
|
|
|
27634
27710
|
</dd>
|
|
27635
27711
|
</dl>
|
|
@@ -27648,9 +27724,9 @@ await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id");
|
|
|
27648
27724
|
</dl>
|
|
27649
27725
|
</details>
|
|
27650
27726
|
|
|
27651
|
-
## ShippingIntegrations
|
|
27727
|
+
## ShippingIntegrations Ontime360 Orders
|
|
27652
27728
|
|
|
27653
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27729
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.OnTime360Order1</code></summary>
|
|
27654
27730
|
<dl>
|
|
27655
27731
|
<dd>
|
|
27656
27732
|
|
|
@@ -27662,7 +27738,7 @@ await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id");
|
|
|
27662
27738
|
<dl>
|
|
27663
27739
|
<dd>
|
|
27664
27740
|
|
|
27665
|
-
Returns one mirrored
|
|
27741
|
+
Returns one mirrored OnTime360 order by the provider's own order GUID. | () -> (OnTime360Order1)
|
|
27666
27742
|
|
|
27667
27743
|
</dd>
|
|
27668
27744
|
</dl>
|
|
@@ -27678,7 +27754,7 @@ Returns one mirrored Xcelerator order by the provider's own order ID with the pr
|
|
|
27678
27754
|
<dd>
|
|
27679
27755
|
|
|
27680
27756
|
```typescript
|
|
27681
|
-
await client.shippingIntegrations.
|
|
27757
|
+
await client.shippingIntegrations.ontime360.orders.detailByIntegrationOrderIdV1(
|
|
27682
27758
|
"provider_org_id",
|
|
27683
27759
|
"integration_order_id",
|
|
27684
27760
|
);
|
|
@@ -27697,7 +27773,7 @@ await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1
|
|
|
27697
27773
|
<dl>
|
|
27698
27774
|
<dd>
|
|
27699
27775
|
|
|
27700
|
-
**providerOrgId:** `string` — CHRT org ID of the courier whose
|
|
27776
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose OnTime360 site holds the order
|
|
27701
27777
|
|
|
27702
27778
|
</dd>
|
|
27703
27779
|
</dl>
|
|
@@ -27705,7 +27781,7 @@ await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1
|
|
|
27705
27781
|
<dl>
|
|
27706
27782
|
<dd>
|
|
27707
27783
|
|
|
27708
|
-
**integrationOrderId:** `string` —
|
|
27784
|
+
**integrationOrderId:** `string` — OnTime360's own GUID for the order (its ID), as carried on a unified order row
|
|
27709
27785
|
|
|
27710
27786
|
</dd>
|
|
27711
27787
|
</dl>
|
|
@@ -27724,7 +27800,7 @@ await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1
|
|
|
27724
27800
|
</dl>
|
|
27725
27801
|
</details>
|
|
27726
27802
|
|
|
27727
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27803
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.OnTime360Order1</code></summary>
|
|
27728
27804
|
<dl>
|
|
27729
27805
|
<dd>
|
|
27730
27806
|
|
|
@@ -27736,7 +27812,7 @@ await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1
|
|
|
27736
27812
|
<dl>
|
|
27737
27813
|
<dd>
|
|
27738
27814
|
|
|
27739
|
-
Returns one mirrored
|
|
27815
|
+
Returns one mirrored OnTime360 order by its Mongo ObjectId. | () -> (OnTime360Order1)
|
|
27740
27816
|
|
|
27741
27817
|
</dd>
|
|
27742
27818
|
</dl>
|
|
@@ -27752,7 +27828,7 @@ Returns one mirrored Xcelerator order by its Mongo ObjectId with the provider or
|
|
|
27752
27828
|
<dd>
|
|
27753
27829
|
|
|
27754
27830
|
```typescript
|
|
27755
|
-
await client.shippingIntegrations.
|
|
27831
|
+
await client.shippingIntegrations.ontime360.orders.detailV1("id");
|
|
27756
27832
|
```
|
|
27757
27833
|
|
|
27758
27834
|
</dd>
|
|
@@ -27768,7 +27844,7 @@ await client.shippingIntegrations.xcelerator.orders.detailV1("id");
|
|
|
27768
27844
|
<dl>
|
|
27769
27845
|
<dd>
|
|
27770
27846
|
|
|
27771
|
-
**id:** `string` — Mongo ObjectId of the mirror document.
|
|
27847
|
+
**id:** `string` — Mongo ObjectId of the mirror document. OnTime360's own order GUID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
27772
27848
|
|
|
27773
27849
|
</dd>
|
|
27774
27850
|
</dl>
|
|
@@ -27787,7 +27863,7 @@ await client.shippingIntegrations.xcelerator.orders.detailV1("id");
|
|
|
27787
27863
|
</dl>
|
|
27788
27864
|
</details>
|
|
27789
27865
|
|
|
27790
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27866
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.OnTime360OrderListRes</code></summary>
|
|
27791
27867
|
<dl>
|
|
27792
27868
|
<dd>
|
|
27793
27869
|
|
|
@@ -27799,7 +27875,7 @@ await client.shippingIntegrations.xcelerator.orders.detailV1("id");
|
|
|
27799
27875
|
<dl>
|
|
27800
27876
|
<dd>
|
|
27801
27877
|
|
|
27802
|
-
Lists mirrored
|
|
27878
|
+
Lists mirrored OnTime360 orders for the caller's organization with filtering, sorting, pagination, and optional search. | () -> (OnTime360OrderListRes)
|
|
27803
27879
|
|
|
27804
27880
|
</dd>
|
|
27805
27881
|
</dl>
|
|
@@ -27815,7 +27891,7 @@ Lists mirrored Xcelerator orders with provider organizations expanded, filtering
|
|
|
27815
27891
|
<dd>
|
|
27816
27892
|
|
|
27817
27893
|
```typescript
|
|
27818
|
-
await client.shippingIntegrations.
|
|
27894
|
+
await client.shippingIntegrations.ontime360.orders.listV1({
|
|
27819
27895
|
sort_by: "mirrored_at_timestamp",
|
|
27820
27896
|
sort_order: "asc",
|
|
27821
27897
|
page: 1,
|
|
@@ -27823,7 +27899,7 @@ await client.shippingIntegrations.xcelerator.orders.listV1({
|
|
|
27823
27899
|
search: "search",
|
|
27824
27900
|
filter_provider_org_id: ["filter_provider_org_id"],
|
|
27825
27901
|
filter_integration_order_id: "filter_integration_order_id",
|
|
27826
|
-
|
|
27902
|
+
filter_provider_status_level: 1,
|
|
27827
27903
|
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
27828
27904
|
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
27829
27905
|
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
@@ -27846,7 +27922,7 @@ await client.shippingIntegrations.xcelerator.orders.listV1({
|
|
|
27846
27922
|
<dl>
|
|
27847
27923
|
<dd>
|
|
27848
27924
|
|
|
27849
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27925
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OrdersListV1Request`
|
|
27850
27926
|
|
|
27851
27927
|
</dd>
|
|
27852
27928
|
</dl>
|
|
@@ -27865,7 +27941,7 @@ await client.shippingIntegrations.xcelerator.orders.listV1({
|
|
|
27865
27941
|
</dl>
|
|
27866
27942
|
</details>
|
|
27867
27943
|
|
|
27868
|
-
<details><summary><code>client.shippingIntegrations.
|
|
27944
|
+
<details><summary><code>client.shippingIntegrations.ontime360.orders.<a href="/src/api/resources/shippingIntegrations/resources/ontime360/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.OnTime360Order1</code></summary>
|
|
27869
27945
|
<dl>
|
|
27870
27946
|
<dd>
|
|
27871
27947
|
|
|
@@ -27877,7 +27953,7 @@ await client.shippingIntegrations.xcelerator.orders.listV1({
|
|
|
27877
27953
|
<dl>
|
|
27878
27954
|
<dd>
|
|
27879
27955
|
|
|
27880
|
-
Fetches and mirrors one
|
|
27956
|
+
Fetches and mirrors one OnTime360 order by the provider's own order GUID, updating the unified order list alongside it. | authz: min_org_role=operator | (OnTime360OrderSyncOneReq) -> (OnTime360Order1)
|
|
27881
27957
|
|
|
27882
27958
|
</dd>
|
|
27883
27959
|
</dl>
|
|
@@ -27893,7 +27969,7 @@ Fetches and mirrors one Xcelerator order by the provider's own order ID. | authz
|
|
|
27893
27969
|
<dd>
|
|
27894
27970
|
|
|
27895
27971
|
```typescript
|
|
27896
|
-
await client.shippingIntegrations.
|
|
27972
|
+
await client.shippingIntegrations.ontime360.orders.syncOneV1({
|
|
27897
27973
|
integration_order_id: "integration_order_id",
|
|
27898
27974
|
provider_org_id: "provider_org_id",
|
|
27899
27975
|
});
|
|
@@ -27912,7 +27988,7 @@ await client.shippingIntegrations.xcelerator.orders.syncOneV1({
|
|
|
27912
27988
|
<dl>
|
|
27913
27989
|
<dd>
|
|
27914
27990
|
|
|
27915
|
-
**request:** `Chrt.shippingIntegrations.
|
|
27991
|
+
**request:** `Chrt.shippingIntegrations.ontime360.OnTime360OrderSyncOneReq`
|
|
27916
27992
|
|
|
27917
27993
|
</dd>
|
|
27918
27994
|
</dl>
|
|
@@ -27931,7 +28007,9 @@ await client.shippingIntegrations.xcelerator.orders.syncOneV1({
|
|
|
27931
28007
|
</dl>
|
|
27932
28008
|
</details>
|
|
27933
28009
|
|
|
27934
|
-
|
|
28010
|
+
## ShippingIntegrations Xcelerator Creds
|
|
28011
|
+
|
|
28012
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">detailV1</a>(providerOrgId) -> Chrt.XceleratorCredsLimited1</code></summary>
|
|
27935
28013
|
<dl>
|
|
27936
28014
|
<dd>
|
|
27937
28015
|
|
|
@@ -27943,7 +28021,7 @@ await client.shippingIntegrations.xcelerator.orders.syncOneV1({
|
|
|
27943
28021
|
<dl>
|
|
27944
28022
|
<dd>
|
|
27945
28023
|
|
|
27946
|
-
Returns
|
|
28024
|
+
Returns the caller's Xcelerator credential for one provider, without password or access token. | () -> (XceleratorCredsLimited1)
|
|
27947
28025
|
|
|
27948
28026
|
</dd>
|
|
27949
28027
|
</dl>
|
|
@@ -27959,10 +28037,125 @@ Returns distinct Xcelerator integration order IDs matching the query via case-in
|
|
|
27959
28037
|
<dd>
|
|
27960
28038
|
|
|
27961
28039
|
```typescript
|
|
27962
|
-
await client.shippingIntegrations.xcelerator.
|
|
27963
|
-
|
|
27964
|
-
|
|
27965
|
-
|
|
28040
|
+
await client.shippingIntegrations.xcelerator.creds.detailV1("provider_org_id");
|
|
28041
|
+
```
|
|
28042
|
+
|
|
28043
|
+
</dd>
|
|
28044
|
+
</dl>
|
|
28045
|
+
</dd>
|
|
28046
|
+
</dl>
|
|
28047
|
+
|
|
28048
|
+
#### ⚙️ Parameters
|
|
28049
|
+
|
|
28050
|
+
<dl>
|
|
28051
|
+
<dd>
|
|
28052
|
+
|
|
28053
|
+
<dl>
|
|
28054
|
+
<dd>
|
|
28055
|
+
|
|
28056
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
28057
|
+
|
|
28058
|
+
</dd>
|
|
28059
|
+
</dl>
|
|
28060
|
+
|
|
28061
|
+
<dl>
|
|
28062
|
+
<dd>
|
|
28063
|
+
|
|
28064
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
28065
|
+
|
|
28066
|
+
</dd>
|
|
28067
|
+
</dl>
|
|
28068
|
+
</dd>
|
|
28069
|
+
</dl>
|
|
28070
|
+
|
|
28071
|
+
</dd>
|
|
28072
|
+
</dl>
|
|
28073
|
+
</details>
|
|
28074
|
+
|
|
28075
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">listV1</a>() -> Chrt.XceleratorCredsListRes</code></summary>
|
|
28076
|
+
<dl>
|
|
28077
|
+
<dd>
|
|
28078
|
+
|
|
28079
|
+
#### 📝 Description
|
|
28080
|
+
|
|
28081
|
+
<dl>
|
|
28082
|
+
<dd>
|
|
28083
|
+
|
|
28084
|
+
<dl>
|
|
28085
|
+
<dd>
|
|
28086
|
+
|
|
28087
|
+
Lists the caller's Xcelerator credentials, one per connected provider, without password or access token. | () -> (XceleratorCredsListRes)
|
|
28088
|
+
|
|
28089
|
+
</dd>
|
|
28090
|
+
</dl>
|
|
28091
|
+
</dd>
|
|
28092
|
+
</dl>
|
|
28093
|
+
|
|
28094
|
+
#### 🔌 Usage
|
|
28095
|
+
|
|
28096
|
+
<dl>
|
|
28097
|
+
<dd>
|
|
28098
|
+
|
|
28099
|
+
<dl>
|
|
28100
|
+
<dd>
|
|
28101
|
+
|
|
28102
|
+
```typescript
|
|
28103
|
+
await client.shippingIntegrations.xcelerator.creds.listV1();
|
|
28104
|
+
```
|
|
28105
|
+
|
|
28106
|
+
</dd>
|
|
28107
|
+
</dl>
|
|
28108
|
+
</dd>
|
|
28109
|
+
</dl>
|
|
28110
|
+
|
|
28111
|
+
#### ⚙️ Parameters
|
|
28112
|
+
|
|
28113
|
+
<dl>
|
|
28114
|
+
<dd>
|
|
28115
|
+
|
|
28116
|
+
<dl>
|
|
28117
|
+
<dd>
|
|
28118
|
+
|
|
28119
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
28120
|
+
|
|
28121
|
+
</dd>
|
|
28122
|
+
</dl>
|
|
28123
|
+
</dd>
|
|
28124
|
+
</dl>
|
|
28125
|
+
|
|
28126
|
+
</dd>
|
|
28127
|
+
</dl>
|
|
28128
|
+
</details>
|
|
28129
|
+
|
|
28130
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">testV1</a>(providerOrgId) -> Chrt.XceleratorCredsTestRes</code></summary>
|
|
28131
|
+
<dl>
|
|
28132
|
+
<dd>
|
|
28133
|
+
|
|
28134
|
+
#### 📝 Description
|
|
28135
|
+
|
|
28136
|
+
<dl>
|
|
28137
|
+
<dd>
|
|
28138
|
+
|
|
28139
|
+
<dl>
|
|
28140
|
+
<dd>
|
|
28141
|
+
|
|
28142
|
+
Confirms the caller's stored Xcelerator credentials for one provider can still obtain an access token, and best-effort refreshes the provider's own account label for the caller to eyeball. | authz: min_org_role=operator | () -> (XceleratorCredsTestRes)
|
|
28143
|
+
|
|
28144
|
+
</dd>
|
|
28145
|
+
</dl>
|
|
28146
|
+
</dd>
|
|
28147
|
+
</dl>
|
|
28148
|
+
|
|
28149
|
+
#### 🔌 Usage
|
|
28150
|
+
|
|
28151
|
+
<dl>
|
|
28152
|
+
<dd>
|
|
28153
|
+
|
|
28154
|
+
<dl>
|
|
28155
|
+
<dd>
|
|
28156
|
+
|
|
28157
|
+
```typescript
|
|
28158
|
+
await client.shippingIntegrations.xcelerator.creds.testV1("provider_org_id");
|
|
27966
28159
|
```
|
|
27967
28160
|
|
|
27968
28161
|
</dd>
|
|
@@ -27978,7 +28171,500 @@ await client.shippingIntegrations.xcelerator.orders.typeaheadV1({
|
|
|
27978
28171
|
<dl>
|
|
27979
28172
|
<dd>
|
|
27980
28173
|
|
|
27981
|
-
**
|
|
28174
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
28175
|
+
|
|
28176
|
+
</dd>
|
|
28177
|
+
</dl>
|
|
28178
|
+
|
|
28179
|
+
<dl>
|
|
28180
|
+
<dd>
|
|
28181
|
+
|
|
28182
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
28183
|
+
|
|
28184
|
+
</dd>
|
|
28185
|
+
</dl>
|
|
28186
|
+
</dd>
|
|
28187
|
+
</dl>
|
|
28188
|
+
|
|
28189
|
+
</dd>
|
|
28190
|
+
</dl>
|
|
28191
|
+
</details>
|
|
28192
|
+
|
|
28193
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">createV1</a>(providerOrgId, { ...params }) -> string</code></summary>
|
|
28194
|
+
<dl>
|
|
28195
|
+
<dd>
|
|
28196
|
+
|
|
28197
|
+
#### 📝 Description
|
|
28198
|
+
|
|
28199
|
+
<dl>
|
|
28200
|
+
<dd>
|
|
28201
|
+
|
|
28202
|
+
<dl>
|
|
28203
|
+
<dd>
|
|
28204
|
+
|
|
28205
|
+
Stores Xcelerator credentials for one provider on behalf of the caller's organization. | authz: min_org_role=administrator | (XceleratorCredsClientCreate1) -> (PydanticObjectId)
|
|
28206
|
+
|
|
28207
|
+
</dd>
|
|
28208
|
+
</dl>
|
|
28209
|
+
</dd>
|
|
28210
|
+
</dl>
|
|
28211
|
+
|
|
28212
|
+
#### 🔌 Usage
|
|
28213
|
+
|
|
28214
|
+
<dl>
|
|
28215
|
+
<dd>
|
|
28216
|
+
|
|
28217
|
+
<dl>
|
|
28218
|
+
<dd>
|
|
28219
|
+
|
|
28220
|
+
```typescript
|
|
28221
|
+
await client.shippingIntegrations.xcelerator.creds.createV1("provider_org_id", {
|
|
28222
|
+
base_url: "https://tenant.dispatchscience.com",
|
|
28223
|
+
password: "password",
|
|
28224
|
+
schema_version: 1,
|
|
28225
|
+
username: "username",
|
|
28226
|
+
});
|
|
28227
|
+
```
|
|
28228
|
+
|
|
28229
|
+
</dd>
|
|
28230
|
+
</dl>
|
|
28231
|
+
</dd>
|
|
28232
|
+
</dl>
|
|
28233
|
+
|
|
28234
|
+
#### ⚙️ Parameters
|
|
28235
|
+
|
|
28236
|
+
<dl>
|
|
28237
|
+
<dd>
|
|
28238
|
+
|
|
28239
|
+
<dl>
|
|
28240
|
+
<dd>
|
|
28241
|
+
|
|
28242
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
28243
|
+
|
|
28244
|
+
</dd>
|
|
28245
|
+
</dl>
|
|
28246
|
+
|
|
28247
|
+
<dl>
|
|
28248
|
+
<dd>
|
|
28249
|
+
|
|
28250
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientCreate1`
|
|
28251
|
+
|
|
28252
|
+
</dd>
|
|
28253
|
+
</dl>
|
|
28254
|
+
|
|
28255
|
+
<dl>
|
|
28256
|
+
<dd>
|
|
28257
|
+
|
|
28258
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
28259
|
+
|
|
28260
|
+
</dd>
|
|
28261
|
+
</dl>
|
|
28262
|
+
</dd>
|
|
28263
|
+
</dl>
|
|
28264
|
+
|
|
28265
|
+
</dd>
|
|
28266
|
+
</dl>
|
|
28267
|
+
</details>
|
|
28268
|
+
|
|
28269
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">deleteV1</a>(providerOrgId) -> boolean</code></summary>
|
|
28270
|
+
<dl>
|
|
28271
|
+
<dd>
|
|
28272
|
+
|
|
28273
|
+
#### 📝 Description
|
|
28274
|
+
|
|
28275
|
+
<dl>
|
|
28276
|
+
<dd>
|
|
28277
|
+
|
|
28278
|
+
<dl>
|
|
28279
|
+
<dd>
|
|
28280
|
+
|
|
28281
|
+
Deletes the caller's Xcelerator credentials for one provider, stopping future syncs. | authz: min_org_role=administrator | () -> (bool)
|
|
28282
|
+
|
|
28283
|
+
</dd>
|
|
28284
|
+
</dl>
|
|
28285
|
+
</dd>
|
|
28286
|
+
</dl>
|
|
28287
|
+
|
|
28288
|
+
#### 🔌 Usage
|
|
28289
|
+
|
|
28290
|
+
<dl>
|
|
28291
|
+
<dd>
|
|
28292
|
+
|
|
28293
|
+
<dl>
|
|
28294
|
+
<dd>
|
|
28295
|
+
|
|
28296
|
+
```typescript
|
|
28297
|
+
await client.shippingIntegrations.xcelerator.creds.deleteV1("provider_org_id");
|
|
28298
|
+
```
|
|
28299
|
+
|
|
28300
|
+
</dd>
|
|
28301
|
+
</dl>
|
|
28302
|
+
</dd>
|
|
28303
|
+
</dl>
|
|
28304
|
+
|
|
28305
|
+
#### ⚙️ Parameters
|
|
28306
|
+
|
|
28307
|
+
<dl>
|
|
28308
|
+
<dd>
|
|
28309
|
+
|
|
28310
|
+
<dl>
|
|
28311
|
+
<dd>
|
|
28312
|
+
|
|
28313
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
28314
|
+
|
|
28315
|
+
</dd>
|
|
28316
|
+
</dl>
|
|
28317
|
+
|
|
28318
|
+
<dl>
|
|
28319
|
+
<dd>
|
|
28320
|
+
|
|
28321
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
28322
|
+
|
|
28323
|
+
</dd>
|
|
28324
|
+
</dl>
|
|
28325
|
+
</dd>
|
|
28326
|
+
</dl>
|
|
28327
|
+
|
|
28328
|
+
</dd>
|
|
28329
|
+
</dl>
|
|
28330
|
+
</details>
|
|
28331
|
+
|
|
28332
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.creds.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/creds/client/Client.ts">updateV1</a>(providerOrgId, { ...params }) -> boolean</code></summary>
|
|
28333
|
+
<dl>
|
|
28334
|
+
<dd>
|
|
28335
|
+
|
|
28336
|
+
#### 📝 Description
|
|
28337
|
+
|
|
28338
|
+
<dl>
|
|
28339
|
+
<dd>
|
|
28340
|
+
|
|
28341
|
+
<dl>
|
|
28342
|
+
<dd>
|
|
28343
|
+
|
|
28344
|
+
Updates the caller's Xcelerator credentials for one provider. | authz: min_org_role=administrator | (XceleratorCredsClientUpdate1) -> (bool)
|
|
28345
|
+
|
|
28346
|
+
</dd>
|
|
28347
|
+
</dl>
|
|
28348
|
+
</dd>
|
|
28349
|
+
</dl>
|
|
28350
|
+
|
|
28351
|
+
#### 🔌 Usage
|
|
28352
|
+
|
|
28353
|
+
<dl>
|
|
28354
|
+
<dd>
|
|
28355
|
+
|
|
28356
|
+
<dl>
|
|
28357
|
+
<dd>
|
|
28358
|
+
|
|
28359
|
+
```typescript
|
|
28360
|
+
await client.shippingIntegrations.xcelerator.creds.updateV1("provider_org_id");
|
|
28361
|
+
```
|
|
28362
|
+
|
|
28363
|
+
</dd>
|
|
28364
|
+
</dl>
|
|
28365
|
+
</dd>
|
|
28366
|
+
</dl>
|
|
28367
|
+
|
|
28368
|
+
#### ⚙️ Parameters
|
|
28369
|
+
|
|
28370
|
+
<dl>
|
|
28371
|
+
<dd>
|
|
28372
|
+
|
|
28373
|
+
<dl>
|
|
28374
|
+
<dd>
|
|
28375
|
+
|
|
28376
|
+
**providerOrgId:** `string` — Must be a string starting with `org_`
|
|
28377
|
+
|
|
28378
|
+
</dd>
|
|
28379
|
+
</dl>
|
|
28380
|
+
|
|
28381
|
+
<dl>
|
|
28382
|
+
<dd>
|
|
28383
|
+
|
|
28384
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.XceleratorCredsClientUpdate1`
|
|
28385
|
+
|
|
28386
|
+
</dd>
|
|
28387
|
+
</dl>
|
|
28388
|
+
|
|
28389
|
+
<dl>
|
|
28390
|
+
<dd>
|
|
28391
|
+
|
|
28392
|
+
**requestOptions:** `Creds.RequestOptions`
|
|
28393
|
+
|
|
28394
|
+
</dd>
|
|
28395
|
+
</dl>
|
|
28396
|
+
</dd>
|
|
28397
|
+
</dl>
|
|
28398
|
+
|
|
28399
|
+
</dd>
|
|
28400
|
+
</dl>
|
|
28401
|
+
</details>
|
|
28402
|
+
|
|
28403
|
+
## ShippingIntegrations Xcelerator Orders
|
|
28404
|
+
|
|
28405
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">detailByIntegrationOrderIdV1</a>(providerOrgId, integrationOrderId) -> Chrt.XceleratorOrderExpanded1</code></summary>
|
|
28406
|
+
<dl>
|
|
28407
|
+
<dd>
|
|
28408
|
+
|
|
28409
|
+
#### 📝 Description
|
|
28410
|
+
|
|
28411
|
+
<dl>
|
|
28412
|
+
<dd>
|
|
28413
|
+
|
|
28414
|
+
<dl>
|
|
28415
|
+
<dd>
|
|
28416
|
+
|
|
28417
|
+
Returns one mirrored Xcelerator order by the provider's own order ID with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
28418
|
+
|
|
28419
|
+
</dd>
|
|
28420
|
+
</dl>
|
|
28421
|
+
</dd>
|
|
28422
|
+
</dl>
|
|
28423
|
+
|
|
28424
|
+
#### 🔌 Usage
|
|
28425
|
+
|
|
28426
|
+
<dl>
|
|
28427
|
+
<dd>
|
|
28428
|
+
|
|
28429
|
+
<dl>
|
|
28430
|
+
<dd>
|
|
28431
|
+
|
|
28432
|
+
```typescript
|
|
28433
|
+
await client.shippingIntegrations.xcelerator.orders.detailByIntegrationOrderIdV1(
|
|
28434
|
+
"provider_org_id",
|
|
28435
|
+
"integration_order_id",
|
|
28436
|
+
);
|
|
28437
|
+
```
|
|
28438
|
+
|
|
28439
|
+
</dd>
|
|
28440
|
+
</dl>
|
|
28441
|
+
</dd>
|
|
28442
|
+
</dl>
|
|
28443
|
+
|
|
28444
|
+
#### ⚙️ Parameters
|
|
28445
|
+
|
|
28446
|
+
<dl>
|
|
28447
|
+
<dd>
|
|
28448
|
+
|
|
28449
|
+
<dl>
|
|
28450
|
+
<dd>
|
|
28451
|
+
|
|
28452
|
+
**providerOrgId:** `string` — CHRT org ID of the courier whose Xcelerator instance holds the order
|
|
28453
|
+
|
|
28454
|
+
</dd>
|
|
28455
|
+
</dl>
|
|
28456
|
+
|
|
28457
|
+
<dl>
|
|
28458
|
+
<dd>
|
|
28459
|
+
|
|
28460
|
+
**integrationOrderId:** `string` — Xcelerator's own ID for the order (its OrderTrackingId), as carried on a unified order row
|
|
28461
|
+
|
|
28462
|
+
</dd>
|
|
28463
|
+
</dl>
|
|
28464
|
+
|
|
28465
|
+
<dl>
|
|
28466
|
+
<dd>
|
|
28467
|
+
|
|
28468
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
28469
|
+
|
|
28470
|
+
</dd>
|
|
28471
|
+
</dl>
|
|
28472
|
+
</dd>
|
|
28473
|
+
</dl>
|
|
28474
|
+
|
|
28475
|
+
</dd>
|
|
28476
|
+
</dl>
|
|
28477
|
+
</details>
|
|
28478
|
+
|
|
28479
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">detailV1</a>(id) -> Chrt.XceleratorOrderExpanded1</code></summary>
|
|
28480
|
+
<dl>
|
|
28481
|
+
<dd>
|
|
28482
|
+
|
|
28483
|
+
#### 📝 Description
|
|
28484
|
+
|
|
28485
|
+
<dl>
|
|
28486
|
+
<dd>
|
|
28487
|
+
|
|
28488
|
+
<dl>
|
|
28489
|
+
<dd>
|
|
28490
|
+
|
|
28491
|
+
Returns one mirrored Xcelerator order by its Mongo ObjectId with the provider organization expanded. | () -> (XceleratorOrderExpanded1)
|
|
28492
|
+
|
|
28493
|
+
</dd>
|
|
28494
|
+
</dl>
|
|
28495
|
+
</dd>
|
|
28496
|
+
</dl>
|
|
28497
|
+
|
|
28498
|
+
#### 🔌 Usage
|
|
28499
|
+
|
|
28500
|
+
<dl>
|
|
28501
|
+
<dd>
|
|
28502
|
+
|
|
28503
|
+
<dl>
|
|
28504
|
+
<dd>
|
|
28505
|
+
|
|
28506
|
+
```typescript
|
|
28507
|
+
await client.shippingIntegrations.xcelerator.orders.detailV1("id");
|
|
28508
|
+
```
|
|
28509
|
+
|
|
28510
|
+
</dd>
|
|
28511
|
+
</dl>
|
|
28512
|
+
</dd>
|
|
28513
|
+
</dl>
|
|
28514
|
+
|
|
28515
|
+
#### ⚙️ Parameters
|
|
28516
|
+
|
|
28517
|
+
<dl>
|
|
28518
|
+
<dd>
|
|
28519
|
+
|
|
28520
|
+
<dl>
|
|
28521
|
+
<dd>
|
|
28522
|
+
|
|
28523
|
+
**id:** `string` — Mongo ObjectId of the mirror document. Xcelerator's own order ID is the integration_order_id, accepted by the by_integration_order_id route.
|
|
28524
|
+
|
|
28525
|
+
</dd>
|
|
28526
|
+
</dl>
|
|
28527
|
+
|
|
28528
|
+
<dl>
|
|
28529
|
+
<dd>
|
|
28530
|
+
|
|
28531
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
28532
|
+
|
|
28533
|
+
</dd>
|
|
28534
|
+
</dl>
|
|
28535
|
+
</dd>
|
|
28536
|
+
</dl>
|
|
28537
|
+
|
|
28538
|
+
</dd>
|
|
28539
|
+
</dl>
|
|
28540
|
+
</details>
|
|
28541
|
+
|
|
28542
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">listV1</a>({ ...params }) -> Chrt.XceleratorOrderListRes</code></summary>
|
|
28543
|
+
<dl>
|
|
28544
|
+
<dd>
|
|
28545
|
+
|
|
28546
|
+
#### 📝 Description
|
|
28547
|
+
|
|
28548
|
+
<dl>
|
|
28549
|
+
<dd>
|
|
28550
|
+
|
|
28551
|
+
<dl>
|
|
28552
|
+
<dd>
|
|
28553
|
+
|
|
28554
|
+
Lists mirrored Xcelerator orders with provider organizations expanded, filtering, sorting, pagination, and optional search. | () -> (XceleratorOrderListRes)
|
|
28555
|
+
|
|
28556
|
+
</dd>
|
|
28557
|
+
</dl>
|
|
28558
|
+
</dd>
|
|
28559
|
+
</dl>
|
|
28560
|
+
|
|
28561
|
+
#### 🔌 Usage
|
|
28562
|
+
|
|
28563
|
+
<dl>
|
|
28564
|
+
<dd>
|
|
28565
|
+
|
|
28566
|
+
<dl>
|
|
28567
|
+
<dd>
|
|
28568
|
+
|
|
28569
|
+
```typescript
|
|
28570
|
+
await client.shippingIntegrations.xcelerator.orders.listV1({
|
|
28571
|
+
sort_by: "mirrored_at_timestamp",
|
|
28572
|
+
sort_order: "asc",
|
|
28573
|
+
page: 1,
|
|
28574
|
+
page_size: 1,
|
|
28575
|
+
search: "search",
|
|
28576
|
+
filter_provider_org_id: ["filter_provider_org_id"],
|
|
28577
|
+
filter_integration_order_id: "filter_integration_order_id",
|
|
28578
|
+
filter_provider_status_raw: "filter_provider_status_raw",
|
|
28579
|
+
filter_mirrored_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
28580
|
+
filter_mirrored_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
28581
|
+
filter_created_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
28582
|
+
filter_created_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
28583
|
+
filter_updated_at_timestamp_gte: "2024-01-15T09:30:00Z",
|
|
28584
|
+
filter_updated_at_timestamp_lte: "2024-01-15T09:30:00Z",
|
|
28585
|
+
});
|
|
28586
|
+
```
|
|
28587
|
+
|
|
28588
|
+
</dd>
|
|
28589
|
+
</dl>
|
|
28590
|
+
</dd>
|
|
28591
|
+
</dl>
|
|
28592
|
+
|
|
28593
|
+
#### ⚙️ Parameters
|
|
28594
|
+
|
|
28595
|
+
<dl>
|
|
28596
|
+
<dd>
|
|
28597
|
+
|
|
28598
|
+
<dl>
|
|
28599
|
+
<dd>
|
|
28600
|
+
|
|
28601
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.OrdersListV1Request`
|
|
28602
|
+
|
|
28603
|
+
</dd>
|
|
28604
|
+
</dl>
|
|
28605
|
+
|
|
28606
|
+
<dl>
|
|
28607
|
+
<dd>
|
|
28608
|
+
|
|
28609
|
+
**requestOptions:** `Orders.RequestOptions`
|
|
28610
|
+
|
|
28611
|
+
</dd>
|
|
28612
|
+
</dl>
|
|
28613
|
+
</dd>
|
|
28614
|
+
</dl>
|
|
28615
|
+
|
|
28616
|
+
</dd>
|
|
28617
|
+
</dl>
|
|
28618
|
+
</details>
|
|
28619
|
+
|
|
28620
|
+
<details><summary><code>client.shippingIntegrations.xcelerator.orders.<a href="/src/api/resources/shippingIntegrations/resources/xcelerator/resources/orders/client/Client.ts">syncOneV1</a>({ ...params }) -> Chrt.XceleratorOrder1</code></summary>
|
|
28621
|
+
<dl>
|
|
28622
|
+
<dd>
|
|
28623
|
+
|
|
28624
|
+
#### 📝 Description
|
|
28625
|
+
|
|
28626
|
+
<dl>
|
|
28627
|
+
<dd>
|
|
28628
|
+
|
|
28629
|
+
<dl>
|
|
28630
|
+
<dd>
|
|
28631
|
+
|
|
28632
|
+
Fetches and mirrors one Xcelerator order by the provider's own order ID. | authz: min_org_role=operator | (XceleratorOrderSyncOneReq) -> (XceleratorOrder1)
|
|
28633
|
+
|
|
28634
|
+
</dd>
|
|
28635
|
+
</dl>
|
|
28636
|
+
</dd>
|
|
28637
|
+
</dl>
|
|
28638
|
+
|
|
28639
|
+
#### 🔌 Usage
|
|
28640
|
+
|
|
28641
|
+
<dl>
|
|
28642
|
+
<dd>
|
|
28643
|
+
|
|
28644
|
+
<dl>
|
|
28645
|
+
<dd>
|
|
28646
|
+
|
|
28647
|
+
```typescript
|
|
28648
|
+
await client.shippingIntegrations.xcelerator.orders.syncOneV1({
|
|
28649
|
+
integration_order_id: "integration_order_id",
|
|
28650
|
+
provider_org_id: "provider_org_id",
|
|
28651
|
+
});
|
|
28652
|
+
```
|
|
28653
|
+
|
|
28654
|
+
</dd>
|
|
28655
|
+
</dl>
|
|
28656
|
+
</dd>
|
|
28657
|
+
</dl>
|
|
28658
|
+
|
|
28659
|
+
#### ⚙️ Parameters
|
|
28660
|
+
|
|
28661
|
+
<dl>
|
|
28662
|
+
<dd>
|
|
28663
|
+
|
|
28664
|
+
<dl>
|
|
28665
|
+
<dd>
|
|
28666
|
+
|
|
28667
|
+
**request:** `Chrt.shippingIntegrations.xcelerator.XceleratorOrderSyncOneReq`
|
|
27982
28668
|
|
|
27983
28669
|
</dd>
|
|
27984
28670
|
</dl>
|