@simpleapps-com/augur-api 2026.10.31 → 2026.11.1
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/README.md +84 -33
- package/SKILL.md +25 -24
- package/dist/client.d.ts +334 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +179 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +19 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +70 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19875 -18513
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19874 -18513
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +297 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1093 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +546 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1489 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +34 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,925 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the logistics service.
|
|
3
|
+
* Multi-carrier shipping logistics for label generation, tracking, and delivery coordination
|
|
4
|
+
*
|
|
5
|
+
* Public specs (the source of truth for every shape below):
|
|
6
|
+
* https://logistics.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
|
|
7
|
+
* params and query params, each with type and required flag. Grep it for a path; for a GET
|
|
8
|
+
* that line is all you need. Bodies are not in it.
|
|
9
|
+
* https://logistics.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
10
|
+
* field by field, descriptions, formats and documented errors.
|
|
11
|
+
* https://logistics.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
12
|
+
* services.
|
|
13
|
+
*
|
|
14
|
+
* Source: shared/specs/logistics.json
|
|
15
|
+
*
|
|
16
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
17
|
+
*/
|
|
18
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
19
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
20
|
+
/** Params for GET /fedex/rates */
|
|
21
|
+
export interface FedexRatesListParams extends EdgeCacheParams {
|
|
22
|
+
/** From address line 1 */
|
|
23
|
+
fromAddress1: string;
|
|
24
|
+
/** Origin (ship-from) city name */
|
|
25
|
+
fromCity: string;
|
|
26
|
+
/** From country code (default: US) */
|
|
27
|
+
fromCountryCode?: string;
|
|
28
|
+
/** Origin (ship-from) postal or ZIP code */
|
|
29
|
+
fromPostalCode: string;
|
|
30
|
+
/** Origin (ship-from) two-letter state or province code */
|
|
31
|
+
fromStateProvinceCode: string;
|
|
32
|
+
/** Include transitDays, estimatedDeliveryDate and deliveryBy per service [Y|N] (Default: N) */
|
|
33
|
+
includeTransitTime?: string;
|
|
34
|
+
/** To address line 1 */
|
|
35
|
+
toAddress1: string;
|
|
36
|
+
/** Destination (ship-to) city name */
|
|
37
|
+
toCity: string;
|
|
38
|
+
/** To country code (default: US) */
|
|
39
|
+
toCountryCode?: string;
|
|
40
|
+
/** Destination (ship-to) postal or ZIP code */
|
|
41
|
+
toPostalCode: string;
|
|
42
|
+
/**
|
|
43
|
+
* Residential destination flag: true or 1 marks the ship-to address residential; anything else,
|
|
44
|
+
* or absent, is commercial
|
|
45
|
+
*/
|
|
46
|
+
toResidential?: string;
|
|
47
|
+
/** Destination (ship-to) two-letter state or province code */
|
|
48
|
+
toStateProvinceCode: string;
|
|
49
|
+
/** Package weight in pounds */
|
|
50
|
+
weight: number;
|
|
51
|
+
}
|
|
52
|
+
/** Params for GET /rts/brands */
|
|
53
|
+
export interface RtsBrandsListParams extends EdgeCacheParams {
|
|
54
|
+
/** Optional case-insensitive name filter */
|
|
55
|
+
search?: string;
|
|
56
|
+
}
|
|
57
|
+
/** Params for GET /rts/brands/{brandId}/machines */
|
|
58
|
+
export interface RtsBrandsMachinesListParams extends EdgeCacheParams {
|
|
59
|
+
/** Optional case-insensitive name filter */
|
|
60
|
+
search?: string;
|
|
61
|
+
}
|
|
62
|
+
/** Params for GET /rts/machines/{machineId}/tracks */
|
|
63
|
+
export type RtsMachinesTracksListParams = EdgeCacheParams;
|
|
64
|
+
/** Params for GET /rts/search/machines */
|
|
65
|
+
export interface RtsSearchMachinesListParams extends EdgeCacheParams {
|
|
66
|
+
/** Search term (matches machine name and brand name) */
|
|
67
|
+
q: string;
|
|
68
|
+
}
|
|
69
|
+
/** Params for GET /rts/track/{trackId} */
|
|
70
|
+
export type RtsTrackGetParams = EdgeCacheParams;
|
|
71
|
+
/** Params for GET /rts/tracks */
|
|
72
|
+
export interface RtsTracksListParams extends EdgeCacheParams {
|
|
73
|
+
/** Optional search filter (track name, size, or tread pattern) */
|
|
74
|
+
search?: string;
|
|
75
|
+
/** Optional track class filter */
|
|
76
|
+
trackClass?: string;
|
|
77
|
+
}
|
|
78
|
+
/** Params for GET /shipping-methods */
|
|
79
|
+
export interface ShippingMethodsListParams extends EdgeCacheParams {
|
|
80
|
+
/** Limit number of results (Default: 10) */
|
|
81
|
+
limit?: number;
|
|
82
|
+
/** Starting offset (Default: 0) */
|
|
83
|
+
offset?: number;
|
|
84
|
+
/** Order by field and direction (Default: shipping_methods_uid|ASC) */
|
|
85
|
+
orderBy?: string;
|
|
86
|
+
/** Filter by carrier address id */
|
|
87
|
+
shippingMethodsId?: number;
|
|
88
|
+
/** Filter by shipping type */
|
|
89
|
+
shippingType?: string;
|
|
90
|
+
/**
|
|
91
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
92
|
+
* (704,705); -1 for every status. Default: 704 and 705
|
|
93
|
+
*/
|
|
94
|
+
statusCd?: number | number[];
|
|
95
|
+
}
|
|
96
|
+
/** Params for GET /shipping-methods/{shippingMethodsUid} */
|
|
97
|
+
export interface ShippingMethodsGetParams extends EdgeCacheParams {
|
|
98
|
+
/** Carrier address id, used when the path uid is 0 */
|
|
99
|
+
shippingMethodsId?: number;
|
|
100
|
+
}
|
|
101
|
+
/** Params for GET /shipvia/rates */
|
|
102
|
+
export interface ShipviaRatesListParams extends EdgeCacheParams {
|
|
103
|
+
/**
|
|
104
|
+
* (Optional) Carrier filter: "standard" for UPS/FedEx/USPS, "UPS,FEDEX" for specific carriers, or
|
|
105
|
+
* omit for all carriers
|
|
106
|
+
*/
|
|
107
|
+
carriers?: string;
|
|
108
|
+
/** (Optional) Dimension unit (IN or CM) */
|
|
109
|
+
dimensionUnit?: string;
|
|
110
|
+
/** (Optional) Origin city */
|
|
111
|
+
fromCity?: string;
|
|
112
|
+
/** (Optional) Origin country code (2-letter, default: US) */
|
|
113
|
+
fromCountry?: string;
|
|
114
|
+
/** (Required) Origin postal/ZIP code */
|
|
115
|
+
fromPostalCode: string;
|
|
116
|
+
/** (Optional) Origin state/province (2-letter code) */
|
|
117
|
+
fromState?: string;
|
|
118
|
+
/** (Required) ShipVia location ID */
|
|
119
|
+
locationId: number;
|
|
120
|
+
/** (Optional) Package height */
|
|
121
|
+
packageHeight?: number;
|
|
122
|
+
/** (Optional) Package length */
|
|
123
|
+
packageLength?: number;
|
|
124
|
+
/** (Optional) Package width */
|
|
125
|
+
packageWidth?: number;
|
|
126
|
+
/** (Optional) Residential delivery flag (default: true) */
|
|
127
|
+
residential?: boolean;
|
|
128
|
+
/** (Optional) Service type filter: ground, express, or overnight */
|
|
129
|
+
serviceType?: string;
|
|
130
|
+
/** (Optional) Destination city */
|
|
131
|
+
toCity?: string;
|
|
132
|
+
/** (Optional) Destination country code (2-letter, default: US) */
|
|
133
|
+
toCountry?: string;
|
|
134
|
+
/** (Required) Destination postal/ZIP code */
|
|
135
|
+
toPostalCode: string;
|
|
136
|
+
/** (Optional) Destination state/province (2-letter code) */
|
|
137
|
+
toState?: string;
|
|
138
|
+
/** (Required) Total package weight */
|
|
139
|
+
totalWeight: number;
|
|
140
|
+
/** (Required) Weight unit (LBS or KG) */
|
|
141
|
+
weightUnit: string;
|
|
142
|
+
}
|
|
143
|
+
/** Params for GET /shipvia/rates/ltl */
|
|
144
|
+
export interface ShipviaRatesLtlListParams extends EdgeCacheParams {
|
|
145
|
+
/**
|
|
146
|
+
* (Optional) Carrier filter: "standard" for major LTL carriers, "FEDEX_FREIGHT,UPS_FREIGHT" for
|
|
147
|
+
* specific carriers, or omit for all LTL carriers
|
|
148
|
+
*/
|
|
149
|
+
carriers?: string;
|
|
150
|
+
/**
|
|
151
|
+
* (Required) NMFC freight class: 50, 55, 60, 65, 70, 77.5, 85, 92.5, 100, 110, 125, 150, 175,
|
|
152
|
+
* 200, 250, 300, 400, 500
|
|
153
|
+
*/
|
|
154
|
+
commodityClass: string;
|
|
155
|
+
/** (Required) Description of commodity being shipped */
|
|
156
|
+
commodityDescription: string;
|
|
157
|
+
/** (Optional) Special delivery instructions (liftgate, inside delivery, etc.) */
|
|
158
|
+
deliveryInstructions?: string;
|
|
159
|
+
/** (Optional) Dimension unit (IN or CM, default: IN) */
|
|
160
|
+
dimensionUnit?: string;
|
|
161
|
+
/** (Optional) Origin city */
|
|
162
|
+
fromCity?: string;
|
|
163
|
+
/** (Optional) Origin country code (2-letter, default: US) */
|
|
164
|
+
fromCountry?: string;
|
|
165
|
+
/** (Required) Origin postal/ZIP code */
|
|
166
|
+
fromPostalCode: string;
|
|
167
|
+
/** (Optional) Origin state/province (2-letter code) */
|
|
168
|
+
fromState?: string;
|
|
169
|
+
/** (Optional) Hazardous materials flag (default: false) */
|
|
170
|
+
isHazMat?: boolean;
|
|
171
|
+
/** (Required) ShipVia location ID */
|
|
172
|
+
locationId: number;
|
|
173
|
+
/** (Optional) Freight height */
|
|
174
|
+
packageHeight?: number;
|
|
175
|
+
/** (Optional) Freight length */
|
|
176
|
+
packageLength?: number;
|
|
177
|
+
/** (Optional) Freight width */
|
|
178
|
+
packageWidth?: number;
|
|
179
|
+
/** (Required) Packaging type: PALLET, CRATE, CARTON, DRUM, BUNDLE, BAG, BOX, SKID */
|
|
180
|
+
packagingType: string;
|
|
181
|
+
/** (Optional) Special pickup instructions (liftgate required, loading dock, etc.) */
|
|
182
|
+
pickupInstructions?: string;
|
|
183
|
+
/** (Optional) Number of handling units (default: 1) */
|
|
184
|
+
quantity?: number;
|
|
185
|
+
/** (Optional) Destination city */
|
|
186
|
+
toCity?: string;
|
|
187
|
+
/** (Optional) Destination country code (2-letter, default: US) */
|
|
188
|
+
toCountry?: string;
|
|
189
|
+
/** (Required) Destination postal/ZIP code */
|
|
190
|
+
toPostalCode: string;
|
|
191
|
+
/** (Optional) Destination state/province (2-letter code) */
|
|
192
|
+
toState?: string;
|
|
193
|
+
/** (Required) Total freight weight (typically 150+ lbs) */
|
|
194
|
+
totalWeight: number;
|
|
195
|
+
/** (Required) Weight unit (LBS or KG) */
|
|
196
|
+
weightUnit: string;
|
|
197
|
+
}
|
|
198
|
+
/** Params for GET /speedship/freight */
|
|
199
|
+
export interface SpeedshipFreightListParams extends EdgeCacheParams {
|
|
200
|
+
/** (Optional, LTL only) NMFC freight class of the shipped items (Default: 55) */
|
|
201
|
+
commodityClass?: string;
|
|
202
|
+
/** (Optional, LTL only) Description of the shipped items (Default: General Merchandise) */
|
|
203
|
+
commodityDescription?: string;
|
|
204
|
+
/** (Optional) Special instructions for delivery(LTL only) */
|
|
205
|
+
deliveryInstructions?: string;
|
|
206
|
+
/** (Required) Dimension unit (IN) */
|
|
207
|
+
dimensionUnit: string;
|
|
208
|
+
/** (Required) From address line */
|
|
209
|
+
fromAddressLine: string;
|
|
210
|
+
/** (Required) From city */
|
|
211
|
+
fromCity: string;
|
|
212
|
+
/** (Required) From company name */
|
|
213
|
+
fromCompanyName: string;
|
|
214
|
+
/** (Required) From country code */
|
|
215
|
+
fromCountryCode: string;
|
|
216
|
+
/** (Required) From first name */
|
|
217
|
+
fromFirstName: string;
|
|
218
|
+
/** (Required) From last name */
|
|
219
|
+
fromLastName: string;
|
|
220
|
+
/** (Required) From phone */
|
|
221
|
+
fromPhone: string;
|
|
222
|
+
/** (Required) From postal code */
|
|
223
|
+
fromPostalCode: string;
|
|
224
|
+
/** (Required) From state */
|
|
225
|
+
fromState: string;
|
|
226
|
+
/** (Optional) Handling charge amount */
|
|
227
|
+
handlingCharge?: number;
|
|
228
|
+
/** (Optional) Handling charge unit (PERCENT|AMOUNT) */
|
|
229
|
+
handlingChargeUnit?: string;
|
|
230
|
+
/** (Optional) International flag */
|
|
231
|
+
international?: boolean;
|
|
232
|
+
/**
|
|
233
|
+
* (Optional, LTL only) Hazardous materials flag: any non-empty value other than 0 marks the
|
|
234
|
+
* shipment hazardous (Default: not hazardous)
|
|
235
|
+
*/
|
|
236
|
+
isHazMat?: string;
|
|
237
|
+
/**
|
|
238
|
+
* Max weight per pallet in pounds; splits the shipment into multiple handling units when set
|
|
239
|
+
* (omit for a single pallet)
|
|
240
|
+
*/
|
|
241
|
+
maxPalletWeight?: number;
|
|
242
|
+
/** (Optional) Package height (IN) */
|
|
243
|
+
packageHeight?: number;
|
|
244
|
+
/** (Required) Package length (IN) */
|
|
245
|
+
packageLength: number;
|
|
246
|
+
/** (Required) Package width (IN) */
|
|
247
|
+
packageWidth: number;
|
|
248
|
+
/** (Optional) Handling unit packaging type code (Default: PLT for LTL, 02 for SMALLPACK) */
|
|
249
|
+
packagingType?: string;
|
|
250
|
+
/** (Optional) Special instructions for pickup(LTL only) */
|
|
251
|
+
pickupInstructions?: string;
|
|
252
|
+
/** (Required) Product type (Default: LTL) | SMALLPACK */
|
|
253
|
+
productType: string;
|
|
254
|
+
/** (Required) Packaging handling unit (Default: 1) */
|
|
255
|
+
quantity: number;
|
|
256
|
+
/** (Required) Response format (summary | detailed | cheapest | vendor) */
|
|
257
|
+
responseFormat: string;
|
|
258
|
+
/** (Required) To address line */
|
|
259
|
+
toAddressLine: string;
|
|
260
|
+
/** (Required) To city */
|
|
261
|
+
toCity: string;
|
|
262
|
+
/** (Required) To company name */
|
|
263
|
+
toCompanyName: string;
|
|
264
|
+
/** (Required) To country code */
|
|
265
|
+
toCountryCode: string;
|
|
266
|
+
/** (Required) To first name */
|
|
267
|
+
toFirstName: string;
|
|
268
|
+
/** (Required) To last name */
|
|
269
|
+
toLastName: string;
|
|
270
|
+
/** (Required) To phone */
|
|
271
|
+
toPhone: string;
|
|
272
|
+
/** (Required) To postal code */
|
|
273
|
+
toPostalCode: string;
|
|
274
|
+
/** Destination state or province code, sent to Speedship as the destination region */
|
|
275
|
+
toState?: string;
|
|
276
|
+
/** (Required) Total weight of the shipment (LB) */
|
|
277
|
+
totalWeight: number;
|
|
278
|
+
/**
|
|
279
|
+
* Speedship vendor (carrier) id to return; used only with responseFormat=vendor and
|
|
280
|
+
* productType=LTL
|
|
281
|
+
*/
|
|
282
|
+
vendorId?: string;
|
|
283
|
+
/** (Required) Weight unit (LB) */
|
|
284
|
+
weightUnit: string;
|
|
285
|
+
}
|
|
286
|
+
/** Params for GET /ups/address-validation */
|
|
287
|
+
export interface UPSAddressValidationListParams extends EdgeCacheParams {
|
|
288
|
+
/** Ship-to address line 1 */
|
|
289
|
+
address1: string;
|
|
290
|
+
/** Ship-to address line 2 */
|
|
291
|
+
address2?: string;
|
|
292
|
+
/** Ship-to city */
|
|
293
|
+
city?: string;
|
|
294
|
+
/** Ship-to country code, US or PR (default: US); any other country returns Unknown */
|
|
295
|
+
countryCode?: string;
|
|
296
|
+
/** Ship-to ZIP or ZIP+4 */
|
|
297
|
+
postalCode: string;
|
|
298
|
+
/** Ship-to two-letter state code */
|
|
299
|
+
stateProvinceCode?: string;
|
|
300
|
+
}
|
|
301
|
+
/** Params for GET /ups/rates */
|
|
302
|
+
export interface UPSRatesListParams extends EdgeCacheParams {
|
|
303
|
+
/** From address line 1 */
|
|
304
|
+
fromAddress1: string;
|
|
305
|
+
/** Origin (ship-from) city name */
|
|
306
|
+
fromCity: string;
|
|
307
|
+
/** From country code (default: US) */
|
|
308
|
+
fromCountryCode?: string;
|
|
309
|
+
/** Origin (ship-from) postal or ZIP code */
|
|
310
|
+
fromPostalCode: string;
|
|
311
|
+
/** Origin (ship-from) two-letter state or province code */
|
|
312
|
+
fromStateProvinceCode: string;
|
|
313
|
+
/** Include transitDays, estimatedDeliveryDate and deliveryBy per service [Y|N] (Default: N) */
|
|
314
|
+
includeTransitTime?: string;
|
|
315
|
+
/**
|
|
316
|
+
* Max weight per package in pounds; splits the shipment into multiple packages when set (omit for
|
|
317
|
+
* a single package)
|
|
318
|
+
*/
|
|
319
|
+
maxPackageWeight?: number;
|
|
320
|
+
/** To address line 1 */
|
|
321
|
+
toAddress1: string;
|
|
322
|
+
/** Destination (ship-to) city name */
|
|
323
|
+
toCity: string;
|
|
324
|
+
/** To country code (default: US) */
|
|
325
|
+
toCountryCode?: string;
|
|
326
|
+
/** Destination (ship-to) postal or ZIP code */
|
|
327
|
+
toPostalCode: string;
|
|
328
|
+
/** Destination (ship-to) two-letter state or province code */
|
|
329
|
+
toStateProvinceCode: string;
|
|
330
|
+
/** Package weight in pounds */
|
|
331
|
+
weight: number;
|
|
332
|
+
}
|
|
333
|
+
/**
|
|
334
|
+
* Get FedEx Shipping Rates
|
|
335
|
+
* Response data for GET /fedex/rates — MINIMUM fields, extras pass through
|
|
336
|
+
*
|
|
337
|
+
* Returned by: api.logistics.fedex.rates.list(params) (array items)
|
|
338
|
+
* Returned by: api.logistics.ups.rates.list(params) (array items)
|
|
339
|
+
*/
|
|
340
|
+
export interface FedexRatesListItem {
|
|
341
|
+
/** Carrier service code (UPS `03`, FedEx `FEDEX_GROUND`); unique within one response */
|
|
342
|
+
serviceCode: string;
|
|
343
|
+
/** Carrier service display name */
|
|
344
|
+
serviceName: string;
|
|
345
|
+
/** Weight the carrier bills, in pounds */
|
|
346
|
+
billingWeight: number;
|
|
347
|
+
/** List base charge before service options */
|
|
348
|
+
transportationCharges: number;
|
|
349
|
+
/** List charges for service options (surcharges), never below zero */
|
|
350
|
+
serviceOptionsCharges: number;
|
|
351
|
+
/** List total charge for the service */
|
|
352
|
+
totalCharges: number;
|
|
353
|
+
/** Account (negotiated) total charge; 0 when the account has none */
|
|
354
|
+
negotiatedRates: number;
|
|
355
|
+
/**
|
|
356
|
+
* Business days in transit, 0 when the carrier gave no estimate; the key is absent unless
|
|
357
|
+
* includeTransitTime=Y
|
|
358
|
+
*/
|
|
359
|
+
transitDays?: number | null;
|
|
360
|
+
/**
|
|
361
|
+
* Estimated delivery date (Y-m-d), empty when the carrier gave no estimate; the key is absent
|
|
362
|
+
* unless includeTransitTime=Y
|
|
363
|
+
*/
|
|
364
|
+
estimatedDeliveryDate?: string | null;
|
|
365
|
+
/**
|
|
366
|
+
* Estimated delivery time of day (H:i:s), empty when the carrier gave no estimate; the key is
|
|
367
|
+
* absent unless includeTransitTime=Y
|
|
368
|
+
*/
|
|
369
|
+
deliveryBy?: string | null;
|
|
370
|
+
[key: string]: unknown;
|
|
371
|
+
}
|
|
372
|
+
/** Returned by: api.logistics.fedex.rates.list(params) */
|
|
373
|
+
export type FedexRatesListData = FedexRatesListItem[];
|
|
374
|
+
/**
|
|
375
|
+
* List shipping methods
|
|
376
|
+
* Response data for GET /shipping-methods — MINIMUM fields, extras pass through
|
|
377
|
+
*
|
|
378
|
+
* Returned by: api.logistics.shippingMethods.list(params) (array items)
|
|
379
|
+
* Returned by: api.logistics.shippingMethods.get(shippingMethodsUid, params)
|
|
380
|
+
* Returned by: api.logistics.shippingMethods.update(shippingMethodsUid, data)
|
|
381
|
+
* Returned by: api.logistics.shippingMethods.delete(shippingMethodsUid)
|
|
382
|
+
*/
|
|
383
|
+
export interface ShippingMethodsListItem {
|
|
384
|
+
/** Shipping method ID */
|
|
385
|
+
shippingMethodsUid: number;
|
|
386
|
+
/**
|
|
387
|
+
* Prophet 21 carrier address id (address.id with carrier_flag Y); written only by
|
|
388
|
+
* shipping_methods:sync_few
|
|
389
|
+
*/
|
|
390
|
+
shippingMethodsId: number;
|
|
391
|
+
/** Operator web display name for the carrier (max 255 chars) */
|
|
392
|
+
nickname: string | null;
|
|
393
|
+
/** Operator shipping type label (max 255 chars) */
|
|
394
|
+
shippingType: string | null;
|
|
395
|
+
/** Flat handling fee added to the rate */
|
|
396
|
+
handlingFee: number | null;
|
|
397
|
+
/** Handling charge as a percent of the rate */
|
|
398
|
+
handlingPercent: number | null;
|
|
399
|
+
/** Tier 1 price */
|
|
400
|
+
price1: number | null;
|
|
401
|
+
/** Tier 2 price */
|
|
402
|
+
price2: number | null;
|
|
403
|
+
/** Tier 3 price */
|
|
404
|
+
price3: number | null;
|
|
405
|
+
/** Tier 4 price */
|
|
406
|
+
price4: number | null;
|
|
407
|
+
/** Tier 5 price */
|
|
408
|
+
price5: number | null;
|
|
409
|
+
/** Tier 1 cost */
|
|
410
|
+
cost1: number | null;
|
|
411
|
+
/** Tier 2 cost */
|
|
412
|
+
cost2: number | null;
|
|
413
|
+
/** Tier 3 cost */
|
|
414
|
+
cost3: number | null;
|
|
415
|
+
/** Tier 4 cost */
|
|
416
|
+
cost4: number | null;
|
|
417
|
+
/** Tier 5 cost */
|
|
418
|
+
cost5: number | null;
|
|
419
|
+
/** Tier 1 weight break */
|
|
420
|
+
weight1: number | null;
|
|
421
|
+
/** Tier 2 weight break */
|
|
422
|
+
weight2: number | null;
|
|
423
|
+
/** Tier 3 weight break */
|
|
424
|
+
weight3: number | null;
|
|
425
|
+
/** Tier 4 weight break */
|
|
426
|
+
weight4: number | null;
|
|
427
|
+
/** Tier 5 weight break */
|
|
428
|
+
weight5: number | null;
|
|
429
|
+
/** Date the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
430
|
+
dateCreated: string;
|
|
431
|
+
/** Date the record was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
432
|
+
dateLastModified: string;
|
|
433
|
+
/** Update code */
|
|
434
|
+
updateCd: number;
|
|
435
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
436
|
+
statusCd: number;
|
|
437
|
+
/** Process code */
|
|
438
|
+
processCd: number;
|
|
439
|
+
/**
|
|
440
|
+
* Default flag (704 = the site default shipping method, 705 = not default); at most one row per
|
|
441
|
+
* site is 704
|
|
442
|
+
*/
|
|
443
|
+
defaultCd: number;
|
|
444
|
+
/** Display order */
|
|
445
|
+
sequenceNo: number;
|
|
446
|
+
/**
|
|
447
|
+
* How the storefront prices the carrier at checkout (ups, fedex, ltl, free); null means no rate
|
|
448
|
+
* (max 16 chars)
|
|
449
|
+
*/
|
|
450
|
+
rateSource: string | null;
|
|
451
|
+
/** Carrier service code (UPS 03, FedEx FEDEX_GROUND); null for ltl and free (max 64 chars) */
|
|
452
|
+
serviceCode: string | null;
|
|
453
|
+
/**
|
|
454
|
+
* Prophet 21 carrier name (address.name); written only by shipping_methods:sync_few (max 50
|
|
455
|
+
* chars)
|
|
456
|
+
*/
|
|
457
|
+
carrierName: string | null;
|
|
458
|
+
[key: string]: unknown;
|
|
459
|
+
}
|
|
460
|
+
/** Returned by: api.logistics.shippingMethods.list(params) */
|
|
461
|
+
export type ShippingMethodsListData = ShippingMethodsListItem[];
|
|
462
|
+
/**
|
|
463
|
+
* Get one shipping method
|
|
464
|
+
* Response data for GET /shipping-methods/{shippingMethodsUid} — MINIMUM fields, extras pass
|
|
465
|
+
* through
|
|
466
|
+
*
|
|
467
|
+
* Returned by: api.logistics.shippingMethods.get(shippingMethodsUid, params)
|
|
468
|
+
*/
|
|
469
|
+
export type ShippingMethodsGetData = ShippingMethodsListItem;
|
|
470
|
+
/**
|
|
471
|
+
* Update a shipping method
|
|
472
|
+
* Response data for PUT /shipping-methods/{shippingMethodsUid} — MINIMUM fields, extras pass
|
|
473
|
+
* through
|
|
474
|
+
*
|
|
475
|
+
* Returned by: api.logistics.shippingMethods.update(shippingMethodsUid, data)
|
|
476
|
+
*/
|
|
477
|
+
export type ShippingMethodsUpdateData = ShippingMethodsListItem;
|
|
478
|
+
/**
|
|
479
|
+
* Update a shipping method
|
|
480
|
+
* Request body for PUT /shipping-methods/{shippingMethodsUid} — MINIMUM fields, extras pass through
|
|
481
|
+
*
|
|
482
|
+
* Request body of: api.logistics.shippingMethods.update(shippingMethodsUid, data)
|
|
483
|
+
*/
|
|
484
|
+
export interface ShippingMethodsUpdateBody {
|
|
485
|
+
/** Web display name for the carrier; "" or null clears it (max 255 chars) */
|
|
486
|
+
nickname?: string | null;
|
|
487
|
+
/** Shipping type label; "" or null clears it (max 255 chars) */
|
|
488
|
+
shippingType?: string | null;
|
|
489
|
+
/** Flat handling fee added to the rate; "" or null clears it */
|
|
490
|
+
handlingFee?: number | null;
|
|
491
|
+
/** Handling charge as a percent of the rate; "" or null clears it */
|
|
492
|
+
handlingPercent?: number | null;
|
|
493
|
+
/** Tier 1 price; "" or null clears it */
|
|
494
|
+
price1?: number | null;
|
|
495
|
+
/** Tier 2 price; "" or null clears it */
|
|
496
|
+
price2?: number | null;
|
|
497
|
+
/** Tier 3 price; "" or null clears it */
|
|
498
|
+
price3?: number | null;
|
|
499
|
+
/** Tier 4 price; "" or null clears it */
|
|
500
|
+
price4?: number | null;
|
|
501
|
+
/** Tier 5 price; "" or null clears it */
|
|
502
|
+
price5?: number | null;
|
|
503
|
+
/** Tier 1 cost; "" or null clears it */
|
|
504
|
+
cost1?: number | null;
|
|
505
|
+
/** Tier 2 cost; "" or null clears it */
|
|
506
|
+
cost2?: number | null;
|
|
507
|
+
/** Tier 3 cost; "" or null clears it */
|
|
508
|
+
cost3?: number | null;
|
|
509
|
+
/** Tier 4 cost; "" or null clears it */
|
|
510
|
+
cost4?: number | null;
|
|
511
|
+
/** Tier 5 cost; "" or null clears it */
|
|
512
|
+
cost5?: number | null;
|
|
513
|
+
/** Tier 1 weight break; "" or null clears it */
|
|
514
|
+
weight1?: number | null;
|
|
515
|
+
/** Tier 2 weight break; "" or null clears it */
|
|
516
|
+
weight2?: number | null;
|
|
517
|
+
/** Tier 3 weight break; "" or null clears it */
|
|
518
|
+
weight3?: number | null;
|
|
519
|
+
/** Tier 4 weight break; "" or null clears it */
|
|
520
|
+
weight4?: number | null;
|
|
521
|
+
/** Tier 5 weight break; "" or null clears it */
|
|
522
|
+
weight5?: number | null;
|
|
523
|
+
/** Status code [(704) active | (705) inactive | (700) deleted]; anything else is a 400 */
|
|
524
|
+
statusCd?: number | null;
|
|
525
|
+
/** Process code */
|
|
526
|
+
processCd?: number | null;
|
|
527
|
+
/**
|
|
528
|
+
* Default flag [(704) default | (705) not default]; 704 clears it on every other shipping method;
|
|
529
|
+
* anything other than 700, 704 or 705 is a 400
|
|
530
|
+
*/
|
|
531
|
+
defaultCd?: number | null;
|
|
532
|
+
/** Display order */
|
|
533
|
+
sequenceNo?: number | null;
|
|
534
|
+
/**
|
|
535
|
+
* How the storefront prices the carrier at checkout (ups, fedex, ltl, free); "" or null clears it
|
|
536
|
+
* (max 16 chars)
|
|
537
|
+
*/
|
|
538
|
+
rateSource?: string | null;
|
|
539
|
+
/**
|
|
540
|
+
* Carrier service code (UPS 03, FedEx FEDEX_GROUND), sent as a string to keep leading zeros; ""
|
|
541
|
+
* or null clears it (max 64 chars)
|
|
542
|
+
*/
|
|
543
|
+
serviceCode?: string | null;
|
|
544
|
+
[key: string]: unknown;
|
|
545
|
+
}
|
|
546
|
+
/**
|
|
547
|
+
* Soft delete a shipping method
|
|
548
|
+
* Response data for DELETE /shipping-methods/{shippingMethodsUid} — MINIMUM fields, extras pass
|
|
549
|
+
* through
|
|
550
|
+
*
|
|
551
|
+
* Returned by: api.logistics.shippingMethods.delete(shippingMethodsUid)
|
|
552
|
+
*/
|
|
553
|
+
export type ShippingMethodsDeleteData = ShippingMethodsListItem;
|
|
554
|
+
/**
|
|
555
|
+
* Get ShipVia multi-carrier shipping rates
|
|
556
|
+
* Response data for GET /shipvia/rates — MINIMUM fields, extras pass through
|
|
557
|
+
*
|
|
558
|
+
* Returned by: api.logistics.shipvia.rates.list(params) (array items)
|
|
559
|
+
* Returned by: api.logistics.shipvia.rates.ltl.list(params) (array items)
|
|
560
|
+
*/
|
|
561
|
+
export interface ShipviaRatesListItem {
|
|
562
|
+
/**
|
|
563
|
+
* Carrier code as ShipVia reports it (UPS, FEDEX, FEDEX_FREIGHT); empty when ShipVia sent none
|
|
564
|
+
*/
|
|
565
|
+
carrier: string;
|
|
566
|
+
/** Carrier service name; empty when ShipVia sent none */
|
|
567
|
+
service: string;
|
|
568
|
+
/** Service level (ground, express, overnight); empty when ShipVia sent none */
|
|
569
|
+
serviceLevel: string;
|
|
570
|
+
/** Total quoted cost, 0 when ShipVia sent no numeric value */
|
|
571
|
+
totalCost: number;
|
|
572
|
+
/** Days in transit, 0 when ShipVia sent no numeric value */
|
|
573
|
+
transitDays: number;
|
|
574
|
+
/** Estimated delivery date as ShipVia formats it; empty when ShipVia sent none */
|
|
575
|
+
estimatedDeliveryDate: string;
|
|
576
|
+
/** Currency of totalCost (Default: USD) */
|
|
577
|
+
currency: string;
|
|
578
|
+
[key: string]: unknown;
|
|
579
|
+
}
|
|
580
|
+
/** Returned by: api.logistics.shipvia.rates.list(params) */
|
|
581
|
+
export type ShipviaRatesListData = ShipviaRatesListItem[];
|
|
582
|
+
/**
|
|
583
|
+
* Get ShipVia LTL freight rates
|
|
584
|
+
* Response data for GET /shipvia/rates/ltl — MINIMUM fields, extras pass through
|
|
585
|
+
*
|
|
586
|
+
* Returned by: api.logistics.shipvia.rates.ltl.list(params) (array items)
|
|
587
|
+
*/
|
|
588
|
+
export type ShipviaRatesLtlListItem = ShipviaRatesListItem;
|
|
589
|
+
/** Returned by: api.logistics.shipvia.rates.ltl.list(params) */
|
|
590
|
+
export type ShipviaRatesLtlListData = ShipviaRatesLtlListItem[];
|
|
591
|
+
/**
|
|
592
|
+
* Validate and Classify UPS Address
|
|
593
|
+
* Response data for GET /ups/address-validation — MINIMUM fields, extras pass through
|
|
594
|
+
*
|
|
595
|
+
* Returned by: api.logistics.ups.addressValidation.list(params)
|
|
596
|
+
*/
|
|
597
|
+
export interface UPSAddressValidationListData {
|
|
598
|
+
/**
|
|
599
|
+
* Ship-to address classification: Residential, Commercial, or Unknown (no match, unclassified,
|
|
600
|
+
* non-US/PR, or UPS unavailable)
|
|
601
|
+
*/
|
|
602
|
+
classification: string;
|
|
603
|
+
/** UPS-corrected address line 1; empty when Unknown */
|
|
604
|
+
address1: string;
|
|
605
|
+
/** UPS-corrected address line 2; empty when UPS returned one line or Unknown */
|
|
606
|
+
address2: string;
|
|
607
|
+
/** UPS-corrected city; empty when Unknown */
|
|
608
|
+
city: string;
|
|
609
|
+
/** UPS-corrected two-letter state code; empty when Unknown */
|
|
610
|
+
stateProvinceCode: string;
|
|
611
|
+
/** UPS-corrected ZIP code, ZIP+4 when UPS returned it; empty when Unknown */
|
|
612
|
+
postalCode: string;
|
|
613
|
+
/** Country code of the UPS candidate (US or PR); empty when Unknown */
|
|
614
|
+
countryCode: string;
|
|
615
|
+
[key: string]: unknown;
|
|
616
|
+
}
|
|
617
|
+
/**
|
|
618
|
+
* Get UPS Shipping Rates
|
|
619
|
+
* Response data for GET /ups/rates — MINIMUM fields, extras pass through
|
|
620
|
+
*
|
|
621
|
+
* Returned by: api.logistics.ups.rates.list(params) (array items)
|
|
622
|
+
*/
|
|
623
|
+
export type UPSRatesListItem = FedexRatesListItem;
|
|
624
|
+
/** Returned by: api.logistics.ups.rates.list(params) */
|
|
625
|
+
export type UPSRatesListData = UPSRatesListItem[];
|
|
626
|
+
/** @deprecated Renamed to UPSAddressValidationListData; removed in the next release. */
|
|
627
|
+
export type UpsAddressValidationListData = UPSAddressValidationListData;
|
|
628
|
+
export interface LogisticsClientSpec {
|
|
629
|
+
fedex: {
|
|
630
|
+
rates: {
|
|
631
|
+
/**
|
|
632
|
+
* Get FedEx Shipping Rates
|
|
633
|
+
* Call: api.logistics.fedex.rates.list(params)
|
|
634
|
+
*
|
|
635
|
+
* Response data, each item: One carrier service rate quoted by the FedEx or UPS rate API
|
|
636
|
+
*
|
|
637
|
+
* GET https://logistics.augur-api.com/fedex/rates
|
|
638
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1fedex~1rates/get
|
|
639
|
+
*
|
|
640
|
+
* @param params FedexRatesListParams (query string)
|
|
641
|
+
* @returns BaseResponse whose `data` is FedexRatesListData
|
|
642
|
+
*/
|
|
643
|
+
list: (params?: FedexRatesListParams) => Promise<BaseResponse<FedexRatesListData>>;
|
|
644
|
+
};
|
|
645
|
+
};
|
|
646
|
+
rts: {
|
|
647
|
+
brands: {
|
|
648
|
+
/**
|
|
649
|
+
* List RTS Brands
|
|
650
|
+
* Call: api.logistics.rts.brands.list(params)
|
|
651
|
+
*
|
|
652
|
+
* List RTS machine brands (proxies RTS Partner Track Finder API)
|
|
653
|
+
*
|
|
654
|
+
* GET https://logistics.augur-api.com/rts/brands
|
|
655
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1rts~1brands/get
|
|
656
|
+
*
|
|
657
|
+
* @param params RtsBrandsListParams (query string)
|
|
658
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
659
|
+
*/
|
|
660
|
+
list: (params?: RtsBrandsListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
661
|
+
machines: {
|
|
662
|
+
/**
|
|
663
|
+
* List RTS Machines for Brand
|
|
664
|
+
* Call: api.logistics.rts.brands.machines.list(brandId, params)
|
|
665
|
+
*
|
|
666
|
+
* List RTS machines for a specific brand (proxies RTS Partner Track Finder API)
|
|
667
|
+
*
|
|
668
|
+
* GET https://logistics.augur-api.com/rts/brands/{brandId}/machines
|
|
669
|
+
* Contract:
|
|
670
|
+
* https://logistics.augur-api.com/openapi.json#/paths/~1rts~1brands~1{brandId}~1machines/get
|
|
671
|
+
*
|
|
672
|
+
* @param brandId RTS brand ID
|
|
673
|
+
* @param params RtsBrandsMachinesListParams (query string)
|
|
674
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
675
|
+
*/
|
|
676
|
+
list: (brandId: number, params?: RtsBrandsMachinesListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
677
|
+
};
|
|
678
|
+
};
|
|
679
|
+
machines: {
|
|
680
|
+
tracks: {
|
|
681
|
+
/**
|
|
682
|
+
* List RTS Tracks for Machine
|
|
683
|
+
* Call: api.logistics.rts.machines.tracks.list(machineId)
|
|
684
|
+
*
|
|
685
|
+
* List RTS tracks compatible with a specific machine (proxies RTS Partner Track Finder API)
|
|
686
|
+
*
|
|
687
|
+
* GET https://logistics.augur-api.com/rts/machines/{machineId}/tracks
|
|
688
|
+
* Contract:
|
|
689
|
+
* https://logistics.augur-api.com/openapi.json#/paths/~1rts~1machines~1{machineId}~1tracks/get
|
|
690
|
+
*
|
|
691
|
+
* @param machineId RTS machine ID
|
|
692
|
+
* @param params RtsMachinesTracksListParams (query string)
|
|
693
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
694
|
+
*/
|
|
695
|
+
list: (machineId: number, params?: RtsMachinesTracksListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
696
|
+
};
|
|
697
|
+
};
|
|
698
|
+
search: {
|
|
699
|
+
machines: {
|
|
700
|
+
/**
|
|
701
|
+
* Search RTS Machines
|
|
702
|
+
* Call: api.logistics.rts.search.machines.list(params)
|
|
703
|
+
*
|
|
704
|
+
* Search RTS machines across all brands (proxies RTS Partner Track Finder API; max 50
|
|
705
|
+
* results)
|
|
706
|
+
*
|
|
707
|
+
* Errors:
|
|
708
|
+
* 400: Query parameter "q" is required.
|
|
709
|
+
*
|
|
710
|
+
* GET https://logistics.augur-api.com/rts/search/machines
|
|
711
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1rts~1search~1machines/get
|
|
712
|
+
*
|
|
713
|
+
* @param params RtsSearchMachinesListParams (query string)
|
|
714
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
715
|
+
*/
|
|
716
|
+
list: (params?: RtsSearchMachinesListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
717
|
+
};
|
|
718
|
+
};
|
|
719
|
+
track: {
|
|
720
|
+
/**
|
|
721
|
+
* Get RTS Track
|
|
722
|
+
* Call: api.logistics.rts.track.get(trackId)
|
|
723
|
+
*
|
|
724
|
+
* Get a single RTS track by ID (proxies RTS Partner Track Finder API; returns 404 if track
|
|
725
|
+
* not found)
|
|
726
|
+
*
|
|
727
|
+
* Errors:
|
|
728
|
+
* 404: Track not found.
|
|
729
|
+
*
|
|
730
|
+
* GET https://logistics.augur-api.com/rts/track/{trackId}
|
|
731
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1rts~1track~1{trackId}/get
|
|
732
|
+
*
|
|
733
|
+
* @param trackId RTS track ID
|
|
734
|
+
* @param params RtsTrackGetParams (query string)
|
|
735
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
736
|
+
*/
|
|
737
|
+
get: (trackId: number, params?: RtsTrackGetParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
738
|
+
};
|
|
739
|
+
tracks: {
|
|
740
|
+
/**
|
|
741
|
+
* Browse RTS Tracks
|
|
742
|
+
* Call: api.logistics.rts.tracks.list(params)
|
|
743
|
+
*
|
|
744
|
+
* Browse RTS tracks with optional class and search filters (proxies RTS Partner Track Finder
|
|
745
|
+
* API; max 100 results)
|
|
746
|
+
*
|
|
747
|
+
* GET https://logistics.augur-api.com/rts/tracks
|
|
748
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1rts~1tracks/get
|
|
749
|
+
*
|
|
750
|
+
* @param params RtsTracksListParams (query string)
|
|
751
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
752
|
+
*/
|
|
753
|
+
list: (params?: RtsTracksListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
754
|
+
};
|
|
755
|
+
};
|
|
756
|
+
shippingMethods: {
|
|
757
|
+
/**
|
|
758
|
+
* List shipping methods
|
|
759
|
+
* Call: api.logistics.shippingMethods.list(params)
|
|
760
|
+
*
|
|
761
|
+
* List shipping methods for a site
|
|
762
|
+
*
|
|
763
|
+
* Errors:
|
|
764
|
+
* 400: Invalid orderBy: MUST be one field|ASC or field|DESC, the field a shipping_methods
|
|
765
|
+
* column.
|
|
766
|
+
*
|
|
767
|
+
* GET https://logistics.augur-api.com/shipping-methods
|
|
768
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1shipping-methods/get
|
|
769
|
+
*
|
|
770
|
+
* @param params ShippingMethodsListParams (query string)
|
|
771
|
+
* @returns BaseResponse whose `data` is ShippingMethodsListData
|
|
772
|
+
*/
|
|
773
|
+
list: (params?: ShippingMethodsListParams) => Promise<BaseResponse<ShippingMethodsListData>>;
|
|
774
|
+
/**
|
|
775
|
+
* Get one shipping method
|
|
776
|
+
* Call: api.logistics.shippingMethods.get(shippingMethodsUid, params)
|
|
777
|
+
*
|
|
778
|
+
* Get one shipping method; pass 0 as the uid with shippingMethodsId to look up by carrier
|
|
779
|
+
* address id
|
|
780
|
+
*
|
|
781
|
+
* Errors:
|
|
782
|
+
* 404: Shipping method not found.
|
|
783
|
+
*
|
|
784
|
+
* GET https://logistics.augur-api.com/shipping-methods/{shippingMethodsUid}
|
|
785
|
+
* Contract:
|
|
786
|
+
* https://logistics.augur-api.com/openapi.json#/paths/~1shipping-methods~1{shippingMethodsUid}/get
|
|
787
|
+
*
|
|
788
|
+
* @param shippingMethodsUid shipping_methods.shipping_methods_uid
|
|
789
|
+
* @param params ShippingMethodsGetParams (query string)
|
|
790
|
+
* @returns BaseResponse whose `data` is ShippingMethodsGetData
|
|
791
|
+
*/
|
|
792
|
+
get: (shippingMethodsUid: number, params?: ShippingMethodsGetParams) => Promise<BaseResponse<ShippingMethodsGetData>>;
|
|
793
|
+
/**
|
|
794
|
+
* Update a shipping method
|
|
795
|
+
* Call: api.logistics.shippingMethods.update(shippingMethodsUid, data)
|
|
796
|
+
*
|
|
797
|
+
* Update the operator-editable fields of one shipping method
|
|
798
|
+
*
|
|
799
|
+
* Request body: Partial update of a shipping method's operator-editable fields; an absent field
|
|
800
|
+
* keeps its stored value
|
|
801
|
+
*
|
|
802
|
+
* Errors:
|
|
803
|
+
* 400: statusCd must be 700, 704 or 705. Or defaultCd must be 700, 704 or 705. Or Request
|
|
804
|
+
* body must be a JSON object.
|
|
805
|
+
* 404: No record with this ID. Or Shipping method not found.
|
|
806
|
+
*
|
|
807
|
+
* PUT https://logistics.augur-api.com/shipping-methods/{shippingMethodsUid}
|
|
808
|
+
* Contract:
|
|
809
|
+
* https://logistics.augur-api.com/openapi.json#/paths/~1shipping-methods~1{shippingMethodsUid}/put
|
|
810
|
+
*
|
|
811
|
+
* @param shippingMethodsUid shipping_methods.shipping_methods_uid
|
|
812
|
+
* @param data ShippingMethodsUpdateBody (request body)
|
|
813
|
+
* @returns BaseResponse whose `data` is ShippingMethodsUpdateData
|
|
814
|
+
*/
|
|
815
|
+
update: (shippingMethodsUid: number, data: ShippingMethodsUpdateBody) => Promise<BaseResponse<ShippingMethodsUpdateData>>;
|
|
816
|
+
/**
|
|
817
|
+
* Soft delete a shipping method
|
|
818
|
+
* Call: api.logistics.shippingMethods.delete(shippingMethodsUid)
|
|
819
|
+
*
|
|
820
|
+
* Soft delete a shipping method (status_cd 700)
|
|
821
|
+
*
|
|
822
|
+
* Errors:
|
|
823
|
+
* 404: No record with this ID. Or Shipping method not found.
|
|
824
|
+
*
|
|
825
|
+
* DELETE https://logistics.augur-api.com/shipping-methods/{shippingMethodsUid}
|
|
826
|
+
* Contract:
|
|
827
|
+
* https://logistics.augur-api.com/openapi.json#/paths/~1shipping-methods~1{shippingMethodsUid}/delete
|
|
828
|
+
*
|
|
829
|
+
* @param shippingMethodsUid shipping_methods.shipping_methods_uid
|
|
830
|
+
* @returns BaseResponse whose `data` is ShippingMethodsDeleteData
|
|
831
|
+
*/
|
|
832
|
+
delete: (shippingMethodsUid: number) => Promise<BaseResponse<ShippingMethodsDeleteData>>;
|
|
833
|
+
};
|
|
834
|
+
shipvia: {
|
|
835
|
+
rates: {
|
|
836
|
+
/**
|
|
837
|
+
* Get ShipVia multi-carrier shipping rates
|
|
838
|
+
* Call: api.logistics.shipvia.rates.list(params)
|
|
839
|
+
*
|
|
840
|
+
* Get ShipVia shipping rates from multiple carriers
|
|
841
|
+
*
|
|
842
|
+
* Response data, each item: One carrier rate quoted by the ShipVia rate inquiry
|
|
843
|
+
*
|
|
844
|
+
* GET https://logistics.augur-api.com/shipvia/rates
|
|
845
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1shipvia~1rates/get
|
|
846
|
+
*
|
|
847
|
+
* @param params ShipviaRatesListParams (query string)
|
|
848
|
+
* @returns BaseResponse whose `data` is ShipviaRatesListData
|
|
849
|
+
*/
|
|
850
|
+
list: (params?: ShipviaRatesListParams) => Promise<BaseResponse<ShipviaRatesListData>>;
|
|
851
|
+
ltl: {
|
|
852
|
+
/**
|
|
853
|
+
* Get ShipVia LTL freight rates
|
|
854
|
+
* Call: api.logistics.shipvia.rates.ltl.list(params)
|
|
855
|
+
*
|
|
856
|
+
* Get ShipVia LTL (Less-Than-Truckload) freight rates from multiple carriers
|
|
857
|
+
*
|
|
858
|
+
* Response data, each item: One carrier rate quoted by the ShipVia rate inquiry
|
|
859
|
+
*
|
|
860
|
+
* GET https://logistics.augur-api.com/shipvia/rates/ltl
|
|
861
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1shipvia~1rates~1ltl/get
|
|
862
|
+
*
|
|
863
|
+
* @param params ShipviaRatesLtlListParams (query string)
|
|
864
|
+
* @returns BaseResponse whose `data` is ShipviaRatesLtlListData
|
|
865
|
+
*/
|
|
866
|
+
list: (params?: ShipviaRatesLtlListParams) => Promise<BaseResponse<ShipviaRatesLtlListData>>;
|
|
867
|
+
};
|
|
868
|
+
};
|
|
869
|
+
};
|
|
870
|
+
speedship: {
|
|
871
|
+
freight: {
|
|
872
|
+
/**
|
|
873
|
+
* Get Speedship Freight
|
|
874
|
+
* Call: api.logistics.speedship.freight.list(params)
|
|
875
|
+
*
|
|
876
|
+
* GET https://logistics.augur-api.com/speedship/freight
|
|
877
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1speedship~1freight/get
|
|
878
|
+
*
|
|
879
|
+
* @param params SpeedshipFreightListParams (query string)
|
|
880
|
+
* @returns BaseResponse whose `data` is untyped upstream (any JSON value; check before use)
|
|
881
|
+
*/
|
|
882
|
+
list: (params?: SpeedshipFreightListParams) => Promise<BaseResponse<Record<string, unknown>>>;
|
|
883
|
+
};
|
|
884
|
+
};
|
|
885
|
+
ups: {
|
|
886
|
+
addressValidation: {
|
|
887
|
+
/**
|
|
888
|
+
* Validate and Classify UPS Address
|
|
889
|
+
* Call: api.logistics.ups.addressValidation.list(params)
|
|
890
|
+
*
|
|
891
|
+
* Classify a ship-to address as Residential, Commercial, or Unknown with UPS Address
|
|
892
|
+
* Validation (US and PR only)
|
|
893
|
+
*
|
|
894
|
+
* Response data: UPS Address Validation result: the ship-to classification and the top UPS
|
|
895
|
+
* candidate
|
|
896
|
+
*
|
|
897
|
+
* Errors:
|
|
898
|
+
* 400: address1 or postalCode is missing.
|
|
899
|
+
*
|
|
900
|
+
* GET https://logistics.augur-api.com/ups/address-validation
|
|
901
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1ups~1address-validation/get
|
|
902
|
+
*
|
|
903
|
+
* @param params UPSAddressValidationListParams (query string)
|
|
904
|
+
* @returns BaseResponse whose `data` is UPSAddressValidationListData
|
|
905
|
+
*/
|
|
906
|
+
list: (params?: UPSAddressValidationListParams) => Promise<BaseResponse<UPSAddressValidationListData>>;
|
|
907
|
+
};
|
|
908
|
+
rates: {
|
|
909
|
+
/**
|
|
910
|
+
* Get UPS Shipping Rates
|
|
911
|
+
* Call: api.logistics.ups.rates.list(params)
|
|
912
|
+
*
|
|
913
|
+
* Response data, each item: One carrier service rate quoted by the FedEx or UPS rate API
|
|
914
|
+
*
|
|
915
|
+
* GET https://logistics.augur-api.com/ups/rates
|
|
916
|
+
* Contract: https://logistics.augur-api.com/openapi.json#/paths/~1ups~1rates/get
|
|
917
|
+
*
|
|
918
|
+
* @param params UPSRatesListParams (query string)
|
|
919
|
+
* @returns BaseResponse whose `data` is UPSRatesListData
|
|
920
|
+
*/
|
|
921
|
+
list: (params?: UPSRatesListParams) => Promise<BaseResponse<UPSRatesListData>>;
|
|
922
|
+
};
|
|
923
|
+
};
|
|
924
|
+
}
|
|
925
|
+
//# sourceMappingURL=types.d.ts.map
|