@simpleapps-com/augur-api 2026.10.31 → 2026.11.2
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 +85 -34
- package/SKILL.md +25 -24
- package/dist/client.d.ts +336 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +159 -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 +26 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +71 -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 +19565 -18212
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19564 -18212
- 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 +299 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1111 -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 +550 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1502 -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 +30 -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,1134 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the commerce service.
|
|
3
|
+
* Shopping cart and checkout engine managing cart state, checkout flow, and Prophet 21 order
|
|
4
|
+
* submission
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://commerce.augur-api.com/endpoints.jsonl: one JSON line per endpoint: method, path, path
|
|
8
|
+
* params and query params, each with type and required flag. Grep it for a path; for a GET
|
|
9
|
+
* that line is all you need. Bodies are not in it.
|
|
10
|
+
* https://commerce.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://commerce.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/commerce.json
|
|
16
|
+
*
|
|
17
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
18
|
+
*/
|
|
19
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
20
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
21
|
+
/** Params for GET /cart-hdr/list */
|
|
22
|
+
export interface CartHdrListListParams extends EdgeCacheParams {
|
|
23
|
+
/** Limit number of results (Default: 10) */
|
|
24
|
+
limit?: number;
|
|
25
|
+
/** Starting offset results (Default: 0) */
|
|
26
|
+
offset?: number;
|
|
27
|
+
/**
|
|
28
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
29
|
+
* (704,705); -1 for every status. Default: every status
|
|
30
|
+
*/
|
|
31
|
+
statusCd?: number | number[];
|
|
32
|
+
/** Storefront user whose carts to list */
|
|
33
|
+
userId: number;
|
|
34
|
+
}
|
|
35
|
+
/** Params for GET /cart-hdr/lookup */
|
|
36
|
+
export interface CartHdrLookupGetParams extends EdgeCacheParams {
|
|
37
|
+
/** Token that identifies an anonymous cart; ignored when userId is above 0 */
|
|
38
|
+
cartToken?: string;
|
|
39
|
+
/** Prophet 21 contact the cart belongs to */
|
|
40
|
+
contactId: number;
|
|
41
|
+
/** Prophet 21 customer the cart belongs to */
|
|
42
|
+
customerId: number;
|
|
43
|
+
/**
|
|
44
|
+
* The user's cart number; 0 or absent picks cart 1 for a logged-in user; ignored for an anonymous
|
|
45
|
+
* cart (userId 0), which gets an allocated number
|
|
46
|
+
*/
|
|
47
|
+
userCartNo?: number;
|
|
48
|
+
/** Storefront user the cart belongs to; 0 for an anonymous cart keyed on cartToken */
|
|
49
|
+
userId: number;
|
|
50
|
+
}
|
|
51
|
+
/** Params for GET /cart-hdr/{cartHdrUid}/also-bought */
|
|
52
|
+
export interface CartHdrAlsoBoughtListParams extends EdgeCacheParams {
|
|
53
|
+
/** limit (default 10) */
|
|
54
|
+
limit?: number;
|
|
55
|
+
/** offset (default 0) */
|
|
56
|
+
offset?: number;
|
|
57
|
+
}
|
|
58
|
+
/** Params for GET /cart-line/{cartHdrUid} */
|
|
59
|
+
export type CartLineGetParams = EdgeCacheParams;
|
|
60
|
+
/** Params for GET /checkout/{checkoutUid} */
|
|
61
|
+
export type CheckoutGetParams = EdgeCacheParams;
|
|
62
|
+
/** Params for GET /checkout/{checkoutUid}/doc */
|
|
63
|
+
export type CheckoutDocListParams = EdgeCacheParams;
|
|
64
|
+
/**
|
|
65
|
+
* List Cart Hdr by user_id
|
|
66
|
+
* Response data for GET /cart-hdr/list — MINIMUM fields, extras pass through
|
|
67
|
+
*
|
|
68
|
+
* Returned by: api.commerce.cartHdr.list.list(params) (array items)
|
|
69
|
+
*/
|
|
70
|
+
export interface CartHdrListListItem {
|
|
71
|
+
/** Cart ID */
|
|
72
|
+
cartHdrUid: number;
|
|
73
|
+
/** Prophet 21 customer the cart belongs to */
|
|
74
|
+
customerId: number;
|
|
75
|
+
/** Prophet 21 contact the cart belongs to */
|
|
76
|
+
contactId: number;
|
|
77
|
+
/** Storefront user the cart belongs to */
|
|
78
|
+
userId: number;
|
|
79
|
+
[key: string]: unknown;
|
|
80
|
+
}
|
|
81
|
+
/** Returned by: api.commerce.cartHdr.list.list(params) */
|
|
82
|
+
export type CartHdrListListData = CartHdrListListItem[];
|
|
83
|
+
/**
|
|
84
|
+
* Shape of data nested in CartHdrLookupGetData (MINIMUM fields; reused wherever the same shape
|
|
85
|
+
* appears)
|
|
86
|
+
*
|
|
87
|
+
* Nested in CartHdrLookupGetData
|
|
88
|
+
*/
|
|
89
|
+
export interface CartHdrLookupGetDataOption1 {
|
|
90
|
+
/** Cart ID */
|
|
91
|
+
cartHdrUid: number;
|
|
92
|
+
/** Prophet 21 customer the cart belongs to */
|
|
93
|
+
customerId: number;
|
|
94
|
+
/** Storefront user the cart belongs to */
|
|
95
|
+
userId: number;
|
|
96
|
+
/** Prophet 21 contact the cart belongs to */
|
|
97
|
+
contactId: number;
|
|
98
|
+
/** Token that identifies the cart to the storefront */
|
|
99
|
+
cartToken: string | null;
|
|
100
|
+
/** The user's cart number; 0 is the user's default cart */
|
|
101
|
+
userCartNo: number;
|
|
102
|
+
[key: string]: unknown;
|
|
103
|
+
}
|
|
104
|
+
/**
|
|
105
|
+
* Lookup Cart Hdr
|
|
106
|
+
* Response data for GET /cart-hdr/lookup — MINIMUM fields, extras pass through
|
|
107
|
+
*
|
|
108
|
+
* Returned by: api.commerce.cartHdr.lookup.get(params)
|
|
109
|
+
*/
|
|
110
|
+
export type CartHdrLookupGetData = CartHdrLookupGetDataOption1 | false;
|
|
111
|
+
/**
|
|
112
|
+
* Shape of `inventorySupplier` (MINIMUM fields; reused wherever the same shape appears)
|
|
113
|
+
* The item's suppliers (not deleted)
|
|
114
|
+
*
|
|
115
|
+
* Field `inventorySupplier` of CartHdrAlsoBoughtListItem
|
|
116
|
+
*/
|
|
117
|
+
export interface CartHdrAlsoBoughtListItemInventorySupplierItem {
|
|
118
|
+
/** Item supplier ID */
|
|
119
|
+
inventorySupplierUid: number;
|
|
120
|
+
/** Item (inv_mast) supplied */
|
|
121
|
+
invMastUid: number;
|
|
122
|
+
/** Supplier ID */
|
|
123
|
+
supplierId: number;
|
|
124
|
+
/** Supplier UPC code; empty when none (max 14 chars) */
|
|
125
|
+
upcCode: string;
|
|
126
|
+
/** UPC check digit (P21 decimal(1,0)); null when none */
|
|
127
|
+
checkDigit: number | null;
|
|
128
|
+
/** upcCode followed by checkDigit */
|
|
129
|
+
upc: string;
|
|
130
|
+
/** Supplier part number (max 40 chars) */
|
|
131
|
+
supplierPartNo: string | null;
|
|
132
|
+
/** Y when this is the item's primary supplier (max 1 chars) */
|
|
133
|
+
primarySupplierFlag: string | null;
|
|
134
|
+
/** Supplier list price */
|
|
135
|
+
listPrice: number | null;
|
|
136
|
+
[key: string]: unknown;
|
|
137
|
+
}
|
|
138
|
+
/**
|
|
139
|
+
* Shape of `itemUom` (MINIMUM fields; reused wherever the same shape appears)
|
|
140
|
+
* Units of measure (not deleted)
|
|
141
|
+
*
|
|
142
|
+
* Field `itemUom` of CartHdrAlsoBoughtListItem
|
|
143
|
+
*/
|
|
144
|
+
export interface CartHdrAlsoBoughtListItemItemUomItem {
|
|
145
|
+
/** Unit of measure code (max 8 chars) */
|
|
146
|
+
unitOfMeasure: string;
|
|
147
|
+
/** Base units per one of this unit */
|
|
148
|
+
unitSize: number;
|
|
149
|
+
[key: string]: unknown;
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* Shape of `itemOptionsHdr` (MINIMUM fields; reused wherever the same shape appears)
|
|
153
|
+
* The option group offered
|
|
154
|
+
*
|
|
155
|
+
* Field `itemOptionsHdr` of CartHdrAlsoBoughtListItemLegacyPersonalizationItem
|
|
156
|
+
*/
|
|
157
|
+
export interface CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemOptionsHdr {
|
|
158
|
+
/** Option group ID */
|
|
159
|
+
itemOptionsHdrUid: number;
|
|
160
|
+
/** Option group name */
|
|
161
|
+
name: string | null;
|
|
162
|
+
/** Label shown to the customer */
|
|
163
|
+
label: string | null;
|
|
164
|
+
/** Option group description */
|
|
165
|
+
description: string | null;
|
|
166
|
+
/** Display mode */
|
|
167
|
+
display: number | null;
|
|
168
|
+
/** Size */
|
|
169
|
+
size: number | null;
|
|
170
|
+
/** Date the record was last changed */
|
|
171
|
+
dateLastModified: string | null;
|
|
172
|
+
/** Alias */
|
|
173
|
+
alias: string | null;
|
|
174
|
+
[key: string]: unknown;
|
|
175
|
+
}
|
|
176
|
+
/**
|
|
177
|
+
* Shape of `itemOptionsLine` (MINIMUM fields; reused wherever the same shape appears)
|
|
178
|
+
* The option offered
|
|
179
|
+
*
|
|
180
|
+
* Field `itemOptionsLine` of
|
|
181
|
+
* CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItem
|
|
182
|
+
*/
|
|
183
|
+
export interface CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItemItemOptionsLine {
|
|
184
|
+
/** Option ID */
|
|
185
|
+
itemOptionsLineUid: number;
|
|
186
|
+
/** Option group the option belongs to */
|
|
187
|
+
itemOptionsHdrUid: number;
|
|
188
|
+
/** Option name */
|
|
189
|
+
name: string | null;
|
|
190
|
+
/** Sort position */
|
|
191
|
+
ordering: number | null;
|
|
192
|
+
/** Size */
|
|
193
|
+
size: number | null;
|
|
194
|
+
/** Date the record was last changed */
|
|
195
|
+
dateLastModified: string | null;
|
|
196
|
+
[key: string]: unknown;
|
|
197
|
+
}
|
|
198
|
+
/**
|
|
199
|
+
* Shape of `itemPersonalizationLines` (MINIMUM fields; reused wherever the same shape appears)
|
|
200
|
+
* The options offered
|
|
201
|
+
*
|
|
202
|
+
* Field `itemPersonalizationLines` of CartHdrAlsoBoughtListItemLegacyPersonalizationItem
|
|
203
|
+
*/
|
|
204
|
+
export interface CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItem {
|
|
205
|
+
/** Personalization line ID */
|
|
206
|
+
itemPersonalizationLineUid: number;
|
|
207
|
+
/** Personalization the line belongs to */
|
|
208
|
+
itemPersonalizationHdrUid: number;
|
|
209
|
+
/** Option offered */
|
|
210
|
+
itemOptionsLineUid: number;
|
|
211
|
+
/** 1 when the option is offered */
|
|
212
|
+
active: number | null;
|
|
213
|
+
/** 1 when the option is the default */
|
|
214
|
+
def: number | null;
|
|
215
|
+
/** Item (inv_mast) added to the order when the option is chosen */
|
|
216
|
+
adjustmentInvMastUid: number | null;
|
|
217
|
+
/** Date the record was last changed */
|
|
218
|
+
dateLastModified: string | null;
|
|
219
|
+
/** Date the record was created */
|
|
220
|
+
dateCreated: string | null;
|
|
221
|
+
/** Update code (1185 = Import Complete) */
|
|
222
|
+
updateCd: number;
|
|
223
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
224
|
+
statusCd: number;
|
|
225
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
226
|
+
processCd: number;
|
|
227
|
+
/** The option offered */
|
|
228
|
+
itemOptionsLine: CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItemItemOptionsLine;
|
|
229
|
+
[key: string]: unknown;
|
|
230
|
+
}
|
|
231
|
+
/**
|
|
232
|
+
* Shape of `legacyPersonalization` (MINIMUM fields; reused wherever the same shape appears)
|
|
233
|
+
* Personalizations from the legacy service
|
|
234
|
+
*
|
|
235
|
+
* Field `legacyPersonalization` of CartHdrAlsoBoughtListItem
|
|
236
|
+
*/
|
|
237
|
+
export interface CartHdrAlsoBoughtListItemLegacyPersonalizationItem {
|
|
238
|
+
/** Personalization ID */
|
|
239
|
+
itemPersonalizationHdrUid: number;
|
|
240
|
+
/** Item (inv_mast) the personalization belongs to */
|
|
241
|
+
invMastUid: number;
|
|
242
|
+
/** Option group offered */
|
|
243
|
+
itemOptionsHdrUid: number;
|
|
244
|
+
/** Sort position */
|
|
245
|
+
ordering: number | null;
|
|
246
|
+
/** Option chosen by default */
|
|
247
|
+
defaultItemOptionsLineUid: number | null;
|
|
248
|
+
/** 1 when the customer must choose an option */
|
|
249
|
+
required: number | null;
|
|
250
|
+
/** Date the record was last changed */
|
|
251
|
+
dateLastModified: string | null;
|
|
252
|
+
/** Date the record was created */
|
|
253
|
+
dateCreated: string | null;
|
|
254
|
+
/** Update code (1185 = Import Complete) */
|
|
255
|
+
updateCd: number;
|
|
256
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
257
|
+
statusCd: number;
|
|
258
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
259
|
+
processCd: number;
|
|
260
|
+
/** The option group offered */
|
|
261
|
+
itemOptionsHdr: CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemOptionsHdr;
|
|
262
|
+
/** The options offered */
|
|
263
|
+
itemPersonalizationLines: CartHdrAlsoBoughtListItemLegacyPersonalizationItemItemPersonalizationLinesItem[];
|
|
264
|
+
[key: string]: unknown;
|
|
265
|
+
}
|
|
266
|
+
/**
|
|
267
|
+
* Shape of `attributes` (MINIMUM fields; reused wherever the same shape appears)
|
|
268
|
+
* Active attribute values, in attribute-group sequence order
|
|
269
|
+
*
|
|
270
|
+
* Field `attributes` of CartHdrAlsoBoughtListItem
|
|
271
|
+
*/
|
|
272
|
+
export interface CartHdrAlsoBoughtListItemAttributesItem {
|
|
273
|
+
/** Attribute description */
|
|
274
|
+
attributeName: string | null;
|
|
275
|
+
/** The item's value for the attribute */
|
|
276
|
+
attributeValue: string | null;
|
|
277
|
+
[key: string]: unknown;
|
|
278
|
+
}
|
|
279
|
+
/**
|
|
280
|
+
* Shape of `stockData` (MINIMUM fields; reused wherever the same shape appears)
|
|
281
|
+
* Stock at each location
|
|
282
|
+
*
|
|
283
|
+
* Field `stockData` of CartHdrAlsoBoughtListItemStock
|
|
284
|
+
*/
|
|
285
|
+
export interface CartHdrAlsoBoughtListItemStockStockDataItem {
|
|
286
|
+
/** Location ID */
|
|
287
|
+
locationId: number;
|
|
288
|
+
/** Company the location belongs to (max 8 chars) */
|
|
289
|
+
companyId: string;
|
|
290
|
+
/** Quantity on hand, in base units */
|
|
291
|
+
qtyOnHand: number;
|
|
292
|
+
/** Quantity allocated, in base units */
|
|
293
|
+
qtyAllocated: number;
|
|
294
|
+
/** Y when the item is stocked at the location (max 1 chars) */
|
|
295
|
+
stockable: string | null;
|
|
296
|
+
/** Y when the item is sold from the location (max 1 chars) */
|
|
297
|
+
sellable: string | null;
|
|
298
|
+
/** Y when the item is discontinued at the location (max 1 chars) */
|
|
299
|
+
discontinued: string;
|
|
300
|
+
/** Y when the location record is deleted in P21 (inv_loc.delete_flag) (max 1 chars) */
|
|
301
|
+
deleteFlag: string | null;
|
|
302
|
+
/** qtyOnHand minus qtyAllocated */
|
|
303
|
+
unallocated: number;
|
|
304
|
+
/** Date (Y-m-d) the next purchase order is due in */
|
|
305
|
+
nextDueInPoDate: string | null;
|
|
306
|
+
/** Quantity backordered */
|
|
307
|
+
qtyBackordered: number | null;
|
|
308
|
+
/** Primary bin (max 10 chars) */
|
|
309
|
+
primaryBin: string | null;
|
|
310
|
+
/** Quantity frozen */
|
|
311
|
+
qtyFrozen: number;
|
|
312
|
+
/** Quantity quarantined */
|
|
313
|
+
qtyQuarantined: number;
|
|
314
|
+
/** Quantity not pickable */
|
|
315
|
+
qtyNonPickable: number;
|
|
316
|
+
/** qtyOnHand less allocated, frozen, quarantined and non-pickable */
|
|
317
|
+
qtyAvailable: number;
|
|
318
|
+
/** Order quantity */
|
|
319
|
+
orderQuantity: number | null;
|
|
320
|
+
/** Product group at the location (max 8 chars) */
|
|
321
|
+
productGroupId: string | null;
|
|
322
|
+
/** Item base unit */
|
|
323
|
+
baseUnit: string;
|
|
324
|
+
/** Base unit size (1 when unset) */
|
|
325
|
+
baseUnitSize: number;
|
|
326
|
+
/** Item default selling unit (max 8 chars) */
|
|
327
|
+
defaultSellingUnit: string | null;
|
|
328
|
+
/** Default selling unit size */
|
|
329
|
+
defaultSellingUnitSize: number;
|
|
330
|
+
/** defaultSellingUnitSize divided by baseUnitSize */
|
|
331
|
+
divisor: number;
|
|
332
|
+
/** qtyOnHand in selling units */
|
|
333
|
+
calcQtyOnHand: number;
|
|
334
|
+
/** qtyAllocated in selling units */
|
|
335
|
+
calcQtyAllocated: number;
|
|
336
|
+
/** qtyAvailable in selling units */
|
|
337
|
+
calcQtyAvailable: number;
|
|
338
|
+
/** Location name, or "Location {locationId}" when it cannot be resolved */
|
|
339
|
+
locationName: string;
|
|
340
|
+
[key: string]: unknown;
|
|
341
|
+
}
|
|
342
|
+
/**
|
|
343
|
+
* Shape of `stock` (MINIMUM fields; reused wherever the same shape appears)
|
|
344
|
+
* Stock by location and per company
|
|
345
|
+
*
|
|
346
|
+
* Field `stock` of CartHdrAlsoBoughtListItem
|
|
347
|
+
*/
|
|
348
|
+
export interface CartHdrAlsoBoughtListItemStock {
|
|
349
|
+
/** Stock at each location */
|
|
350
|
+
stockData: CartHdrAlsoBoughtListItemStockStockDataItem[];
|
|
351
|
+
/** Selling-unit quantity available per company ID, vendor stock included */
|
|
352
|
+
companySummary: Record<string, number>;
|
|
353
|
+
[key: string]: unknown;
|
|
354
|
+
}
|
|
355
|
+
/**
|
|
356
|
+
* Shape of `invMastText` (MINIMUM fields; reused wherever the same shape appears)
|
|
357
|
+
* Prophet 21 item text blocks (empty unless the site has a p21_pim config)
|
|
358
|
+
*
|
|
359
|
+
* Field `invMastText` of CartHdrAlsoBoughtListItem
|
|
360
|
+
*/
|
|
361
|
+
export interface CartHdrAlsoBoughtListItemInvMastTextItem {
|
|
362
|
+
/** Display order */
|
|
363
|
+
sequenceNo: number;
|
|
364
|
+
/** Y when the text displays on the web */
|
|
365
|
+
displayOnWebFlag: string;
|
|
366
|
+
/** Prophet 21 text type code */
|
|
367
|
+
textTypeCd: number;
|
|
368
|
+
/** Text type description; null when the code cannot be resolved */
|
|
369
|
+
textTypeDesc: string | null;
|
|
370
|
+
/** Web display type ID */
|
|
371
|
+
webDisplayTypeUid: number;
|
|
372
|
+
/** Web display type code */
|
|
373
|
+
webDisplayTypeId: string;
|
|
374
|
+
/** Web display type description */
|
|
375
|
+
webDisplayTypeDesc: string;
|
|
376
|
+
/** The text */
|
|
377
|
+
textValue: string;
|
|
378
|
+
[key: string]: unknown;
|
|
379
|
+
}
|
|
380
|
+
/**
|
|
381
|
+
* Shape of `languages` (MINIMUM fields; reused wherever the same shape appears)
|
|
382
|
+
* Descriptions in other languages
|
|
383
|
+
*
|
|
384
|
+
* Field `languages` of CartHdrAlsoBoughtListItem
|
|
385
|
+
*/
|
|
386
|
+
export interface CartHdrAlsoBoughtListItemLanguagesItem {
|
|
387
|
+
/** Item language ID */
|
|
388
|
+
invMastLanguageUid: number;
|
|
389
|
+
/** Item (inv_mast) the description belongs to */
|
|
390
|
+
invMastUid: number;
|
|
391
|
+
/** Language ID */
|
|
392
|
+
languageId: string | null;
|
|
393
|
+
/** Item description in the language */
|
|
394
|
+
languageItemDesc: string | null;
|
|
395
|
+
/** Y when the description is deleted */
|
|
396
|
+
itemDescDeleteFlag: string;
|
|
397
|
+
/** Date the record was created */
|
|
398
|
+
dateCreated: string;
|
|
399
|
+
/** User who created the record */
|
|
400
|
+
createdBy: string;
|
|
401
|
+
/** Date the record was last changed */
|
|
402
|
+
dateLastModified: string;
|
|
403
|
+
/** User who last changed the record */
|
|
404
|
+
lastMaintainedBy: string;
|
|
405
|
+
/** Extended description in the language */
|
|
406
|
+
languageExtendedDesc: string | null;
|
|
407
|
+
/** Update code (1185 = Import Complete) */
|
|
408
|
+
updateCd: number;
|
|
409
|
+
[key: string]: unknown;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Shape of `assets` (MINIMUM fields; reused wherever the same shape appears)
|
|
413
|
+
* Active assets linked to the item; the key is absent when the lookup failed
|
|
414
|
+
*
|
|
415
|
+
* Field `assets` of CartHdrAlsoBoughtListItemBrandFolder
|
|
416
|
+
*/
|
|
417
|
+
export interface CartHdrAlsoBoughtListItemBrandFolderAssetsItem {
|
|
418
|
+
/** Brandfolder asset ID */
|
|
419
|
+
id: string;
|
|
420
|
+
/** Asset name */
|
|
421
|
+
name: string | null;
|
|
422
|
+
/** First attachment's file name */
|
|
423
|
+
attachmentName: string | null;
|
|
424
|
+
/** CDN URL of the asset */
|
|
425
|
+
cdnLink: string;
|
|
426
|
+
/** Attachment layout (square when unknown) */
|
|
427
|
+
layout: string;
|
|
428
|
+
[key: string]: unknown;
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* Shape of `brandFolder` (MINIMUM fields; reused wherever the same shape appears)
|
|
432
|
+
* Brandfolder assets (trinitysurfaces only)
|
|
433
|
+
*
|
|
434
|
+
* Field `brandFolder` of CartHdrAlsoBoughtListItem
|
|
435
|
+
*/
|
|
436
|
+
export interface CartHdrAlsoBoughtListItemBrandFolder {
|
|
437
|
+
/** Active assets linked to the item; the key is absent when the lookup failed */
|
|
438
|
+
assets?: CartHdrAlsoBoughtListItemBrandFolderAssetsItem[] | null;
|
|
439
|
+
[key: string]: unknown;
|
|
440
|
+
}
|
|
441
|
+
/**
|
|
442
|
+
* Shape of `fullSizedSamples` (MINIMUM fields; reused wherever the same shape appears)
|
|
443
|
+
* Full-sized sample item, or false (trinitysurfaces only)
|
|
444
|
+
*
|
|
445
|
+
* Field `fullSizedSamples` of CartHdrAlsoBoughtListItem
|
|
446
|
+
* Field `swatchSample` of CartHdrAlsoBoughtListItem
|
|
447
|
+
*/
|
|
448
|
+
export interface CartHdrAlsoBoughtListItemFullSizedSamplesOption1 {
|
|
449
|
+
/** Sample item ID */
|
|
450
|
+
itemId: string;
|
|
451
|
+
/** Sample item (inv_mast) ID */
|
|
452
|
+
invMastUid: number;
|
|
453
|
+
/** Sample item class 5 */
|
|
454
|
+
classId5: string | null;
|
|
455
|
+
/** True when the 4th character of classId5 is 1 */
|
|
456
|
+
samplesApp: boolean;
|
|
457
|
+
[key: string]: unknown;
|
|
458
|
+
}
|
|
459
|
+
/**
|
|
460
|
+
* List Also Bought data for Cart Hdr
|
|
461
|
+
* Response data for GET /cart-hdr/{cartHdrUid}/also-bought — MINIMUM fields, extras pass through
|
|
462
|
+
*
|
|
463
|
+
* Returned by: api.commerce.cartHdr.alsoBought.list(cartHdrUid, params) (array items)
|
|
464
|
+
*/
|
|
465
|
+
export interface CartHdrAlsoBoughtListItem {
|
|
466
|
+
/** Item (inv_mast) ID */
|
|
467
|
+
invMastUid: number;
|
|
468
|
+
/** Item ID (max 40 chars) */
|
|
469
|
+
itemId: string;
|
|
470
|
+
/** Item description (max 40 chars) */
|
|
471
|
+
itemDesc: string | null;
|
|
472
|
+
/** First web-displayed category description for the item */
|
|
473
|
+
displayDesc: string | null;
|
|
474
|
+
/** Extended description (max 255 chars) */
|
|
475
|
+
extendedDesc: string | null;
|
|
476
|
+
/** Short code (max 30 chars) */
|
|
477
|
+
shortCode: string | null;
|
|
478
|
+
/** Default selling unit (max 8 chars) */
|
|
479
|
+
defaultSellingUnit: string | null;
|
|
480
|
+
/** Default purchasing unit (max 8 chars) */
|
|
481
|
+
defaultPurchasingUnit: string | null;
|
|
482
|
+
/** Y when the item is deleted (max 1 chars) */
|
|
483
|
+
deleteFlag: string;
|
|
484
|
+
/** Online code (704 = online) */
|
|
485
|
+
onlineCd: number;
|
|
486
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
487
|
+
statusCd: number;
|
|
488
|
+
/** Base unit (max 8 chars) */
|
|
489
|
+
baseUnit: string;
|
|
490
|
+
/** Vendor stock quantity */
|
|
491
|
+
vndrStock: number | null;
|
|
492
|
+
/** Item class 1 (max 8 chars) */
|
|
493
|
+
classId1: string | null;
|
|
494
|
+
/** Item class 2 (max 8 chars) */
|
|
495
|
+
classId2: string | null;
|
|
496
|
+
/** Item class 3 (max 8 chars) */
|
|
497
|
+
classId3: string | null;
|
|
498
|
+
/** Item class 4 (max 8 chars) */
|
|
499
|
+
classId4: string | null;
|
|
500
|
+
/** Item class 5 (max 8 chars) */
|
|
501
|
+
classId5: string | null;
|
|
502
|
+
/** Y when the item is serialized (max 1 chars) */
|
|
503
|
+
serialized: string;
|
|
504
|
+
/** Y when the item is lot-tracked (max 1 chars) */
|
|
505
|
+
trackLots: string;
|
|
506
|
+
/** Tracking pattern derived from serialized and trackLots */
|
|
507
|
+
trackingPattern: string;
|
|
508
|
+
/** Default product group (max 8 chars) */
|
|
509
|
+
defaultProductGroup: string | null;
|
|
510
|
+
/** Default sales discount group (max 8 chars) */
|
|
511
|
+
defaultSalesDiscountGroup: string | null;
|
|
512
|
+
/** Default purchase discount group (max 8 chars) */
|
|
513
|
+
defaultPurchaseDiscGroup: string | null;
|
|
514
|
+
/** UPC or EAN code type (max 3 chars) */
|
|
515
|
+
upcOrEan: string | null;
|
|
516
|
+
/** UPC or EAN code (max 15 chars) */
|
|
517
|
+
upcOrEanId: string | null;
|
|
518
|
+
/** Weight */
|
|
519
|
+
weight: number | null;
|
|
520
|
+
/** Length */
|
|
521
|
+
length: number | null;
|
|
522
|
+
/** Width */
|
|
523
|
+
width: number | null;
|
|
524
|
+
/** Height */
|
|
525
|
+
height: number | null;
|
|
526
|
+
/** Parker product code (max 255 chars) */
|
|
527
|
+
parkerProductCd: string | null;
|
|
528
|
+
/** Brand name (max 255 chars) */
|
|
529
|
+
brandName: string | null;
|
|
530
|
+
/** Manufacturer name (max 255 chars) */
|
|
531
|
+
manufacturerName: string | null;
|
|
532
|
+
/** The item's suppliers (not deleted) */
|
|
533
|
+
inventorySupplier: CartHdrAlsoBoughtListItemInventorySupplierItem[];
|
|
534
|
+
/** Most common primary supplier across the item's locations */
|
|
535
|
+
primarySupplierName: string | null;
|
|
536
|
+
/** Units of measure (not deleted) */
|
|
537
|
+
itemUom: CartHdrAlsoBoughtListItemItemUomItem[];
|
|
538
|
+
/** Alternate codes */
|
|
539
|
+
alternateCodes: string[];
|
|
540
|
+
/** Tags from the legacy service */
|
|
541
|
+
legacyTags: string[];
|
|
542
|
+
/** Personalizations from the legacy service */
|
|
543
|
+
legacyPersonalization: CartHdrAlsoBoughtListItemLegacyPersonalizationItem[];
|
|
544
|
+
/** Item category IDs the item is in, ancestors included */
|
|
545
|
+
categoryList: number[];
|
|
546
|
+
/** Active attribute values, in attribute-group sequence order */
|
|
547
|
+
attributes: CartHdrAlsoBoughtListItemAttributesItem[];
|
|
548
|
+
/** Image URLs or paths */
|
|
549
|
+
images: string[];
|
|
550
|
+
/** Stock by location and per company */
|
|
551
|
+
stock: CartHdrAlsoBoughtListItemStock;
|
|
552
|
+
/** Category display description per item category ID */
|
|
553
|
+
categoryDisplayDescriptions: Record<string, string>;
|
|
554
|
+
/** Non-empty user-defined field values, keyed by field name; {} when the item has none */
|
|
555
|
+
userDefined: Record<string, unknown>;
|
|
556
|
+
/** Prophet 21 item text blocks (empty unless the site has a p21_pim config) */
|
|
557
|
+
invMastText: CartHdrAlsoBoughtListItemInvMastTextItem[];
|
|
558
|
+
/** Descriptions in other languages */
|
|
559
|
+
languages: CartHdrAlsoBoughtListItemLanguagesItem[];
|
|
560
|
+
/** Brandfolder assets (trinitysurfaces only) */
|
|
561
|
+
brandFolder?: CartHdrAlsoBoughtListItemBrandFolder | null;
|
|
562
|
+
/** Category trees for the item's non-root categories (trinitysurfaces only) */
|
|
563
|
+
docCatTrees?: Array<number[]> | null;
|
|
564
|
+
/** Product collection of the item's category under root 3 (trinitysurfaces only) */
|
|
565
|
+
productCollection?: string | null;
|
|
566
|
+
/** Leaf category under root 3, or false (trinitysurfaces only) */
|
|
567
|
+
tsItemCategoryUid?: number | null | false;
|
|
568
|
+
/** Leaf category under root 5, or false (trinitysurfaces only) */
|
|
569
|
+
ttItemCategoryUid?: number | null | false;
|
|
570
|
+
/** True when the trim user-defined field is Y (trinitysurfaces only) */
|
|
571
|
+
trim?: boolean | null;
|
|
572
|
+
/** Full-sized sample item, or false (trinitysurfaces only) */
|
|
573
|
+
fullSizedSamples?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | null | false;
|
|
574
|
+
/** Swatch sample item, or false (trinitysurfaces only) */
|
|
575
|
+
swatchSample?: CartHdrAlsoBoughtListItemFullSizedSamplesOption1 | null | false;
|
|
576
|
+
/** Variant group the item belongs to */
|
|
577
|
+
itemVariantHdrUid?: number | null;
|
|
578
|
+
/** List price 1 (only with includePricing=Y) */
|
|
579
|
+
price1?: number | null;
|
|
580
|
+
/** List price 2 (only with includePricing=Y) */
|
|
581
|
+
price2?: number | null;
|
|
582
|
+
/** List price 3 (only with includePricing=Y) */
|
|
583
|
+
price3?: number | null;
|
|
584
|
+
/** List price 4 (only with includePricing=Y) */
|
|
585
|
+
price4?: number | null;
|
|
586
|
+
/** List price 5 (only with includePricing=Y) */
|
|
587
|
+
price5?: number | null;
|
|
588
|
+
/** List price 6 (only with includePricing=Y) */
|
|
589
|
+
price6?: number | null;
|
|
590
|
+
/** List price 7 (only with includePricing=Y) */
|
|
591
|
+
price7?: number | null;
|
|
592
|
+
/** List price 8 (only with includePricing=Y) */
|
|
593
|
+
price8?: number | null;
|
|
594
|
+
/** List price 9 (only with includePricing=Y) */
|
|
595
|
+
price9?: number | null;
|
|
596
|
+
/** List price 10 (only with includePricing=Y) */
|
|
597
|
+
price10?: number | null;
|
|
598
|
+
[key: string]: unknown;
|
|
599
|
+
}
|
|
600
|
+
/** Returned by: api.commerce.cartHdr.alsoBought.list(cartHdrUid, params) */
|
|
601
|
+
export type CartHdrAlsoBoughtListData = CartHdrAlsoBoughtListItem[];
|
|
602
|
+
/**
|
|
603
|
+
* GET Cart Lines
|
|
604
|
+
* Response data for GET /cart-line/{cartHdrUid} — MINIMUM fields, extras pass through
|
|
605
|
+
*
|
|
606
|
+
* Returned by: api.commerce.cartLine.get(cartHdrUid) (array items)
|
|
607
|
+
*/
|
|
608
|
+
export interface CartLineGetItem {
|
|
609
|
+
/** Line number within the cart */
|
|
610
|
+
lineNo: number;
|
|
611
|
+
/** Item (inv_mast) on the line */
|
|
612
|
+
invMastUid: number;
|
|
613
|
+
/** Quantity in unitOfMeasure */
|
|
614
|
+
quantity: number | null;
|
|
615
|
+
/** Unit of measure (max 8 chars) */
|
|
616
|
+
unitOfMeasure: string | null;
|
|
617
|
+
/** Line note (max 255 chars) */
|
|
618
|
+
lineNote: string | null;
|
|
619
|
+
/** Caller key that identifies the line, when the site enables cart line keys (max 255 chars) */
|
|
620
|
+
key: string | null;
|
|
621
|
+
/** Unit price stored on the line */
|
|
622
|
+
unitPrice: number | null;
|
|
623
|
+
/** Item ID of invMastUid */
|
|
624
|
+
itemId: string;
|
|
625
|
+
/** Whether the item is an assembly [Y|N] */
|
|
626
|
+
isAssembly: string;
|
|
627
|
+
/** Number of lines in the cart that carry the same item */
|
|
628
|
+
invMastUidCount: number;
|
|
629
|
+
[key: string]: unknown;
|
|
630
|
+
}
|
|
631
|
+
/** Returned by: api.commerce.cartLine.get(cartHdrUid) */
|
|
632
|
+
export type CartLineGetData = CartLineGetItem[];
|
|
633
|
+
/**
|
|
634
|
+
* DELETE Cart Lines
|
|
635
|
+
* Response data for DELETE /cart-line/{cartHdrUid} — MINIMUM fields, extras pass through
|
|
636
|
+
*
|
|
637
|
+
* Returned by: api.commerce.cartLine.delete(cartHdrUid)
|
|
638
|
+
*/
|
|
639
|
+
export type CartLineDeleteData = boolean;
|
|
640
|
+
/**
|
|
641
|
+
* ADD item to the cart
|
|
642
|
+
* Response data for POST /cart-line/{cartHdrUid}/add — MINIMUM fields, extras pass through
|
|
643
|
+
*
|
|
644
|
+
* Returned by: api.commerce.cartLine.add.create(cartHdrUid, data)
|
|
645
|
+
*/
|
|
646
|
+
export type CartLineAddCreateData = boolean;
|
|
647
|
+
/**
|
|
648
|
+
* ADD item to the cart
|
|
649
|
+
* Request body for POST /cart-line/{cartHdrUid}/add — MINIMUM fields, extras pass through
|
|
650
|
+
*
|
|
651
|
+
* Request body of: api.commerce.cartLine.add.create(cartHdrUid, data) (array items)
|
|
652
|
+
* Request body of: api.commerce.cartLine.update.create(cartHdrUid, data) (array items)
|
|
653
|
+
*/
|
|
654
|
+
export interface CartLineAddCreateBodyItem {
|
|
655
|
+
/** Item (inv_mast) to put on the line */
|
|
656
|
+
invMastUid: number | null;
|
|
657
|
+
/** Quantity in unitOfMeasure */
|
|
658
|
+
quantity: number | null;
|
|
659
|
+
/** Unit of measure; upper-cased before it is stored (max 8 chars) */
|
|
660
|
+
unitOfMeasure: string | null;
|
|
661
|
+
/** Line number to write; absent or 0 lets the cart pick the line (by item, or by key on add) */
|
|
662
|
+
lineNo?: number | null;
|
|
663
|
+
/** Line note, at most 255 characters kept (max 255 chars) */
|
|
664
|
+
lineNote?: string | null;
|
|
665
|
+
/** Unit price to store on the line; absent stores none */
|
|
666
|
+
unitPrice?: number | null;
|
|
667
|
+
/**
|
|
668
|
+
* Caller key that identifies the line on add when the site enables cart line keys; ignored by
|
|
669
|
+
* update (max 255 chars)
|
|
670
|
+
*/
|
|
671
|
+
key?: string | null;
|
|
672
|
+
[key: string]: unknown;
|
|
673
|
+
}
|
|
674
|
+
/** Request body of: api.commerce.cartLine.add.create(cartHdrUid, data) */
|
|
675
|
+
export type CartLineAddCreateBody = CartLineAddCreateBodyItem[];
|
|
676
|
+
/**
|
|
677
|
+
* DELETE Cart Line
|
|
678
|
+
* Response data for DELETE /cart-line/{cartHdrUid}/lines/{lineNo} — MINIMUM fields, extras pass
|
|
679
|
+
* through
|
|
680
|
+
*
|
|
681
|
+
* Returned by: api.commerce.cartLine.lines.delete(cartHdrUid, lineNo)
|
|
682
|
+
*/
|
|
683
|
+
export interface CartLineLinesDeleteData {
|
|
684
|
+
/** Always true */
|
|
685
|
+
success: boolean;
|
|
686
|
+
/** Confirmation text */
|
|
687
|
+
message: string;
|
|
688
|
+
[key: string]: unknown;
|
|
689
|
+
}
|
|
690
|
+
/**
|
|
691
|
+
* UPDATE item to the cart
|
|
692
|
+
* Response data for POST /cart-line/{cartHdrUid}/update — MINIMUM fields, extras pass through
|
|
693
|
+
*
|
|
694
|
+
* Returned by: api.commerce.cartLine.update.create(cartHdrUid, data)
|
|
695
|
+
*/
|
|
696
|
+
export type CartLineUpdateCreateData = boolean;
|
|
697
|
+
/**
|
|
698
|
+
* UPDATE item to the cart
|
|
699
|
+
* Request body for POST /cart-line/{cartHdrUid}/update — MINIMUM fields, extras pass through
|
|
700
|
+
*
|
|
701
|
+
* Request body of: api.commerce.cartLine.update.create(cartHdrUid, data) (array items)
|
|
702
|
+
*/
|
|
703
|
+
export type CartLineUpdateCreateBodyItem = CartLineAddCreateBodyItem;
|
|
704
|
+
/** Request body of: api.commerce.cartLine.update.create(cartHdrUid, data) */
|
|
705
|
+
export type CartLineUpdateCreateBody = CartLineUpdateCreateBodyItem[];
|
|
706
|
+
/**
|
|
707
|
+
* Create new Checkout
|
|
708
|
+
* Response data for POST /checkout — MINIMUM fields, extras pass through
|
|
709
|
+
*
|
|
710
|
+
* Returned by: api.commerce.checkout.create(data)
|
|
711
|
+
*/
|
|
712
|
+
export interface CheckoutCreateData {
|
|
713
|
+
/** Checkout ID */
|
|
714
|
+
checkoutUid: number;
|
|
715
|
+
/** Checkout UUID */
|
|
716
|
+
checkoutUuid: string;
|
|
717
|
+
/** Status code (704 = Active) */
|
|
718
|
+
statusCd: number;
|
|
719
|
+
/**
|
|
720
|
+
* The order payload as stored, echoed back; an empty string when the posted body was empty ([]
|
|
721
|
+
* when empty)
|
|
722
|
+
*/
|
|
723
|
+
body: Record<string, unknown> | [];
|
|
724
|
+
[key: string]: unknown;
|
|
725
|
+
}
|
|
726
|
+
/**
|
|
727
|
+
* Shape of `notes` (MINIMUM fields; reused wherever the same shape appears)
|
|
728
|
+
* Order-level note
|
|
729
|
+
*
|
|
730
|
+
* Field `notes` of CheckoutCreateBody
|
|
731
|
+
*/
|
|
732
|
+
export interface CheckoutCreateBodyNotes {
|
|
733
|
+
/** Note text */
|
|
734
|
+
note?: string | null;
|
|
735
|
+
/** Note topic (Import Note when omitted) */
|
|
736
|
+
topic?: string | null;
|
|
737
|
+
[key: string]: unknown;
|
|
738
|
+
}
|
|
739
|
+
/**
|
|
740
|
+
* Create new Checkout
|
|
741
|
+
* Request body for POST /checkout — MINIMUM fields, extras pass through
|
|
742
|
+
*
|
|
743
|
+
* Request body of: api.commerce.checkout.create(data)
|
|
744
|
+
*/
|
|
745
|
+
export interface CheckoutCreateBody {
|
|
746
|
+
/**
|
|
747
|
+
* Order header fields (customerId, shipTo*, customerPoNo, shippingEstimate, userEmail, userId,
|
|
748
|
+
* ...) ([] when empty)
|
|
749
|
+
*/
|
|
750
|
+
oeHdr?: Record<string, unknown> | [] | null;
|
|
751
|
+
/** Alias of oeHdr ([] when empty) */
|
|
752
|
+
header?: Record<string, unknown> | [] | null;
|
|
753
|
+
/**
|
|
754
|
+
* Order lines (itemId, invMastUid, unitQuantity or qty, unitOfMeasure or uom, unitPrice,
|
|
755
|
+
* manualPriceOverride, willCall, lineNote or note, key, ...)
|
|
756
|
+
*/
|
|
757
|
+
oeLine?: Array<Record<string, unknown>> | null;
|
|
758
|
+
/** Alias of oeLine */
|
|
759
|
+
lines?: Array<Record<string, unknown>> | null;
|
|
760
|
+
/** Order-level note */
|
|
761
|
+
notes?: CheckoutCreateBodyNotes | null;
|
|
762
|
+
/** Order notepad entries, passed through to the import as sent */
|
|
763
|
+
oeHdrNotepad?: unknown;
|
|
764
|
+
/** Alias of oeHdrNotepad */
|
|
765
|
+
headerNote?: unknown;
|
|
766
|
+
/** Order salesreps, passed through to the import as sent */
|
|
767
|
+
oeHdrSalesrep?: unknown;
|
|
768
|
+
/** Alias of oeHdrSalesrep */
|
|
769
|
+
salesRep?: unknown;
|
|
770
|
+
/** AR payment details, passed through to the import as sent */
|
|
771
|
+
arPaymentDetails?: unknown;
|
|
772
|
+
/** Credit card payment details, passed through to the import as sent */
|
|
773
|
+
creditcardPaymentDetails?: unknown;
|
|
774
|
+
/**
|
|
775
|
+
* Web shopper fields for the import's oe_hdr_web (built from oeHdr userEmail/userId when omitted)
|
|
776
|
+
* ([] when empty)
|
|
777
|
+
*/
|
|
778
|
+
web?: Record<string, unknown> | [] | null;
|
|
779
|
+
/** Payment fields (paymentAccountId, processor, lastFour, ...) ([] when empty) */
|
|
780
|
+
payments?: Record<string, unknown> | [] | null;
|
|
781
|
+
[key: string]: unknown;
|
|
782
|
+
}
|
|
783
|
+
/**
|
|
784
|
+
* Get Checkout Details
|
|
785
|
+
* Response data for GET /checkout/{checkoutUid} — MINIMUM fields, extras pass through
|
|
786
|
+
*
|
|
787
|
+
* Returned by: api.commerce.checkout.get(checkoutUid)
|
|
788
|
+
*/
|
|
789
|
+
export interface CheckoutGetData {
|
|
790
|
+
/** Checkout ID */
|
|
791
|
+
checkoutUid: number;
|
|
792
|
+
/** Checkout UUID (max 255 chars) */
|
|
793
|
+
checkoutUuid: string;
|
|
794
|
+
/**
|
|
795
|
+
* Status code (704 = Active, 1267 = Pending after validate, 2556 = Process Import, 1185 = Import
|
|
796
|
+
* Complete, 1183 = Import Error)
|
|
797
|
+
*/
|
|
798
|
+
statusCd: number;
|
|
799
|
+
/** Checkout type (prophet21) (max 255 chars) */
|
|
800
|
+
checkoutType: string | null;
|
|
801
|
+
/** Date the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
802
|
+
dateCreated: string;
|
|
803
|
+
/** Date the record was last modified (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
804
|
+
dateLastModified: string;
|
|
805
|
+
/** Checkout properties as a JSON string */
|
|
806
|
+
properties: string | null;
|
|
807
|
+
/** Checkout processor name; not set by the commerce service today (max 255 chars) */
|
|
808
|
+
checkoutProcessor: string | null;
|
|
809
|
+
/** Storefront checkout payload as a JSON string, stored verbatim */
|
|
810
|
+
jsonData: string | null;
|
|
811
|
+
/** Source system name for a checkout brought in from another service (legacy) (max 255 chars) */
|
|
812
|
+
sourceName: string | null;
|
|
813
|
+
/** Record ID in the source system (max 255 chars) */
|
|
814
|
+
sourceId: string | null;
|
|
815
|
+
/** Cart ID (cart_hdr_uid) the checkout came from */
|
|
816
|
+
cartHdrUid: number;
|
|
817
|
+
[key: string]: unknown;
|
|
818
|
+
}
|
|
819
|
+
/**
|
|
820
|
+
* Activate Checkout
|
|
821
|
+
* Response data for PUT /checkout/{checkoutUid}/activate — MINIMUM fields, extras pass through
|
|
822
|
+
*
|
|
823
|
+
* Returned by: api.commerce.checkout.activate.update(checkoutUid)
|
|
824
|
+
* Returned by: api.commerce.checkout.validate.update(checkoutUid)
|
|
825
|
+
*/
|
|
826
|
+
export interface CheckoutActivateUpdateData {
|
|
827
|
+
/** Checkout ID */
|
|
828
|
+
checkoutUid: number;
|
|
829
|
+
/** Checkout UUID */
|
|
830
|
+
checkoutUuid: string;
|
|
831
|
+
/**
|
|
832
|
+
* Status code (704 = Active, 1267 = Pending after validate, 2556 = Process Import, 1185 = Import
|
|
833
|
+
* Complete, 1183 = Import Error)
|
|
834
|
+
*/
|
|
835
|
+
statusCd: number;
|
|
836
|
+
[key: string]: unknown;
|
|
837
|
+
}
|
|
838
|
+
/**
|
|
839
|
+
* Get Checkout Doc
|
|
840
|
+
* Response data for GET /checkout/{checkoutUid}/doc — MINIMUM fields, extras pass through
|
|
841
|
+
*
|
|
842
|
+
* Returned by: api.commerce.checkout.doc.list(checkoutUid)
|
|
843
|
+
*/
|
|
844
|
+
export interface CheckoutDocListData {
|
|
845
|
+
/** Checkout ID */
|
|
846
|
+
checkoutUid: number;
|
|
847
|
+
/** Checkout UUID */
|
|
848
|
+
checkoutUuid: string;
|
|
849
|
+
/**
|
|
850
|
+
* Status code (704 = Active, 1267 = Pending after validate, 2556 = Process Import, 1185 = Import
|
|
851
|
+
* Complete, 1183 = Import Error)
|
|
852
|
+
*/
|
|
853
|
+
statusCd: number;
|
|
854
|
+
/** Checkout type */
|
|
855
|
+
checkoutType: string | null;
|
|
856
|
+
/** Date created (Y-m-d H:i:s) */
|
|
857
|
+
dateCreated: string;
|
|
858
|
+
/** Date last modified (Y-m-d H:i:s) */
|
|
859
|
+
dateLastModified: string;
|
|
860
|
+
/** Checkout properties decoded from JSON; null when none are stored ([] when empty) */
|
|
861
|
+
properties: Record<string, unknown> | [] | null;
|
|
862
|
+
/** Payment processor that handled the checkout */
|
|
863
|
+
checkoutProcessor: string | null;
|
|
864
|
+
/** The order payload as the stored JSON string */
|
|
865
|
+
jsonData: string | null;
|
|
866
|
+
/** System that created the checkout */
|
|
867
|
+
sourceName: string | null;
|
|
868
|
+
/** Record ID in the source system */
|
|
869
|
+
sourceId: string | null;
|
|
870
|
+
/** Cart the checkout was created from */
|
|
871
|
+
cartHdrUid: number;
|
|
872
|
+
[key: string]: unknown;
|
|
873
|
+
}
|
|
874
|
+
/**
|
|
875
|
+
* Validate Checkout
|
|
876
|
+
* Response data for PUT /checkout/{checkoutUid}/validate — MINIMUM fields, extras pass through
|
|
877
|
+
*
|
|
878
|
+
* Returned by: api.commerce.checkout.validate.update(checkoutUid)
|
|
879
|
+
*/
|
|
880
|
+
export type CheckoutValidateUpdateData = CheckoutActivateUpdateData;
|
|
881
|
+
export interface CommerceClientSpec {
|
|
882
|
+
cartHdr: {
|
|
883
|
+
alsoBought: {
|
|
884
|
+
/**
|
|
885
|
+
* List Also Bought data for Cart Hdr
|
|
886
|
+
* Call: api.commerce.cartHdr.alsoBought.list(cartHdrUid, params)
|
|
887
|
+
*
|
|
888
|
+
* Response data, each item: The full item doc (InvMastHelper::generateDoc)
|
|
889
|
+
*
|
|
890
|
+
* Errors:
|
|
891
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
892
|
+
*
|
|
893
|
+
* GET https://commerce.augur-api.com/cart-hdr/{cartHdrUid}/also-bought
|
|
894
|
+
* Contract:
|
|
895
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1cart-hdr~1{cartHdrUid}~1also-bought/get
|
|
896
|
+
*
|
|
897
|
+
* @param cartHdrUid Cart ID (cart_hdr_uid) whose items drive the recommendations
|
|
898
|
+
* @param params CartHdrAlsoBoughtListParams (query string)
|
|
899
|
+
* @returns BaseResponse whose `data` is CartHdrAlsoBoughtListData
|
|
900
|
+
*/
|
|
901
|
+
list: (cartHdrUid: number, params?: CartHdrAlsoBoughtListParams) => Promise<BaseResponse<CartHdrAlsoBoughtListData>>;
|
|
902
|
+
};
|
|
903
|
+
list: {
|
|
904
|
+
/**
|
|
905
|
+
* List Cart Hdr by user_id
|
|
906
|
+
* Call: api.commerce.cartHdr.list.list(params)
|
|
907
|
+
*
|
|
908
|
+
* Response data, each item: One of a user's carts
|
|
909
|
+
*
|
|
910
|
+
* GET https://commerce.augur-api.com/cart-hdr/list
|
|
911
|
+
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1cart-hdr~1list/get
|
|
912
|
+
*
|
|
913
|
+
* @param params CartHdrListListParams (query string)
|
|
914
|
+
* @returns BaseResponse whose `data` is CartHdrListListData
|
|
915
|
+
*/
|
|
916
|
+
list: (params?: CartHdrListListParams) => Promise<BaseResponse<CartHdrListListData>>;
|
|
917
|
+
};
|
|
918
|
+
lookup: {
|
|
919
|
+
/**
|
|
920
|
+
* Lookup Cart Hdr
|
|
921
|
+
* Call: api.commerce.cartHdr.lookup.get(params)
|
|
922
|
+
*
|
|
923
|
+
* GET https://commerce.augur-api.com/cart-hdr/lookup
|
|
924
|
+
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1cart-hdr~1lookup/get
|
|
925
|
+
*
|
|
926
|
+
* @param params CartHdrLookupGetParams (query string)
|
|
927
|
+
* @returns BaseResponse whose `data` is CartHdrLookupGetData
|
|
928
|
+
*/
|
|
929
|
+
get: (params?: CartHdrLookupGetParams) => Promise<BaseResponse<CartHdrLookupGetData>>;
|
|
930
|
+
};
|
|
931
|
+
};
|
|
932
|
+
cartLine: {
|
|
933
|
+
/**
|
|
934
|
+
* GET Cart Lines
|
|
935
|
+
* Call: api.commerce.cartLine.get(cartHdrUid)
|
|
936
|
+
*
|
|
937
|
+
* Response data, each item: One cart line with its item's id and assembly flag
|
|
938
|
+
*
|
|
939
|
+
* Errors:
|
|
940
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
941
|
+
*
|
|
942
|
+
* GET https://commerce.augur-api.com/cart-line/{cartHdrUid}
|
|
943
|
+
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1cart-line~1{cartHdrUid}/get
|
|
944
|
+
*
|
|
945
|
+
* @param cartHdrUid Cart ID (cart_hdr_uid) the lines belong to
|
|
946
|
+
* @param params CartLineGetParams (query string)
|
|
947
|
+
* @returns BaseResponse whose `data` is CartLineGetData
|
|
948
|
+
*/
|
|
949
|
+
get: (cartHdrUid: number, params?: CartLineGetParams) => Promise<BaseResponse<CartLineGetData>>;
|
|
950
|
+
/**
|
|
951
|
+
* DELETE Cart Lines
|
|
952
|
+
* Call: api.commerce.cartLine.delete(cartHdrUid)
|
|
953
|
+
*
|
|
954
|
+
* Errors:
|
|
955
|
+
* 404: No record with this ID. Or Cart not found.
|
|
956
|
+
*
|
|
957
|
+
* DELETE https://commerce.augur-api.com/cart-line/{cartHdrUid}
|
|
958
|
+
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1cart-line~1{cartHdrUid}/delete
|
|
959
|
+
*
|
|
960
|
+
* @param cartHdrUid Cart ID (cart_hdr_uid) the lines belong to
|
|
961
|
+
* @returns BaseResponse whose `data` is CartLineDeleteData
|
|
962
|
+
*/
|
|
963
|
+
delete: (cartHdrUid: number) => Promise<BaseResponse<CartLineDeleteData>>;
|
|
964
|
+
add: {
|
|
965
|
+
/**
|
|
966
|
+
* ADD item to the cart
|
|
967
|
+
* Call: api.commerce.cartLine.add.create(cartHdrUid, data)
|
|
968
|
+
*
|
|
969
|
+
* Request body, each item: One cart line to add or update; the body is a JSON array of these
|
|
970
|
+
*
|
|
971
|
+
* Errors:
|
|
972
|
+
* 400: Cart header uid is required. Or Cart line data is required. Or Every cart line
|
|
973
|
+
* requires invMastUid, quantity and unitOfMeasure.
|
|
974
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
975
|
+
*
|
|
976
|
+
* POST https://commerce.augur-api.com/cart-line/{cartHdrUid}/add
|
|
977
|
+
* Contract:
|
|
978
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1cart-line~1{cartHdrUid}~1add/post
|
|
979
|
+
*
|
|
980
|
+
* @param cartHdrUid Cart ID (cart_hdr_uid) the lines belong to
|
|
981
|
+
* @param data CartLineAddCreateBody (request body)
|
|
982
|
+
* @returns BaseResponse whose `data` is CartLineAddCreateData
|
|
983
|
+
*/
|
|
984
|
+
create: (cartHdrUid: number, data: CartLineAddCreateBody) => Promise<BaseResponse<CartLineAddCreateData>>;
|
|
985
|
+
};
|
|
986
|
+
lines: {
|
|
987
|
+
/**
|
|
988
|
+
* DELETE Cart Line
|
|
989
|
+
* Call: api.commerce.cartLine.lines.delete(cartHdrUid, lineNo)
|
|
990
|
+
*
|
|
991
|
+
* DELETE a specific Cart Line
|
|
992
|
+
*
|
|
993
|
+
* Response data: Confirmation that a cart line was deleted
|
|
994
|
+
*
|
|
995
|
+
* Errors:
|
|
996
|
+
* 404: No record with this ID. Or Cart line not found.
|
|
997
|
+
*
|
|
998
|
+
* DELETE https://commerce.augur-api.com/cart-line/{cartHdrUid}/lines/{lineNo}
|
|
999
|
+
* Contract:
|
|
1000
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1cart-line~1{cartHdrUid}~1lines~1{lineNo}/delete
|
|
1001
|
+
*
|
|
1002
|
+
* @param cartHdrUid Cart ID (cart_hdr_uid) the lines belong to
|
|
1003
|
+
* @param lineNo Line number within the cart
|
|
1004
|
+
* @returns BaseResponse whose `data` is CartLineLinesDeleteData
|
|
1005
|
+
*/
|
|
1006
|
+
delete: (cartHdrUid: number, lineNo: number) => Promise<BaseResponse<CartLineLinesDeleteData>>;
|
|
1007
|
+
};
|
|
1008
|
+
update: {
|
|
1009
|
+
/**
|
|
1010
|
+
* UPDATE item to the cart
|
|
1011
|
+
* Call: api.commerce.cartLine.update.create(cartHdrUid, data)
|
|
1012
|
+
*
|
|
1013
|
+
* Request body, each item: One cart line to add or update; the body is a JSON array of these
|
|
1014
|
+
*
|
|
1015
|
+
* Errors:
|
|
1016
|
+
* 400: Cart header uid is required. Or Cart line data is required. Or Every cart line
|
|
1017
|
+
* requires invMastUid, quantity and unitOfMeasure.
|
|
1018
|
+
* 404: No cart_hdr row with this cartHdrUid.
|
|
1019
|
+
*
|
|
1020
|
+
* POST https://commerce.augur-api.com/cart-line/{cartHdrUid}/update
|
|
1021
|
+
* Contract:
|
|
1022
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1cart-line~1{cartHdrUid}~1update/post
|
|
1023
|
+
*
|
|
1024
|
+
* @param cartHdrUid Cart ID (cart_hdr_uid) the lines belong to
|
|
1025
|
+
* @param data CartLineUpdateCreateBody (request body)
|
|
1026
|
+
* @returns BaseResponse whose `data` is CartLineUpdateCreateData
|
|
1027
|
+
*/
|
|
1028
|
+
create: (cartHdrUid: number, data: CartLineUpdateCreateBody) => Promise<BaseResponse<CartLineUpdateCreateData>>;
|
|
1029
|
+
};
|
|
1030
|
+
};
|
|
1031
|
+
checkout: {
|
|
1032
|
+
/**
|
|
1033
|
+
* Create new Checkout
|
|
1034
|
+
* Call: api.commerce.checkout.create(data)
|
|
1035
|
+
*
|
|
1036
|
+
* Request body: An order to check out; stored exactly as sent and converted to a P21 import
|
|
1037
|
+
* when processed
|
|
1038
|
+
* Response data: A new checkout with the order payload it stored
|
|
1039
|
+
*
|
|
1040
|
+
* Errors:
|
|
1041
|
+
* 400: The body is missing or not a JSON object.
|
|
1042
|
+
*
|
|
1043
|
+
* POST https://commerce.augur-api.com/checkout
|
|
1044
|
+
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1checkout/post
|
|
1045
|
+
*
|
|
1046
|
+
* @param data CheckoutCreateBody (request body)
|
|
1047
|
+
* @returns BaseResponse whose `data` is CheckoutCreateData
|
|
1048
|
+
*/
|
|
1049
|
+
create: (data: CheckoutCreateBody) => Promise<BaseResponse<CheckoutCreateData>>;
|
|
1050
|
+
/**
|
|
1051
|
+
* Get Checkout Details
|
|
1052
|
+
* Call: api.commerce.checkout.get(checkoutUid)
|
|
1053
|
+
*
|
|
1054
|
+
* Errors:
|
|
1055
|
+
* 404: Checkout not found.
|
|
1056
|
+
*
|
|
1057
|
+
* GET https://commerce.augur-api.com/checkout/{checkoutUid}
|
|
1058
|
+
* Contract: https://commerce.augur-api.com/openapi.json#/paths/~1checkout~1{checkoutUid}/get
|
|
1059
|
+
*
|
|
1060
|
+
* @param checkoutUid Checkout ID (checkout_uid)
|
|
1061
|
+
* @param params CheckoutGetParams (query string)
|
|
1062
|
+
* @returns BaseResponse whose `data` is CheckoutGetData
|
|
1063
|
+
*/
|
|
1064
|
+
get: (checkoutUid: number, params?: CheckoutGetParams) => Promise<BaseResponse<CheckoutGetData>>;
|
|
1065
|
+
activate: {
|
|
1066
|
+
/**
|
|
1067
|
+
* Activate Checkout
|
|
1068
|
+
* Call: api.commerce.checkout.activate.update(checkoutUid)
|
|
1069
|
+
*
|
|
1070
|
+
* Response data: A checkout's id and status after a status change
|
|
1071
|
+
* No request body: the API ignores any body sent.
|
|
1072
|
+
*
|
|
1073
|
+
* Errors:
|
|
1074
|
+
* 404: No record with this ID.
|
|
1075
|
+
*
|
|
1076
|
+
* PUT https://commerce.augur-api.com/checkout/{checkoutUid}/activate
|
|
1077
|
+
* Contract:
|
|
1078
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1checkout~1{checkoutUid}~1activate/put
|
|
1079
|
+
*
|
|
1080
|
+
* @param checkoutUid Checkout ID (checkout_uid)
|
|
1081
|
+
* @param data Omit it: the API ignores any request body
|
|
1082
|
+
* @returns BaseResponse whose `data` is CheckoutActivateUpdateData
|
|
1083
|
+
*/
|
|
1084
|
+
update: (checkoutUid: number, data?: Record<string, unknown>) => Promise<BaseResponse<CheckoutActivateUpdateData>>;
|
|
1085
|
+
};
|
|
1086
|
+
doc: {
|
|
1087
|
+
/**
|
|
1088
|
+
* Get Checkout Doc
|
|
1089
|
+
* Call: api.commerce.checkout.doc.list(checkoutUid)
|
|
1090
|
+
*
|
|
1091
|
+
* Response data: A checkout row with its properties column decoded from JSON
|
|
1092
|
+
*
|
|
1093
|
+
* Errors:
|
|
1094
|
+
* 404: Checkout not found.
|
|
1095
|
+
*
|
|
1096
|
+
* GET https://commerce.augur-api.com/checkout/{checkoutUid}/doc
|
|
1097
|
+
* Contract:
|
|
1098
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1checkout~1{checkoutUid}~1doc/get
|
|
1099
|
+
*
|
|
1100
|
+
* @param checkoutUid Checkout ID (checkout_uid)
|
|
1101
|
+
* @param params CheckoutDocListParams (query string)
|
|
1102
|
+
* @returns BaseResponse whose `data` is CheckoutDocListData
|
|
1103
|
+
*/
|
|
1104
|
+
list: (checkoutUid: number, params?: CheckoutDocListParams) => Promise<BaseResponse<CheckoutDocListData>>;
|
|
1105
|
+
/**
|
|
1106
|
+
* Alias for `list`: GET /checkout/{checkoutUid}/doc. Call:
|
|
1107
|
+
* api.commerce.checkout.doc.get(checkoutUid)
|
|
1108
|
+
*/
|
|
1109
|
+
get: (checkoutUid: number, params?: CheckoutDocListParams) => Promise<BaseResponse<CheckoutDocListData>>;
|
|
1110
|
+
};
|
|
1111
|
+
validate: {
|
|
1112
|
+
/**
|
|
1113
|
+
* Validate Checkout
|
|
1114
|
+
* Call: api.commerce.checkout.validate.update(checkoutUid)
|
|
1115
|
+
*
|
|
1116
|
+
* Response data: A checkout's id and status after a status change
|
|
1117
|
+
* No request body: the API ignores any body sent.
|
|
1118
|
+
*
|
|
1119
|
+
* Errors:
|
|
1120
|
+
* 404: No record with this ID.
|
|
1121
|
+
*
|
|
1122
|
+
* PUT https://commerce.augur-api.com/checkout/{checkoutUid}/validate
|
|
1123
|
+
* Contract:
|
|
1124
|
+
* https://commerce.augur-api.com/openapi.json#/paths/~1checkout~1{checkoutUid}~1validate/put
|
|
1125
|
+
*
|
|
1126
|
+
* @param checkoutUid Checkout ID (checkout_uid)
|
|
1127
|
+
* @param data Omit it: the API ignores any request body
|
|
1128
|
+
* @returns BaseResponse whose `data` is CheckoutValidateUpdateData
|
|
1129
|
+
*/
|
|
1130
|
+
update: (checkoutUid: number, data?: Record<string, unknown>) => Promise<BaseResponse<CheckoutValidateUpdateData>>;
|
|
1131
|
+
};
|
|
1132
|
+
};
|
|
1133
|
+
}
|
|
1134
|
+
//# sourceMappingURL=types.d.ts.map
|