@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,3849 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the customers service.
|
|
3
|
+
* Customer master data including contacts, shipping addresses, invoices, rewards, and P21 customer
|
|
4
|
+
* sync
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://customers.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://customers.augur-api.com/openapi.json: the full contract: request and response bodies
|
|
11
|
+
* field by field, descriptions, formats and documented errors.
|
|
12
|
+
* https://customers.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur
|
|
13
|
+
* services.
|
|
14
|
+
*
|
|
15
|
+
* Source: shared/specs/customers.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 /contact-role */
|
|
22
|
+
export interface ContactRoleListParams extends EdgeCacheParams {
|
|
23
|
+
/** Maximum rows to return (Default: 10) */
|
|
24
|
+
limit?: number;
|
|
25
|
+
/** Starting offset results (Default: 0) */
|
|
26
|
+
offset?: number;
|
|
27
|
+
/** Order By (Default: contact_role_uid|ASC) */
|
|
28
|
+
orderBy?: string;
|
|
29
|
+
/**
|
|
30
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
31
|
+
* (704,705); -1 for every status. Default: 704
|
|
32
|
+
*/
|
|
33
|
+
rowStatusFlag?: number | number[];
|
|
34
|
+
}
|
|
35
|
+
/** Params for GET /contact-role/{contactRoleUid} */
|
|
36
|
+
export type ContactRoleGetParams = EdgeCacheParams;
|
|
37
|
+
/** Params for GET /contacts */
|
|
38
|
+
export interface ContactsListParams extends EdgeCacheParams {
|
|
39
|
+
/** Filter by company_id (contacts.company_id) */
|
|
40
|
+
companyId?: string;
|
|
41
|
+
/** Filter by contact_role_uid (contacts.contact_role_uid) */
|
|
42
|
+
contactRoleUid?: number;
|
|
43
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
44
|
+
deleteFlag?: string;
|
|
45
|
+
/** Maximum rows to return (Default: 10) */
|
|
46
|
+
limit?: number;
|
|
47
|
+
/** Filter by location_id (contacts.location_id) */
|
|
48
|
+
locationId?: number;
|
|
49
|
+
/** Starting offset results (Default: 0) */
|
|
50
|
+
offset?: number;
|
|
51
|
+
/** Order By (Default: id|ASC) */
|
|
52
|
+
orderBy?: string;
|
|
53
|
+
}
|
|
54
|
+
/** Params for GET /contacts-ud */
|
|
55
|
+
export interface ContactsUdListParams extends EdgeCacheParams {
|
|
56
|
+
/** Maximum rows to return (Default: 10) */
|
|
57
|
+
limit?: number;
|
|
58
|
+
/** Starting offset results (Default: 0) */
|
|
59
|
+
offset?: number;
|
|
60
|
+
/** Order By (Default: contacts_ud_uid|ASC) */
|
|
61
|
+
orderBy?: string;
|
|
62
|
+
/**
|
|
63
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
64
|
+
* (704,705); -1 for every status. Default: 704
|
|
65
|
+
*/
|
|
66
|
+
statusCd?: number | number[];
|
|
67
|
+
}
|
|
68
|
+
/** Params for GET /contacts-ud/{id} */
|
|
69
|
+
export type ContactsUdGetParams = EdgeCacheParams;
|
|
70
|
+
/** Params for GET /contacts-x-ship-to */
|
|
71
|
+
export interface ContactsXShipToListParams extends EdgeCacheParams {
|
|
72
|
+
/** Filter by company_id (contacts_x_ship_to.company_id) */
|
|
73
|
+
companyId?: string;
|
|
74
|
+
/** Filter by contact_id (contacts_x_ship_to.contact_id) */
|
|
75
|
+
contactId?: string;
|
|
76
|
+
/** Maximum rows to return (Default: 10) */
|
|
77
|
+
limit?: number;
|
|
78
|
+
/** Starting offset results (Default: 0) */
|
|
79
|
+
offset?: number;
|
|
80
|
+
/** Order By (Default: contacts_x_ship_to_uid|ASC) */
|
|
81
|
+
orderBy?: string;
|
|
82
|
+
/**
|
|
83
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
84
|
+
* (704,705); -1 for every status. Default: 704
|
|
85
|
+
*/
|
|
86
|
+
rowStatusFlag?: number | number[];
|
|
87
|
+
/** Filter by ship_to_id (contacts_x_ship_to.ship_to_id) */
|
|
88
|
+
shipToId?: number;
|
|
89
|
+
}
|
|
90
|
+
/** Params for GET /contacts-x-ship-to/{contactsXShipToUid} */
|
|
91
|
+
export type ContactsXShipToGetParams = EdgeCacheParams;
|
|
92
|
+
/** Params for GET /contacts/{id} */
|
|
93
|
+
export type ContactsGetParams = EdgeCacheParams;
|
|
94
|
+
/** Params for GET /contacts/{id}/customers */
|
|
95
|
+
export interface ContactsCustomersListParams extends EdgeCacheParams {
|
|
96
|
+
/** customer.class_5id (default: none) */
|
|
97
|
+
class5Id?: string;
|
|
98
|
+
/** limit (default 10) */
|
|
99
|
+
limit?: number;
|
|
100
|
+
/** offset (default 0) */
|
|
101
|
+
offset?: number;
|
|
102
|
+
/** Order By (Default: customer_id|ASC) */
|
|
103
|
+
orderBy?: string;
|
|
104
|
+
/** query */
|
|
105
|
+
q?: string;
|
|
106
|
+
}
|
|
107
|
+
/** Params for GET /contacts/{id}/doc */
|
|
108
|
+
export type ContactsDocListParams = EdgeCacheParams;
|
|
109
|
+
/** Params for GET /contacts/{id}/web-allowance */
|
|
110
|
+
export type ContactsWebAllowanceListParams = EdgeCacheParams;
|
|
111
|
+
/** Params for GET /customer */
|
|
112
|
+
export interface CustomerListParams extends EdgeCacheParams {
|
|
113
|
+
/** customer.class_5id (default: none) */
|
|
114
|
+
class5Id?: string;
|
|
115
|
+
/** customer.company_id (default: none) */
|
|
116
|
+
companyId?: string;
|
|
117
|
+
/** customer.delete_flag [Y|N] (default: none) */
|
|
118
|
+
deleteFlag?: string;
|
|
119
|
+
/** Limit number of results (Default: 10) */
|
|
120
|
+
limit?: number;
|
|
121
|
+
/** Offset number of results (Default: 0) */
|
|
122
|
+
offset?: number;
|
|
123
|
+
/** Sort ordering: default (ordering|ASC) */
|
|
124
|
+
orderBy?: string;
|
|
125
|
+
/** Query string */
|
|
126
|
+
q?: string;
|
|
127
|
+
/**
|
|
128
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
129
|
+
* (704,705); -1 for every status. Default: every status
|
|
130
|
+
*/
|
|
131
|
+
statusCd?: number | number[];
|
|
132
|
+
}
|
|
133
|
+
/** Params for GET /customer-language */
|
|
134
|
+
export interface CustomerLanguageListParams extends EdgeCacheParams {
|
|
135
|
+
/** Filter by company_id (customer_language.company_id) */
|
|
136
|
+
companyId?: string;
|
|
137
|
+
/** Filter by customer_id (customer_language.customer_id) */
|
|
138
|
+
customerId?: number;
|
|
139
|
+
/** Maximum rows to return (Default: 10) */
|
|
140
|
+
limit?: number;
|
|
141
|
+
/** Starting offset results (Default: 0) */
|
|
142
|
+
offset?: number;
|
|
143
|
+
/** Order By (Default: customer_language_uid|ASC) */
|
|
144
|
+
orderBy?: string;
|
|
145
|
+
}
|
|
146
|
+
/** Params for GET /customer-language/{customerLanguageUid} */
|
|
147
|
+
export type CustomerLanguageGetParams = EdgeCacheParams;
|
|
148
|
+
/** Params for GET /customer-ud */
|
|
149
|
+
export interface CustomerUdListParams extends EdgeCacheParams {
|
|
150
|
+
/** Filter by company_id (customer_ud.company_id) */
|
|
151
|
+
companyId?: string;
|
|
152
|
+
/** Filter by customer_id (customer_ud.customer_id) */
|
|
153
|
+
customerId?: number;
|
|
154
|
+
/** Maximum rows to return (Default: 10) */
|
|
155
|
+
limit?: number;
|
|
156
|
+
/** Starting offset results (Default: 0) */
|
|
157
|
+
offset?: number;
|
|
158
|
+
/** Order By (Default: customer_ud_uid|ASC) */
|
|
159
|
+
orderBy?: string;
|
|
160
|
+
/**
|
|
161
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
162
|
+
* (704,705); -1 for every status. Default: 704
|
|
163
|
+
*/
|
|
164
|
+
statusCd?: number | number[];
|
|
165
|
+
}
|
|
166
|
+
/** Params for GET /customer-ud/{customerUdUid} */
|
|
167
|
+
export type CustomerUdGetParams = EdgeCacheParams;
|
|
168
|
+
/** Params for GET /customer-x-restricted-class */
|
|
169
|
+
export interface CustomerXRestrictedClassListParams extends EdgeCacheParams {
|
|
170
|
+
/** Filter by company_id (customer_x_restricted_class.company_id) */
|
|
171
|
+
companyId?: string;
|
|
172
|
+
/** Filter by customer_id (customer_x_restricted_class.customer_id) */
|
|
173
|
+
customerId?: number;
|
|
174
|
+
/** Maximum rows to return (Default: 10) */
|
|
175
|
+
limit?: number;
|
|
176
|
+
/** Starting offset results (Default: 0) */
|
|
177
|
+
offset?: number;
|
|
178
|
+
/** Order By (Default: customer_x_restricted_class_uid|ASC) */
|
|
179
|
+
orderBy?: string;
|
|
180
|
+
/** Filter by restricted_class_uid (customer_x_restricted_class.restricted_class_uid) */
|
|
181
|
+
restrictedClassUid?: number;
|
|
182
|
+
/**
|
|
183
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
184
|
+
* (704,705); -1 for every status. Default: 704
|
|
185
|
+
*/
|
|
186
|
+
rowStatusFlag?: number | number[];
|
|
187
|
+
}
|
|
188
|
+
/** Params for GET /customer-x-restricted-class/{customerXRestrictedClassUid} */
|
|
189
|
+
export type CustomerXRestrictedClassGetParams = EdgeCacheParams;
|
|
190
|
+
/** Params for GET /customer-x-rewards-program */
|
|
191
|
+
export interface CustomerXRewardsProgramListParams extends EdgeCacheParams {
|
|
192
|
+
/** Filter by company_id (customer_x_rewards_program.company_id) */
|
|
193
|
+
companyId?: string;
|
|
194
|
+
/** Filter by customer_id (customer_x_rewards_program.customer_id) */
|
|
195
|
+
customerId?: number;
|
|
196
|
+
/** Maximum rows to return (Default: 10) */
|
|
197
|
+
limit?: number;
|
|
198
|
+
/** Starting offset results (Default: 0) */
|
|
199
|
+
offset?: number;
|
|
200
|
+
/** Order By (Default: customer_x_rewards_program_uid|ASC) */
|
|
201
|
+
orderBy?: string;
|
|
202
|
+
/** Filter by rewards_program_uid (customer_x_rewards_program.rewards_program_uid) */
|
|
203
|
+
rewardsProgramUid?: number;
|
|
204
|
+
/**
|
|
205
|
+
* P21 row status or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
206
|
+
* (704,705); -1 for every status. Default: 704
|
|
207
|
+
*/
|
|
208
|
+
rowStatusFlag?: number | number[];
|
|
209
|
+
/**
|
|
210
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
211
|
+
* (704,705); -1 for every status. Default: 704
|
|
212
|
+
*/
|
|
213
|
+
statusCd?: number | number[];
|
|
214
|
+
}
|
|
215
|
+
/** Params for GET /customer-x-rewards-program/{customerXRewardsProgramUid} */
|
|
216
|
+
export type CustomerXRewardsProgramGetParams = EdgeCacheParams;
|
|
217
|
+
/** Params for GET /customer/lookup */
|
|
218
|
+
export interface CustomerLookupGetParams extends EdgeCacheParams {
|
|
219
|
+
/** limit (default 10) */
|
|
220
|
+
limit?: number;
|
|
221
|
+
/** offset (default 0) */
|
|
222
|
+
offset?: number;
|
|
223
|
+
/** Order By (Default: customer_id|ASC) */
|
|
224
|
+
orderBy?: string;
|
|
225
|
+
/** search query */
|
|
226
|
+
q: string;
|
|
227
|
+
/**
|
|
228
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
229
|
+
* (704,705); -1 for every status. Default: every status
|
|
230
|
+
*/
|
|
231
|
+
statusCd?: number | number[];
|
|
232
|
+
}
|
|
233
|
+
/** Params for GET /customer/{customerId}/address */
|
|
234
|
+
export interface CustomerAddressListParams extends EdgeCacheParams {
|
|
235
|
+
/** limit (default 10) */
|
|
236
|
+
limit?: number;
|
|
237
|
+
/** offset (default 0) */
|
|
238
|
+
offset?: number;
|
|
239
|
+
/** search query */
|
|
240
|
+
q: string;
|
|
241
|
+
}
|
|
242
|
+
/** Params for GET /customer/{customerId}/addresses */
|
|
243
|
+
export interface CustomerAddressesListParams extends EdgeCacheParams {
|
|
244
|
+
/** Filter by email address */
|
|
245
|
+
emailAddress?: string;
|
|
246
|
+
/** Limit number of results (Default: 10) */
|
|
247
|
+
limit?: number;
|
|
248
|
+
/** Starting offset results (Default: 0) */
|
|
249
|
+
offset?: number;
|
|
250
|
+
/** Order By (Default: customer_address_uid|ASC) */
|
|
251
|
+
orderBy?: string;
|
|
252
|
+
/**
|
|
253
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
254
|
+
* (704,705); -1 for every status. Default: every status
|
|
255
|
+
*/
|
|
256
|
+
statusCd?: number | number[];
|
|
257
|
+
}
|
|
258
|
+
/** Params for GET /customer/{customerId}/addresses/{customerAddressUid} */
|
|
259
|
+
export type CustomerAddressesGetParams = EdgeCacheParams;
|
|
260
|
+
/** Params for GET /customer/{customerId}/aging */
|
|
261
|
+
export interface CustomerAgingListParams extends EdgeCacheParams {
|
|
262
|
+
/** age balances as of this date (YYYY-MM-DD); defaults to today */
|
|
263
|
+
asOf?: string;
|
|
264
|
+
/** limit (default 10) */
|
|
265
|
+
limit?: number;
|
|
266
|
+
/** offset (default 0) */
|
|
267
|
+
offset?: number;
|
|
268
|
+
/** orderBy (default invoice_date|ASC) */
|
|
269
|
+
orderBy?: string;
|
|
270
|
+
/** invoice_hdr.ship_to_id */
|
|
271
|
+
shipToId?: number;
|
|
272
|
+
}
|
|
273
|
+
/** Params for GET /customer/{customerId}/contacts */
|
|
274
|
+
export interface CustomerContactsListParams extends EdgeCacheParams {
|
|
275
|
+
/** limit (default 10) */
|
|
276
|
+
limit?: number;
|
|
277
|
+
/** offset (default 0) */
|
|
278
|
+
offset?: number;
|
|
279
|
+
/** Order By (Default: email_address|ASC) */
|
|
280
|
+
orderBy?: string;
|
|
281
|
+
/** search query */
|
|
282
|
+
q: string;
|
|
283
|
+
}
|
|
284
|
+
/** Params for GET /customer/{customerId}/doc */
|
|
285
|
+
export type CustomerDocListParams = EdgeCacheParams;
|
|
286
|
+
/** Params for GET /customer/{customerId}/invoices */
|
|
287
|
+
export interface CustomerInvoicesListParams extends EdgeCacheParams {
|
|
288
|
+
/** filter by contact_id */
|
|
289
|
+
contactId?: string;
|
|
290
|
+
/** filter by date_created from this date (YYYY-MM-DD); requires createdTo */
|
|
291
|
+
createdFrom?: string;
|
|
292
|
+
/** filter by date_created on a single day (YYYY-MM-DD) */
|
|
293
|
+
createdOn?: string;
|
|
294
|
+
/** filter by date_created to this date (YYYY-MM-DD); requires createdFrom */
|
|
295
|
+
createdTo?: string;
|
|
296
|
+
/**
|
|
297
|
+
* Comma-separated Prophet 21 invoice adjustment types to list (C = credit memo); replaces the
|
|
298
|
+
* default I,P
|
|
299
|
+
*/
|
|
300
|
+
invoiceAdjustmentType?: string;
|
|
301
|
+
/** limit (default 10) */
|
|
302
|
+
limit?: number;
|
|
303
|
+
/** offset (default 0) */
|
|
304
|
+
offset?: number;
|
|
305
|
+
/** Sort as invoice_hdr column|ASC or column|DESC (default date_created|DESC) */
|
|
306
|
+
orderBy?: string;
|
|
307
|
+
/** filter by paid_in_full_flag (Y/N) */
|
|
308
|
+
paidInFull?: string;
|
|
309
|
+
/** search query */
|
|
310
|
+
q?: string;
|
|
311
|
+
/** invoice_hdr.ship_to_id */
|
|
312
|
+
shipToId?: number;
|
|
313
|
+
}
|
|
314
|
+
/** Params for GET /customer/{customerId}/invoices/{invoiceNo} */
|
|
315
|
+
export type CustomerInvoicesGetParams = EdgeCacheParams;
|
|
316
|
+
/** Params for GET /customer/{customerId}/orders */
|
|
317
|
+
export interface CustomerOrdersListParams extends EdgeCacheParams {
|
|
318
|
+
/** oe_hdr.address_id */
|
|
319
|
+
addressId?: number;
|
|
320
|
+
/** cancel flag [N|Y|B] (default N; B = both) */
|
|
321
|
+
cancelFlag?: string;
|
|
322
|
+
/** filter by contact_id */
|
|
323
|
+
contactId?: string;
|
|
324
|
+
/** filter by date_created from this date (YYYY-MM-DD); requires createdTo */
|
|
325
|
+
createdFrom?: string;
|
|
326
|
+
/** filter by date_created on a single day (YYYY-MM-DD) */
|
|
327
|
+
createdOn?: string;
|
|
328
|
+
/** filter by date_created to this date (YYYY-MM-DD); requires createdFrom */
|
|
329
|
+
createdTo?: string;
|
|
330
|
+
/** delete flag [N|Y|B] (default N; B = both) */
|
|
331
|
+
deleteFlag?: string;
|
|
332
|
+
/**
|
|
333
|
+
* Shape of each order [Y|N|L] (default Y = the full order document; N = the oe_hdr row; L = the
|
|
334
|
+
* oe_hdr row plus light lines, deleted and cancelled lines excluded)
|
|
335
|
+
*/
|
|
336
|
+
fullDocument?: string;
|
|
337
|
+
/** limit (default 10) */
|
|
338
|
+
limit?: number;
|
|
339
|
+
/** offset (default 0) */
|
|
340
|
+
offset?: number;
|
|
341
|
+
/** orderBy [date_created|DESC] */
|
|
342
|
+
orderBy?: string;
|
|
343
|
+
/** query */
|
|
344
|
+
q?: string;
|
|
345
|
+
}
|
|
346
|
+
/** Params for GET /customer/{customerId}/orders/{orderNo} */
|
|
347
|
+
export type CustomerOrdersGetParams = EdgeCacheParams;
|
|
348
|
+
/** Params for GET /customer/{customerId}/purchased-items */
|
|
349
|
+
export interface CustomerPurchasedItemsListParams extends EdgeCacheParams {
|
|
350
|
+
/** limit (default 10) */
|
|
351
|
+
limit?: number;
|
|
352
|
+
/** offset (default 0) */
|
|
353
|
+
offset?: number;
|
|
354
|
+
/** orderBy [date_last_purchased|DESC] */
|
|
355
|
+
orderBy?: string;
|
|
356
|
+
}
|
|
357
|
+
/** Params for GET /customer/{customerId}/quotes */
|
|
358
|
+
export interface CustomerQuotesListParams extends EdgeCacheParams {
|
|
359
|
+
/** oe_hdr.address_id */
|
|
360
|
+
addressId?: number;
|
|
361
|
+
/** filter by contact_id */
|
|
362
|
+
contactId?: string;
|
|
363
|
+
/** filter by date_created from this date (YYYY-MM-DD); requires createdTo */
|
|
364
|
+
createdFrom?: string;
|
|
365
|
+
/** filter by date_created on a single day (YYYY-MM-DD) */
|
|
366
|
+
createdOn?: string;
|
|
367
|
+
/** filter by date_created to this date (YYYY-MM-DD); requires createdFrom */
|
|
368
|
+
createdTo?: string;
|
|
369
|
+
/** limit (default 10) */
|
|
370
|
+
limit?: number;
|
|
371
|
+
/** offset (default 0) */
|
|
372
|
+
offset?: number;
|
|
373
|
+
/** orderBy [date_created|DESC] */
|
|
374
|
+
orderBy?: string;
|
|
375
|
+
}
|
|
376
|
+
/** Params for GET /customer/{customerId}/quotes/{quoteNo} */
|
|
377
|
+
export type CustomerQuotesGetParams = EdgeCacheParams;
|
|
378
|
+
/** Params for GET /customer/{customerId}/rewards-programs */
|
|
379
|
+
export interface CustomerRewardsProgramsListParams extends EdgeCacheParams {
|
|
380
|
+
/** Maximum rows to return (Default: 10) */
|
|
381
|
+
limit?: number;
|
|
382
|
+
/** Starting offset results (Default: 0) */
|
|
383
|
+
offset?: number;
|
|
384
|
+
/** Order By (Default: customer_x_rewards_program_uid|ASC) */
|
|
385
|
+
orderBy?: string;
|
|
386
|
+
/**
|
|
387
|
+
* P21 row status or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
388
|
+
* (704,705); -1 for every status. Default: 704
|
|
389
|
+
*/
|
|
390
|
+
rowStatusFlag?: number | number[];
|
|
391
|
+
/**
|
|
392
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
393
|
+
* (704,705); -1 for every status. Default: 704
|
|
394
|
+
*/
|
|
395
|
+
statusCd?: number | number[];
|
|
396
|
+
}
|
|
397
|
+
/** Params for GET /customer/{customerId}/rmas */
|
|
398
|
+
export interface CustomerRmasListParams extends EdgeCacheParams {
|
|
399
|
+
/** filter by date_created from this date (YYYY-MM-DD); requires createdTo */
|
|
400
|
+
createdFrom?: string;
|
|
401
|
+
/** filter by date_created on a single day (YYYY-MM-DD) */
|
|
402
|
+
createdOn?: string;
|
|
403
|
+
/** filter by date_created to this date (YYYY-MM-DD); requires createdFrom */
|
|
404
|
+
createdTo?: string;
|
|
405
|
+
/** limit (default 10) */
|
|
406
|
+
limit?: number;
|
|
407
|
+
/** offset (default 0) */
|
|
408
|
+
offset?: number;
|
|
409
|
+
/** orderBy [date_created|DESC] */
|
|
410
|
+
orderBy?: string;
|
|
411
|
+
}
|
|
412
|
+
/** Params for GET /customer/{customerId}/rmas/{rmaNo} */
|
|
413
|
+
export type CustomerRmasGetParams = EdgeCacheParams;
|
|
414
|
+
/** Params for GET /customer/{customerId}/sales-usage */
|
|
415
|
+
export interface CustomerSalesUsageListParams extends EdgeCacheParams {
|
|
416
|
+
/** filter by invoice_date from this date (YYYY-MM-DD); defaults to 30 days ago */
|
|
417
|
+
invoicedFrom?: string;
|
|
418
|
+
/** filter by invoice_date to this date (YYYY-MM-DD); defaults to today */
|
|
419
|
+
invoicedTo?: string;
|
|
420
|
+
/** limit (default 10), applied to the folded item list */
|
|
421
|
+
limit?: number;
|
|
422
|
+
/** offset (default 0), applied to the folded item list */
|
|
423
|
+
offset?: number;
|
|
424
|
+
/** orderBy (default item_id|ASC) */
|
|
425
|
+
orderBy?: string;
|
|
426
|
+
/** search query */
|
|
427
|
+
q?: string;
|
|
428
|
+
/** invoice_hdr.ship_to_id */
|
|
429
|
+
shipToId?: number;
|
|
430
|
+
/** invoice_line.supplier_id */
|
|
431
|
+
supplierId?: number;
|
|
432
|
+
/** bucket granularity: week (default), month, or year */
|
|
433
|
+
totalBy?: string;
|
|
434
|
+
}
|
|
435
|
+
/** Params for GET /customer/{customerId}/ship-to */
|
|
436
|
+
export interface CustomerShipToListParams extends EdgeCacheParams {
|
|
437
|
+
/** limit (default 10) */
|
|
438
|
+
limit?: number;
|
|
439
|
+
/** offset (default 0) */
|
|
440
|
+
offset?: number;
|
|
441
|
+
/** orderBy [date_created|DESC] */
|
|
442
|
+
orderBy?: string;
|
|
443
|
+
}
|
|
444
|
+
/** Params for GET /customer/{customerId}/ship-to/lookup */
|
|
445
|
+
export interface CustomerShipToLookupGetParams extends EdgeCacheParams {
|
|
446
|
+
/** limit (default 10) */
|
|
447
|
+
limit?: number;
|
|
448
|
+
/** offset (default 0) */
|
|
449
|
+
offset?: number;
|
|
450
|
+
/** Order By (Default: id|ASC) */
|
|
451
|
+
orderBy?: string;
|
|
452
|
+
/** search query (matches address name or mail_address1) */
|
|
453
|
+
q?: string;
|
|
454
|
+
}
|
|
455
|
+
/** Params for GET /customer/{customerId}/ship-to/{shipToId}/freight-codes */
|
|
456
|
+
export type CustomerShipToFreightCodesListParams = EdgeCacheParams;
|
|
457
|
+
/** Params for GET /customer/{customerId}/tags */
|
|
458
|
+
export interface CustomerTagsListParams extends EdgeCacheParams {
|
|
459
|
+
/** Limit number of results (Default: 10) */
|
|
460
|
+
limit?: number;
|
|
461
|
+
/** Starting offset results (Default: 0) */
|
|
462
|
+
offset?: number;
|
|
463
|
+
/** Order By (Default: customer_tags_uid|ASC) */
|
|
464
|
+
orderBy?: string;
|
|
465
|
+
/**
|
|
466
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
467
|
+
* (704,705); -1 for every status. Default: every status
|
|
468
|
+
*/
|
|
469
|
+
statusCd?: number | number[];
|
|
470
|
+
}
|
|
471
|
+
/** Params for GET /customer/{customerId}/tags/{customerTagsUid} */
|
|
472
|
+
export type CustomerTagsGetParams = EdgeCacheParams;
|
|
473
|
+
/** Params for GET /oe-contacts-customer */
|
|
474
|
+
export interface OeContactsCustomerListParams extends EdgeCacheParams {
|
|
475
|
+
/** Filter by company_id (oe_contacts_customer.company_id) */
|
|
476
|
+
companyId?: string;
|
|
477
|
+
/** Filter by contact_id (oe_contacts_customer.contact_id) */
|
|
478
|
+
contactId?: string;
|
|
479
|
+
/** Filter by customer_id (oe_contacts_customer.customer_id) */
|
|
480
|
+
customerId?: number;
|
|
481
|
+
/** P21 delete flag to filter by: Y or N (Default: every row) */
|
|
482
|
+
deleteFlag?: string;
|
|
483
|
+
/** Maximum rows to return (Default: 10) */
|
|
484
|
+
limit?: number;
|
|
485
|
+
/** Starting offset results (Default: 0) */
|
|
486
|
+
offset?: number;
|
|
487
|
+
/** Order By (Default: company_id|ASC) */
|
|
488
|
+
orderBy?: string;
|
|
489
|
+
/** Filter by shopper_uid (oe_contacts_customer.shopper_uid) */
|
|
490
|
+
shopperUid?: number;
|
|
491
|
+
}
|
|
492
|
+
/** Params for GET /rewards-program */
|
|
493
|
+
export interface RewardsProgramListParams extends EdgeCacheParams {
|
|
494
|
+
/** Filter by company_id (rewards_program.company_id) */
|
|
495
|
+
companyId?: string;
|
|
496
|
+
/** Filter by dealer_type_uid (rewards_program.dealer_type_uid) */
|
|
497
|
+
dealerTypeUid?: number;
|
|
498
|
+
/** Maximum rows to return (Default: 10) */
|
|
499
|
+
limit?: number;
|
|
500
|
+
/** Filter by maf_surcharge_oc_inv_mast_uid (rewards_program.maf_surcharge_oc_inv_mast_uid) */
|
|
501
|
+
mafSurchargeOcInvMastUid?: number;
|
|
502
|
+
/** Starting offset results (Default: 0) */
|
|
503
|
+
offset?: number;
|
|
504
|
+
/** Order By (Default: rewards_program_uid|ASC) */
|
|
505
|
+
orderBy?: string;
|
|
506
|
+
/**
|
|
507
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
508
|
+
* (704,705); -1 for every status. Default: 704
|
|
509
|
+
*/
|
|
510
|
+
rowStatusFlag?: number | number[];
|
|
511
|
+
/**
|
|
512
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
513
|
+
* (704,705); -1 for every status. Default: 704
|
|
514
|
+
*/
|
|
515
|
+
statusCd?: number | number[];
|
|
516
|
+
/** Filter by supplier_id (rewards_program.supplier_id) */
|
|
517
|
+
supplierId?: number;
|
|
518
|
+
}
|
|
519
|
+
/** Params for GET /rewards-program/{rewardsProgramUid} */
|
|
520
|
+
export type RewardsProgramGetParams = EdgeCacheParams;
|
|
521
|
+
/** Params for GET /ship-to-ud */
|
|
522
|
+
export interface ShipToUdListParams extends EdgeCacheParams {
|
|
523
|
+
/** Filter by company_id (ship_to_ud.company_id) */
|
|
524
|
+
companyId?: string;
|
|
525
|
+
/** Maximum rows to return (Default: 10) */
|
|
526
|
+
limit?: number;
|
|
527
|
+
/** Starting offset results (Default: 0) */
|
|
528
|
+
offset?: number;
|
|
529
|
+
/** Order By (Default: ship_to_ud_uid|ASC) */
|
|
530
|
+
orderBy?: string;
|
|
531
|
+
/** Filter by ship_to_id (ship_to_ud.ship_to_id) */
|
|
532
|
+
shipToId?: number;
|
|
533
|
+
}
|
|
534
|
+
/** Params for GET /ship-to-ud/{shipToUdUid} */
|
|
535
|
+
export type ShipToUdGetParams = EdgeCacheParams;
|
|
536
|
+
/**
|
|
537
|
+
* List Contact Role Rows
|
|
538
|
+
* Response data for GET /contact-role — MINIMUM fields, extras pass through
|
|
539
|
+
*
|
|
540
|
+
* Returned by: api.customers.contactRole.list(params) (array items)
|
|
541
|
+
* Returned by: api.customers.contactRole.get(contactRoleUid)
|
|
542
|
+
*/
|
|
543
|
+
export interface ContactRoleListItem {
|
|
544
|
+
/** Unique ID of the contact role row */
|
|
545
|
+
contactRoleUid: number;
|
|
546
|
+
/** P21 contact role ID (max 255 chars) */
|
|
547
|
+
contactRoleId: string;
|
|
548
|
+
/** Contact role description (max 255 chars) */
|
|
549
|
+
contactRoleDesc: string;
|
|
550
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
551
|
+
rowStatusFlag: number;
|
|
552
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
553
|
+
dateCreated: string;
|
|
554
|
+
/** P21 user who created the row (max 255 chars) */
|
|
555
|
+
createdBy: string;
|
|
556
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
557
|
+
dateLastModified: string;
|
|
558
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
559
|
+
lastMaintainedBy: string;
|
|
560
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
561
|
+
updateCd: number;
|
|
562
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
563
|
+
processCd: number;
|
|
564
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
565
|
+
statusCd: number;
|
|
566
|
+
[key: string]: unknown;
|
|
567
|
+
}
|
|
568
|
+
/** Returned by: api.customers.contactRole.list(params) */
|
|
569
|
+
export type ContactRoleListData = ContactRoleListItem[];
|
|
570
|
+
/**
|
|
571
|
+
* Get Contact Role
|
|
572
|
+
* Response data for GET /contact-role/{contactRoleUid} — MINIMUM fields, extras pass through
|
|
573
|
+
*
|
|
574
|
+
* Returned by: api.customers.contactRole.get(contactRoleUid)
|
|
575
|
+
*/
|
|
576
|
+
export type ContactRoleGetData = ContactRoleListItem;
|
|
577
|
+
/**
|
|
578
|
+
* List Contacts Rows
|
|
579
|
+
* Response data for GET /contacts — MINIMUM fields, extras pass through
|
|
580
|
+
*
|
|
581
|
+
* Returned by: api.customers.contacts.list(params) (array items)
|
|
582
|
+
* Returned by: api.customers.contacts.get(id)
|
|
583
|
+
*/
|
|
584
|
+
export interface ContactsListItem {
|
|
585
|
+
/** P21 contact ID (max 16 chars) */
|
|
586
|
+
id: string;
|
|
587
|
+
/** P21 address ID (address.id) */
|
|
588
|
+
addressId: number;
|
|
589
|
+
/** Contact salutation (max 4 chars) */
|
|
590
|
+
salutation: string | null;
|
|
591
|
+
/** Contact first name (max 15 chars) */
|
|
592
|
+
firstName: string;
|
|
593
|
+
/** Contact middle initial (max 2 chars) */
|
|
594
|
+
mi: string | null;
|
|
595
|
+
/** Contact last name (max 24 chars) */
|
|
596
|
+
lastName: string;
|
|
597
|
+
/** Contact job title (max 40 chars) */
|
|
598
|
+
title: string | null;
|
|
599
|
+
/** Contact direct phone number (max 20 chars) */
|
|
600
|
+
directPhone: string | null;
|
|
601
|
+
/** Contact phone extension (max 5 chars) */
|
|
602
|
+
phoneExt: string | null;
|
|
603
|
+
/** Contact email address (max 255 chars) */
|
|
604
|
+
emailAddress: string | null;
|
|
605
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
606
|
+
dateCreated: string;
|
|
607
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
608
|
+
dateLastModified: string;
|
|
609
|
+
/** Contact home address line 1 (max 40 chars) */
|
|
610
|
+
homeAddress1: string | null;
|
|
611
|
+
/** Contact home address line 2 (max 40 chars) */
|
|
612
|
+
homeAddress2: string | null;
|
|
613
|
+
/** Contact birthday (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
614
|
+
birthday: string | null;
|
|
615
|
+
/** Contact anniversary date (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
616
|
+
anniversary: string | null;
|
|
617
|
+
/** Contact home phone number (max 20 chars) */
|
|
618
|
+
homePhone: string | null;
|
|
619
|
+
/** Contact second email address (max 255 chars) */
|
|
620
|
+
emailAddress2: string | null;
|
|
621
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
622
|
+
deleteFlag: string;
|
|
623
|
+
/** P21 login ID for the contact (max 30 chars) */
|
|
624
|
+
loginId: string | null;
|
|
625
|
+
/** Contact home email address (max 255 chars) */
|
|
626
|
+
homeEmailAddress: string | null;
|
|
627
|
+
/** P21 class 1 ID on the contact (max 8 chars) */
|
|
628
|
+
class1id: string | null;
|
|
629
|
+
/** P21 class 2 ID on the contact (max 8 chars) */
|
|
630
|
+
class2id: string | null;
|
|
631
|
+
/** P21 class 3 ID on the contact (max 8 chars) */
|
|
632
|
+
class3id: string | null;
|
|
633
|
+
/** P21 class 4 ID on the contact (max 8 chars) */
|
|
634
|
+
class4id: string | null;
|
|
635
|
+
/** P21 class 5 ID on the contact (max 8 chars) */
|
|
636
|
+
class5id: string | null;
|
|
637
|
+
/** P21 employee on the contact (max 1 chars) */
|
|
638
|
+
employee: string | null;
|
|
639
|
+
/** P21 company ID (max 8 chars) */
|
|
640
|
+
companyId: string | null;
|
|
641
|
+
/** Name of the contact address (max 255 chars) */
|
|
642
|
+
addressName: string | null;
|
|
643
|
+
/** P21 default branch ID for the contact (max 8 chars) */
|
|
644
|
+
defaultBranchId: string | null;
|
|
645
|
+
/** P21 technician on the contact (max 1 chars) */
|
|
646
|
+
technician: string;
|
|
647
|
+
/** P21 location ID on the contact */
|
|
648
|
+
locationId: number | null;
|
|
649
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
650
|
+
updateCd: number;
|
|
651
|
+
/** Contact role UID (contact_role.contact_role_uid) */
|
|
652
|
+
contactRoleUid: number | null;
|
|
653
|
+
/** P21 inside_salesrep_flag on the contact (max 1 chars) */
|
|
654
|
+
insideSalesrepFlag: string;
|
|
655
|
+
/** P21 salesrep default location ID on the contact */
|
|
656
|
+
salesrepDefaultLocationId: number | null;
|
|
657
|
+
/** When the row was created (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
658
|
+
createdAt: string;
|
|
659
|
+
/** Contact cellular phone number (max 20 chars) */
|
|
660
|
+
cellular: string | null;
|
|
661
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
662
|
+
processCd: number;
|
|
663
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
664
|
+
statusCd: number;
|
|
665
|
+
[key: string]: unknown;
|
|
666
|
+
}
|
|
667
|
+
/** Returned by: api.customers.contacts.list(params) */
|
|
668
|
+
export type ContactsListData = ContactsListItem[];
|
|
669
|
+
/**
|
|
670
|
+
* List Contacts Ud Rows
|
|
671
|
+
* Response data for GET /contacts-ud — MINIMUM fields, extras pass through
|
|
672
|
+
*
|
|
673
|
+
* Returned by: api.customers.contactsUd.list(params) (array items)
|
|
674
|
+
*/
|
|
675
|
+
export interface ContactsUdListItem {
|
|
676
|
+
/** Unique ID of the contact user-defined row */
|
|
677
|
+
contactsUdUid: number;
|
|
678
|
+
/** P21 contact ID (contacts.id) (max 16 chars) */
|
|
679
|
+
id: string;
|
|
680
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
681
|
+
dateCreated: string;
|
|
682
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
683
|
+
dateLastModified: string;
|
|
684
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
685
|
+
lastMaintainedBy: string;
|
|
686
|
+
/** P21 user who created the row (max 255 chars) */
|
|
687
|
+
createdBy: string | null;
|
|
688
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
689
|
+
updateCd: number;
|
|
690
|
+
/** P21 user-defined data for the row */
|
|
691
|
+
userData: string | null;
|
|
692
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
693
|
+
processCd: number;
|
|
694
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
695
|
+
statusCd: number;
|
|
696
|
+
[key: string]: unknown;
|
|
697
|
+
}
|
|
698
|
+
/** Returned by: api.customers.contactsUd.list(params) */
|
|
699
|
+
export type ContactsUdListData = ContactsUdListItem[];
|
|
700
|
+
/**
|
|
701
|
+
* List user defined fields for a contact
|
|
702
|
+
* Response data for GET /contacts-ud/{id} — MINIMUM fields, extras pass through
|
|
703
|
+
*
|
|
704
|
+
* Returned by: api.customers.contactsUd.get(id)
|
|
705
|
+
*/
|
|
706
|
+
export interface ContactsUdGetData {
|
|
707
|
+
/** Prophet 21 contact ID */
|
|
708
|
+
id: string;
|
|
709
|
+
/** Prophet 21 contacts_ud row */
|
|
710
|
+
contactsUdUid: number;
|
|
711
|
+
/** When the row was created (Y-m-d H:i:s) */
|
|
712
|
+
dateCreated: string;
|
|
713
|
+
/** When the row was last modified (Y-m-d H:i:s) */
|
|
714
|
+
dateLastModified: string;
|
|
715
|
+
/** Prophet 21 user who created the row */
|
|
716
|
+
createdBy: string | null;
|
|
717
|
+
/** Prophet 21 user who last changed the row */
|
|
718
|
+
lastMaintainedBy: string;
|
|
719
|
+
[key: string]: unknown;
|
|
720
|
+
}
|
|
721
|
+
/**
|
|
722
|
+
* List Contacts X Ship To Rows
|
|
723
|
+
* Response data for GET /contacts-x-ship-to — MINIMUM fields, extras pass through
|
|
724
|
+
*
|
|
725
|
+
* Returned by: api.customers.contactsXShipTo.list(params) (array items)
|
|
726
|
+
* Returned by: api.customers.contactsXShipTo.get(contactsXShipToUid)
|
|
727
|
+
*/
|
|
728
|
+
export interface ContactsXShipToListItem {
|
|
729
|
+
/** Unique ID of the contact-to-ship-to link row */
|
|
730
|
+
contactsXShipToUid: number;
|
|
731
|
+
/** P21 contact ID (contacts.id) (max 16 chars) */
|
|
732
|
+
contactId: string;
|
|
733
|
+
/** P21 company ID (max 8 chars) */
|
|
734
|
+
companyId: string;
|
|
735
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
736
|
+
shipToId: number;
|
|
737
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
738
|
+
rowStatusFlag: number;
|
|
739
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
740
|
+
dateCreated: string;
|
|
741
|
+
/** P21 user who created the row (max 255 chars) */
|
|
742
|
+
createdBy: string;
|
|
743
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
744
|
+
dateLastModified: string;
|
|
745
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
746
|
+
lastMaintainedBy: string;
|
|
747
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
748
|
+
updateCd: number;
|
|
749
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
750
|
+
processCd: number;
|
|
751
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
752
|
+
statusCd: number;
|
|
753
|
+
[key: string]: unknown;
|
|
754
|
+
}
|
|
755
|
+
/** Returned by: api.customers.contactsXShipTo.list(params) */
|
|
756
|
+
export type ContactsXShipToListData = ContactsXShipToListItem[];
|
|
757
|
+
/**
|
|
758
|
+
* Get Contacts X Ship To
|
|
759
|
+
* Response data for GET /contacts-x-ship-to/{contactsXShipToUid} — MINIMUM fields, extras pass
|
|
760
|
+
* through
|
|
761
|
+
*
|
|
762
|
+
* Returned by: api.customers.contactsXShipTo.get(contactsXShipToUid)
|
|
763
|
+
*/
|
|
764
|
+
export type ContactsXShipToGetData = ContactsXShipToListItem;
|
|
765
|
+
/**
|
|
766
|
+
* Get Contacts
|
|
767
|
+
* Response data for GET /contacts/{id} — MINIMUM fields, extras pass through
|
|
768
|
+
*
|
|
769
|
+
* Returned by: api.customers.contacts.get(id)
|
|
770
|
+
*/
|
|
771
|
+
export type ContactsGetData = ContactsListItem;
|
|
772
|
+
/**
|
|
773
|
+
* List Salesrep Customers
|
|
774
|
+
* Response data for GET /contacts/{id}/customers — MINIMUM fields, extras pass through
|
|
775
|
+
*
|
|
776
|
+
* Returned by: api.customers.contacts.customers.list(id, params) (array items)
|
|
777
|
+
* Returned by: api.customers.customer.list(params) (array items)
|
|
778
|
+
* Returned by: api.customers.customer.doc.list(customerId)
|
|
779
|
+
*/
|
|
780
|
+
export interface ContactsCustomersListItem {
|
|
781
|
+
/** Prophet 21 customer ID */
|
|
782
|
+
customerId: number;
|
|
783
|
+
/** Prophet 21 company (max 8 chars) */
|
|
784
|
+
companyId: string;
|
|
785
|
+
/** Customer name (max 255 chars) */
|
|
786
|
+
customerName: string | null;
|
|
787
|
+
/** Customer class 1 */
|
|
788
|
+
class1Id: string | null;
|
|
789
|
+
/** Customer class 2 */
|
|
790
|
+
class2Id: string | null;
|
|
791
|
+
/** Customer class 3 */
|
|
792
|
+
class3Id: string | null;
|
|
793
|
+
/** Customer class 4 */
|
|
794
|
+
class4Id: string | null;
|
|
795
|
+
/** Customer class 5 */
|
|
796
|
+
class5Id: string | null;
|
|
797
|
+
/** Y when the customer may order on the web (max 1 chars) */
|
|
798
|
+
webEnabledFlag: string;
|
|
799
|
+
/** Y when the customer is deleted in Prophet 21 (max 1 chars) */
|
|
800
|
+
deleteFlag: string;
|
|
801
|
+
/** Prophet 21 contact ID of the customer's salesrep */
|
|
802
|
+
salesRepId: string | null;
|
|
803
|
+
/** Y when orders require a purchase order number (max 1 chars) */
|
|
804
|
+
poNoRequired: string;
|
|
805
|
+
/** Prophet 21 payment terms (max 2 chars) */
|
|
806
|
+
termsId: string | null;
|
|
807
|
+
/** Payment terms description; empty when the customer has no terms */
|
|
808
|
+
termsDesc: string;
|
|
809
|
+
/** Y when the customer is taxable (max 1 chars) */
|
|
810
|
+
taxableFlag: string;
|
|
811
|
+
/** Augur status code */
|
|
812
|
+
statusCd: number;
|
|
813
|
+
/** Y when the customer uses job pricing (max 1 chars) */
|
|
814
|
+
jobPricing: string;
|
|
815
|
+
/**
|
|
816
|
+
* Prophet 21 user-defined fields keyed by field name; [] when the customer has none ([] when
|
|
817
|
+
* empty)
|
|
818
|
+
*/
|
|
819
|
+
userDefined: Record<string, unknown> | [];
|
|
820
|
+
[key: string]: unknown;
|
|
821
|
+
}
|
|
822
|
+
/** Returned by: api.customers.contacts.customers.list(id, params) */
|
|
823
|
+
export type ContactsCustomersListData = ContactsCustomersListItem[];
|
|
824
|
+
/**
|
|
825
|
+
* Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
|
|
826
|
+
* The contact's address
|
|
827
|
+
*
|
|
828
|
+
* Field `address` of ContactsDocListData
|
|
829
|
+
*/
|
|
830
|
+
export interface ContactsDocListDataAddress {
|
|
831
|
+
/** Prophet 21 address ID */
|
|
832
|
+
id: number;
|
|
833
|
+
/** Physical address line 1 (max 50 chars) */
|
|
834
|
+
physAddress1: string | null;
|
|
835
|
+
/** Physical address line 2 (max 50 chars) */
|
|
836
|
+
physAddress2: string | null;
|
|
837
|
+
/** Physical city (max 50 chars) */
|
|
838
|
+
physCity: string | null;
|
|
839
|
+
/** Physical state or province (max 50 chars) */
|
|
840
|
+
physState: string | null;
|
|
841
|
+
/** Physical postal code (max 10 chars) */
|
|
842
|
+
physPostalCode: string | null;
|
|
843
|
+
/** Physical country (max 50 chars) */
|
|
844
|
+
physCountry: string | null;
|
|
845
|
+
/** Mailing address line 1 (max 50 chars) */
|
|
846
|
+
mailAddress1: string | null;
|
|
847
|
+
/** Mailing address line 2 (max 50 chars) */
|
|
848
|
+
mailAddress2: string | null;
|
|
849
|
+
/** Mailing city (max 50 chars) */
|
|
850
|
+
mailCity: string | null;
|
|
851
|
+
/** Mailing state or province (max 50 chars) */
|
|
852
|
+
mailState: string | null;
|
|
853
|
+
/** Mailing postal code (max 10 chars) */
|
|
854
|
+
mailPostalCode: string | null;
|
|
855
|
+
/** Mailing country (max 50 chars) */
|
|
856
|
+
mailCountry: string | null;
|
|
857
|
+
[key: string]: unknown;
|
|
858
|
+
}
|
|
859
|
+
/**
|
|
860
|
+
* get the contact document
|
|
861
|
+
* Response data for GET /contacts/{id}/doc — MINIMUM fields, extras pass through
|
|
862
|
+
*
|
|
863
|
+
* Returned by: api.customers.contacts.doc.list(id)
|
|
864
|
+
*/
|
|
865
|
+
export interface ContactsDocListData {
|
|
866
|
+
/** Prophet 21 contact ID (max 16 chars) */
|
|
867
|
+
id: string;
|
|
868
|
+
/** First name (max 15 chars) */
|
|
869
|
+
firstName: string;
|
|
870
|
+
/** Last name (max 24 chars) */
|
|
871
|
+
lastName: string;
|
|
872
|
+
/** Email address (max 255 chars) */
|
|
873
|
+
emailAddress: string | null;
|
|
874
|
+
/** Direct phone number (max 20 chars) */
|
|
875
|
+
directPhone: string | null;
|
|
876
|
+
/** Contact role */
|
|
877
|
+
contactRoleUid: number | null;
|
|
878
|
+
/** Contact class 1 */
|
|
879
|
+
class1Id: string | null;
|
|
880
|
+
/** Contact class 2 */
|
|
881
|
+
class2Id: string | null;
|
|
882
|
+
/** Contact class 3 */
|
|
883
|
+
class3Id: string | null;
|
|
884
|
+
/** Contact class 4 */
|
|
885
|
+
class4Id: string | null;
|
|
886
|
+
/** Contact class 5 */
|
|
887
|
+
class5Id: string | null;
|
|
888
|
+
/** Prophet 21 address the contact belongs to */
|
|
889
|
+
addressId: number;
|
|
890
|
+
/** Default location when the contact is a salesrep */
|
|
891
|
+
salesrepDefaultLocationId: number | null;
|
|
892
|
+
/** The contact's address */
|
|
893
|
+
address: ContactsDocListDataAddress;
|
|
894
|
+
[key: string]: unknown;
|
|
895
|
+
}
|
|
896
|
+
/**
|
|
897
|
+
* Get the web allowance for a contact_id (USCCO)
|
|
898
|
+
* Response data for GET /contacts/{id}/web-allowance — MINIMUM fields, extras pass through
|
|
899
|
+
*
|
|
900
|
+
* Returned by: api.customers.contacts.webAllowance.list(id)
|
|
901
|
+
*/
|
|
902
|
+
export interface ContactsWebAllowanceListData {
|
|
903
|
+
/**
|
|
904
|
+
* Allowance left in the period; 0 when the customer has no allowance period (orderStartDate null)
|
|
905
|
+
*/
|
|
906
|
+
webAllowance: number;
|
|
907
|
+
/**
|
|
908
|
+
* Start of the allowance period (Y-m-d), from the customer's class 5 fiscal-month code; null when
|
|
909
|
+
* it has none
|
|
910
|
+
*/
|
|
911
|
+
orderStartDate: string | null;
|
|
912
|
+
/** Prophet 21 contact ID */
|
|
913
|
+
id: string;
|
|
914
|
+
/** Prophet 21 customer the contact orders for */
|
|
915
|
+
customerId: number;
|
|
916
|
+
[key: string]: unknown;
|
|
917
|
+
}
|
|
918
|
+
/**
|
|
919
|
+
* list the customer documents
|
|
920
|
+
* Response data for GET /customer — MINIMUM fields, extras pass through
|
|
921
|
+
*
|
|
922
|
+
* Returned by: api.customers.customer.list(params) (array items)
|
|
923
|
+
*/
|
|
924
|
+
export type CustomerListItem = ContactsCustomersListItem;
|
|
925
|
+
/** Returned by: api.customers.customer.list(params) */
|
|
926
|
+
export type CustomerListData = CustomerListItem[];
|
|
927
|
+
/**
|
|
928
|
+
* List Customer Language Rows
|
|
929
|
+
* Response data for GET /customer-language — MINIMUM fields, extras pass through
|
|
930
|
+
*
|
|
931
|
+
* Returned by: api.customers.customerLanguage.list(params) (array items)
|
|
932
|
+
* Returned by: api.customers.customerLanguage.get(customerLanguageUid)
|
|
933
|
+
*/
|
|
934
|
+
export interface CustomerLanguageListItem {
|
|
935
|
+
/** Unique ID of the customer language row */
|
|
936
|
+
customerLanguageUid: number;
|
|
937
|
+
/** P21 company ID (max 8 chars) */
|
|
938
|
+
companyId: string;
|
|
939
|
+
/** P21 customer ID (customer.customer_id) */
|
|
940
|
+
customerId: number;
|
|
941
|
+
/** P21 language ID (language.language_id) (max 8 chars) */
|
|
942
|
+
languageId: string;
|
|
943
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
944
|
+
dateCreated: string;
|
|
945
|
+
/** P21 user who created the row (max 255 chars) */
|
|
946
|
+
createdBy: string;
|
|
947
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
948
|
+
dateLastModified: string;
|
|
949
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
950
|
+
lastMaintainedBy: string;
|
|
951
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
952
|
+
updateCd: number;
|
|
953
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
954
|
+
processCd: number;
|
|
955
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
956
|
+
statusCd: number;
|
|
957
|
+
[key: string]: unknown;
|
|
958
|
+
}
|
|
959
|
+
/** Returned by: api.customers.customerLanguage.list(params) */
|
|
960
|
+
export type CustomerLanguageListData = CustomerLanguageListItem[];
|
|
961
|
+
/**
|
|
962
|
+
* Get Customer Language
|
|
963
|
+
* Response data for GET /customer-language/{customerLanguageUid} — MINIMUM fields, extras pass
|
|
964
|
+
* through
|
|
965
|
+
*
|
|
966
|
+
* Returned by: api.customers.customerLanguage.get(customerLanguageUid)
|
|
967
|
+
*/
|
|
968
|
+
export type CustomerLanguageGetData = CustomerLanguageListItem;
|
|
969
|
+
/**
|
|
970
|
+
* List Customer Ud Rows
|
|
971
|
+
* Response data for GET /customer-ud — MINIMUM fields, extras pass through
|
|
972
|
+
*
|
|
973
|
+
* Returned by: api.customers.customerUd.list(params) (array items)
|
|
974
|
+
* Returned by: api.customers.customerUd.get(customerUdUid)
|
|
975
|
+
*/
|
|
976
|
+
export interface CustomerUdListItem {
|
|
977
|
+
/** Unique ID of the customer user-defined row */
|
|
978
|
+
customerUdUid: number;
|
|
979
|
+
/** P21 customer ID (customer.customer_id) */
|
|
980
|
+
customerId: number;
|
|
981
|
+
/** P21 company ID (max 8 chars) */
|
|
982
|
+
companyId: string;
|
|
983
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
984
|
+
dateCreated: string;
|
|
985
|
+
/** P21 user who created the row (max 255 chars) */
|
|
986
|
+
createdBy: string;
|
|
987
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
988
|
+
dateLastModified: string;
|
|
989
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
990
|
+
lastMaintainedBy: string;
|
|
991
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
992
|
+
updateCd: number;
|
|
993
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
994
|
+
processCd: number;
|
|
995
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
996
|
+
statusCd: number;
|
|
997
|
+
/** P21 user-defined data for the row */
|
|
998
|
+
userData: string | null;
|
|
999
|
+
[key: string]: unknown;
|
|
1000
|
+
}
|
|
1001
|
+
/** Returned by: api.customers.customerUd.list(params) */
|
|
1002
|
+
export type CustomerUdListData = CustomerUdListItem[];
|
|
1003
|
+
/**
|
|
1004
|
+
* Get Customer Ud
|
|
1005
|
+
* Response data for GET /customer-ud/{customerUdUid} — MINIMUM fields, extras pass through
|
|
1006
|
+
*
|
|
1007
|
+
* Returned by: api.customers.customerUd.get(customerUdUid)
|
|
1008
|
+
*/
|
|
1009
|
+
export type CustomerUdGetData = CustomerUdListItem;
|
|
1010
|
+
/**
|
|
1011
|
+
* List Customer X Restricted Class Rows
|
|
1012
|
+
* Response data for GET /customer-x-restricted-class — MINIMUM fields, extras pass through
|
|
1013
|
+
*
|
|
1014
|
+
* Returned by: api.customers.customerXRestrictedClass.list(params) (array items)
|
|
1015
|
+
* Returned by: api.customers.customerXRestrictedClass.get(customerXRestrictedClassUid)
|
|
1016
|
+
*/
|
|
1017
|
+
export interface CustomerXRestrictedClassListItem {
|
|
1018
|
+
/** Unique ID of the customer restricted class row */
|
|
1019
|
+
customerXRestrictedClassUid: number;
|
|
1020
|
+
/** P21 customer ID (customer.customer_id) */
|
|
1021
|
+
customerId: number;
|
|
1022
|
+
/** P21 company ID (max 8 chars) */
|
|
1023
|
+
companyId: string;
|
|
1024
|
+
/** Restricted class UID (restricted_class.restricted_class_uid) */
|
|
1025
|
+
restrictedClassUid: number;
|
|
1026
|
+
/** Certification number for the restricted class (max 255 chars) */
|
|
1027
|
+
certificationNo: string | null;
|
|
1028
|
+
/** When the restricted class certification expires (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1029
|
+
expirationDate: string | null;
|
|
1030
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1031
|
+
dateCreated: string;
|
|
1032
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1033
|
+
createdBy: string;
|
|
1034
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1035
|
+
dateLastModified: string;
|
|
1036
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1037
|
+
lastMaintainedBy: string;
|
|
1038
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1039
|
+
rowStatusFlag: number;
|
|
1040
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1041
|
+
updateCd: number;
|
|
1042
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1043
|
+
processCd: number;
|
|
1044
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1045
|
+
statusCd: number;
|
|
1046
|
+
[key: string]: unknown;
|
|
1047
|
+
}
|
|
1048
|
+
/** Returned by: api.customers.customerXRestrictedClass.list(params) */
|
|
1049
|
+
export type CustomerXRestrictedClassListData = CustomerXRestrictedClassListItem[];
|
|
1050
|
+
/**
|
|
1051
|
+
* Get Customer X Restricted Class
|
|
1052
|
+
* Response data for GET /customer-x-restricted-class/{customerXRestrictedClassUid} — MINIMUM
|
|
1053
|
+
* fields, extras pass through
|
|
1054
|
+
*
|
|
1055
|
+
* Returned by: api.customers.customerXRestrictedClass.get(customerXRestrictedClassUid)
|
|
1056
|
+
*/
|
|
1057
|
+
export type CustomerXRestrictedClassGetData = CustomerXRestrictedClassListItem;
|
|
1058
|
+
/**
|
|
1059
|
+
* List Customer X Rewards Program Rows
|
|
1060
|
+
* Response data for GET /customer-x-rewards-program — MINIMUM fields, extras pass through
|
|
1061
|
+
*
|
|
1062
|
+
* Returned by: api.customers.customerXRewardsProgram.list(params) (array items)
|
|
1063
|
+
* Returned by: api.customers.customerXRewardsProgram.get(customerXRewardsProgramUid)
|
|
1064
|
+
* Returned by: api.customers.customer.rewardsPrograms.list(customerId, params) (array items)
|
|
1065
|
+
*/
|
|
1066
|
+
export interface CustomerXRewardsProgramListItem {
|
|
1067
|
+
/** Unique ID of the customer rewards program enrollment row */
|
|
1068
|
+
customerXRewardsProgramUid: number;
|
|
1069
|
+
/** P21 company ID (max 8 chars) */
|
|
1070
|
+
companyId: string;
|
|
1071
|
+
/** P21 customer ID (customer.customer_id) */
|
|
1072
|
+
customerId: number;
|
|
1073
|
+
/** Rewards program UID (rewards_program.rewards_program_uid) */
|
|
1074
|
+
rewardsProgramUid: number;
|
|
1075
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1076
|
+
rowStatusFlag: number;
|
|
1077
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1078
|
+
dateCreated: string;
|
|
1079
|
+
/** P21 user who created the row (max 255 chars) */
|
|
1080
|
+
createdBy: string;
|
|
1081
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1082
|
+
dateLastModified: string;
|
|
1083
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
1084
|
+
lastMaintainedBy: string;
|
|
1085
|
+
/**
|
|
1086
|
+
* When the enrollment takes effect in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30
|
|
1087
|
+
* 15:50:49)
|
|
1088
|
+
*/
|
|
1089
|
+
effectiveDate: string;
|
|
1090
|
+
/** P21 invoiced co-op dollar basis for this enrollment */
|
|
1091
|
+
invoicedCoopDollarBasis: number;
|
|
1092
|
+
/** P21 invoiced incentive points basis for this enrollment */
|
|
1093
|
+
invoicedIncentivePointsBasis: number;
|
|
1094
|
+
/** P21 exclude flag (Y or N); null when P21 has none (max 1 chars) */
|
|
1095
|
+
excludeFlag: string | null;
|
|
1096
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1097
|
+
processCd: number;
|
|
1098
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1099
|
+
statusCd: number;
|
|
1100
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
1101
|
+
updateCd: number;
|
|
1102
|
+
[key: string]: unknown;
|
|
1103
|
+
}
|
|
1104
|
+
/** Returned by: api.customers.customerXRewardsProgram.list(params) */
|
|
1105
|
+
export type CustomerXRewardsProgramListData = CustomerXRewardsProgramListItem[];
|
|
1106
|
+
/**
|
|
1107
|
+
* Get Customer X Rewards Program
|
|
1108
|
+
* Response data for GET /customer-x-rewards-program/{customerXRewardsProgramUid} — MINIMUM fields,
|
|
1109
|
+
* extras pass through
|
|
1110
|
+
*
|
|
1111
|
+
* Returned by: api.customers.customerXRewardsProgram.get(customerXRewardsProgramUid)
|
|
1112
|
+
*/
|
|
1113
|
+
export type CustomerXRewardsProgramGetData = CustomerXRewardsProgramListItem;
|
|
1114
|
+
/**
|
|
1115
|
+
* lookup Customer Summary
|
|
1116
|
+
* Response data for GET /customer/lookup — MINIMUM fields, extras pass through
|
|
1117
|
+
*
|
|
1118
|
+
* Returned by: api.customers.customer.lookup.get(params) (array items)
|
|
1119
|
+
*/
|
|
1120
|
+
export interface CustomerLookupGetItem {
|
|
1121
|
+
/** Prophet 21 customer ID */
|
|
1122
|
+
customerId: number;
|
|
1123
|
+
/** Customer name (max 255 chars) */
|
|
1124
|
+
customerName: string | null;
|
|
1125
|
+
[key: string]: unknown;
|
|
1126
|
+
}
|
|
1127
|
+
/** Returned by: api.customers.customer.lookup.get(params) */
|
|
1128
|
+
export type CustomerLookupGetData = CustomerLookupGetItem[];
|
|
1129
|
+
/**
|
|
1130
|
+
* Lookup Customer Addresses
|
|
1131
|
+
* Response data for GET /customer/{customerId}/address — MINIMUM fields, extras pass through
|
|
1132
|
+
*
|
|
1133
|
+
* Returned by: api.customers.customer.address.list(customerId, params) (array items)
|
|
1134
|
+
*/
|
|
1135
|
+
export interface CustomerAddressListItem {
|
|
1136
|
+
/** Prophet 21 address (ship-to) ID */
|
|
1137
|
+
id: number;
|
|
1138
|
+
/** Address name (max 50 chars) */
|
|
1139
|
+
name: string;
|
|
1140
|
+
/** Mailing address line 1 (max 50 chars) */
|
|
1141
|
+
mailAddress1: string;
|
|
1142
|
+
/** Mailing address line 2 (max 50 chars) */
|
|
1143
|
+
mailAddress2: string | null;
|
|
1144
|
+
/** Mailing city (max 50 chars) */
|
|
1145
|
+
mailCity: string | null;
|
|
1146
|
+
/** Mailing state or province (max 50 chars) */
|
|
1147
|
+
mailState: string | null;
|
|
1148
|
+
/** Mailing postal code (max 10 chars) */
|
|
1149
|
+
mailPostalCode: string | null;
|
|
1150
|
+
/** Mailing country (max 50 chars) */
|
|
1151
|
+
mailCountry: string | null;
|
|
1152
|
+
[key: string]: unknown;
|
|
1153
|
+
}
|
|
1154
|
+
/** Returned by: api.customers.customer.address.list(customerId, params) */
|
|
1155
|
+
export type CustomerAddressListData = CustomerAddressListItem[];
|
|
1156
|
+
/**
|
|
1157
|
+
* List customer addresses
|
|
1158
|
+
* Response data for GET /customer/{customerId}/addresses — MINIMUM fields, extras pass through
|
|
1159
|
+
*
|
|
1160
|
+
* Returned by: api.customers.customer.addresses.list(customerId, params) (array items)
|
|
1161
|
+
* Returned by: api.customers.customer.addresses.create(customerId, data)
|
|
1162
|
+
* Returned by: api.customers.customer.addresses.get(customerId, customerAddressUid)
|
|
1163
|
+
* Returned by: api.customers.customer.addresses.update(customerId, customerAddressUid, data)
|
|
1164
|
+
* Returned by: api.customers.customer.addresses.delete(customerId, customerAddressUid)
|
|
1165
|
+
*/
|
|
1166
|
+
export interface CustomerAddressesListItem {
|
|
1167
|
+
/** Customer address ID */
|
|
1168
|
+
customerAddressUid: number;
|
|
1169
|
+
/** Prophet 21 customer the address belongs to */
|
|
1170
|
+
customerId: number;
|
|
1171
|
+
/** Address line 1 (max 50 chars) */
|
|
1172
|
+
address1: string | null;
|
|
1173
|
+
/** Address line 2 (max 50 chars) */
|
|
1174
|
+
address2: string | null;
|
|
1175
|
+
/** Address line 3 (max 50 chars) */
|
|
1176
|
+
address3: string | null;
|
|
1177
|
+
/** City (max 50 chars) */
|
|
1178
|
+
city: string | null;
|
|
1179
|
+
/** State or province (max 50 chars) */
|
|
1180
|
+
state: string | null;
|
|
1181
|
+
/** Postal code (max 10 chars) */
|
|
1182
|
+
postalCode: string | null;
|
|
1183
|
+
/** Country (max 50 chars) */
|
|
1184
|
+
country: string | null;
|
|
1185
|
+
/** Update code (1185 = Import Complete) */
|
|
1186
|
+
updateCd: number;
|
|
1187
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1188
|
+
statusCd: number;
|
|
1189
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
1190
|
+
processCd: number;
|
|
1191
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1192
|
+
dateCreated: string;
|
|
1193
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1194
|
+
dateLastModified: string;
|
|
1195
|
+
/** Email address (max 255 chars) */
|
|
1196
|
+
emailAddress: string | null;
|
|
1197
|
+
/** Address name (max 255 chars) */
|
|
1198
|
+
name: string | null;
|
|
1199
|
+
/** Main phone number (max 20 chars) */
|
|
1200
|
+
phoneNumberMain: string | null;
|
|
1201
|
+
/** Mobile phone number (max 20 chars) */
|
|
1202
|
+
phoneNumberMobile: string | null;
|
|
1203
|
+
[key: string]: unknown;
|
|
1204
|
+
}
|
|
1205
|
+
/** Returned by: api.customers.customer.addresses.list(customerId, params) */
|
|
1206
|
+
export type CustomerAddressesListData = CustomerAddressesListItem[];
|
|
1207
|
+
/**
|
|
1208
|
+
* Create a new customer address
|
|
1209
|
+
* Response data for POST /customer/{customerId}/addresses — MINIMUM fields, extras pass through
|
|
1210
|
+
*
|
|
1211
|
+
* Returned by: api.customers.customer.addresses.create(customerId, data)
|
|
1212
|
+
*/
|
|
1213
|
+
export type CustomerAddressesCreateData = CustomerAddressesListItem;
|
|
1214
|
+
/**
|
|
1215
|
+
* Create a new customer address
|
|
1216
|
+
* Request body for POST /customer/{customerId}/addresses — MINIMUM fields, extras pass through
|
|
1217
|
+
*
|
|
1218
|
+
* Request body of: api.customers.customer.addresses.create(customerId, data)
|
|
1219
|
+
*/
|
|
1220
|
+
export interface CustomerAddressesCreateBody {
|
|
1221
|
+
/** Address line 1 */
|
|
1222
|
+
address1?: string | null;
|
|
1223
|
+
/** Address line 2 */
|
|
1224
|
+
address2?: string | null;
|
|
1225
|
+
/** Address line 3 */
|
|
1226
|
+
address3?: string | null;
|
|
1227
|
+
/** City */
|
|
1228
|
+
city?: string | null;
|
|
1229
|
+
/** State or province */
|
|
1230
|
+
state?: string | null;
|
|
1231
|
+
/** Postal code */
|
|
1232
|
+
postalCode?: string | null;
|
|
1233
|
+
/** Country */
|
|
1234
|
+
country?: string | null;
|
|
1235
|
+
/** Email address */
|
|
1236
|
+
emailAddress?: string | null;
|
|
1237
|
+
/** Address name */
|
|
1238
|
+
name?: string | null;
|
|
1239
|
+
/** Main phone number */
|
|
1240
|
+
phoneNumberMain?: string | null;
|
|
1241
|
+
/** Mobile phone number */
|
|
1242
|
+
phoneNumberMobile?: string | null;
|
|
1243
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704 */
|
|
1244
|
+
statusCd?: number | null;
|
|
1245
|
+
/** Process code; defaults to 704 (Active) */
|
|
1246
|
+
processCd?: number | null;
|
|
1247
|
+
/** Update code; defaults to 1185 (Import Complete) */
|
|
1248
|
+
updateCd?: number | null;
|
|
1249
|
+
[key: string]: unknown;
|
|
1250
|
+
}
|
|
1251
|
+
/**
|
|
1252
|
+
* Get a customer address
|
|
1253
|
+
* Response data for GET /customer/{customerId}/addresses/{customerAddressUid} — MINIMUM fields,
|
|
1254
|
+
* extras pass through
|
|
1255
|
+
*
|
|
1256
|
+
* Returned by: api.customers.customer.addresses.get(customerId, customerAddressUid)
|
|
1257
|
+
*/
|
|
1258
|
+
export type CustomerAddressesGetData = CustomerAddressesListItem;
|
|
1259
|
+
/**
|
|
1260
|
+
* Update a customer address
|
|
1261
|
+
* Response data for PUT /customer/{customerId}/addresses/{customerAddressUid} — MINIMUM fields,
|
|
1262
|
+
* extras pass through
|
|
1263
|
+
*
|
|
1264
|
+
* Returned by: api.customers.customer.addresses.update(customerId, customerAddressUid, data)
|
|
1265
|
+
*/
|
|
1266
|
+
export type CustomerAddressesUpdateData = CustomerAddressesListItem;
|
|
1267
|
+
/**
|
|
1268
|
+
* Update a customer address
|
|
1269
|
+
* Request body for PUT /customer/{customerId}/addresses/{customerAddressUid} — MINIMUM fields,
|
|
1270
|
+
* extras pass through
|
|
1271
|
+
*
|
|
1272
|
+
* Request body of: api.customers.customer.addresses.update(customerId, customerAddressUid, data)
|
|
1273
|
+
*/
|
|
1274
|
+
export interface CustomerAddressesUpdateBody {
|
|
1275
|
+
/** Address line 1 */
|
|
1276
|
+
address1?: string | null;
|
|
1277
|
+
/** Address line 2 */
|
|
1278
|
+
address2?: string | null;
|
|
1279
|
+
/** Address line 3 */
|
|
1280
|
+
address3?: string | null;
|
|
1281
|
+
/** City */
|
|
1282
|
+
city?: string | null;
|
|
1283
|
+
/** State or province */
|
|
1284
|
+
state?: string | null;
|
|
1285
|
+
/** Postal code */
|
|
1286
|
+
postalCode?: string | null;
|
|
1287
|
+
/** Country */
|
|
1288
|
+
country?: string | null;
|
|
1289
|
+
/** Email address */
|
|
1290
|
+
emailAddress?: string | null;
|
|
1291
|
+
/** Address name */
|
|
1292
|
+
name?: string | null;
|
|
1293
|
+
/** Main phone number */
|
|
1294
|
+
phoneNumberMain?: string | null;
|
|
1295
|
+
/** Mobile phone number */
|
|
1296
|
+
phoneNumberMobile?: string | null;
|
|
1297
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1298
|
+
statusCd?: number | null;
|
|
1299
|
+
/** Process code */
|
|
1300
|
+
processCd?: number | null;
|
|
1301
|
+
[key: string]: unknown;
|
|
1302
|
+
}
|
|
1303
|
+
/**
|
|
1304
|
+
* Soft-delete a customer address
|
|
1305
|
+
* Response data for DELETE /customer/{customerId}/addresses/{customerAddressUid} — MINIMUM fields,
|
|
1306
|
+
* extras pass through
|
|
1307
|
+
*
|
|
1308
|
+
* Returned by: api.customers.customer.addresses.delete(customerId, customerAddressUid)
|
|
1309
|
+
*/
|
|
1310
|
+
export type CustomerAddressesDeleteData = CustomerAddressesListItem;
|
|
1311
|
+
/**
|
|
1312
|
+
* Shape of `totals` (MINIMUM fields; reused wherever the same shape appears)
|
|
1313
|
+
* Balance and invoice count per bucket, in bucketKeys order
|
|
1314
|
+
*
|
|
1315
|
+
* Field `totals` of CustomerAgingListData
|
|
1316
|
+
*/
|
|
1317
|
+
export interface CustomerAgingListDataTotalsItem {
|
|
1318
|
+
/** Bucket key, one of the response's bucketKeys */
|
|
1319
|
+
key: string;
|
|
1320
|
+
/** Outstanding balance of the invoices in the bucket */
|
|
1321
|
+
balance: number;
|
|
1322
|
+
/** Number of invoices in the bucket */
|
|
1323
|
+
invoices: number;
|
|
1324
|
+
[key: string]: unknown;
|
|
1325
|
+
}
|
|
1326
|
+
/**
|
|
1327
|
+
* Shape of `data` (MINIMUM fields; reused wherever the same shape appears)
|
|
1328
|
+
* The requested page of outstanding invoices
|
|
1329
|
+
*
|
|
1330
|
+
* Field `data` of CustomerAgingListData
|
|
1331
|
+
*/
|
|
1332
|
+
export interface CustomerAgingListDataDataItem {
|
|
1333
|
+
/** Prophet 21 invoice number (max 10 chars) */
|
|
1334
|
+
invoiceNo: string;
|
|
1335
|
+
/** Order the invoice was raised for (max 8 chars) */
|
|
1336
|
+
orderNo: string | null;
|
|
1337
|
+
/** Customer purchase order number (max 255 chars) */
|
|
1338
|
+
poNo: string | null;
|
|
1339
|
+
/** Ship-to name (max 50 chars) */
|
|
1340
|
+
ship2Name: string | null;
|
|
1341
|
+
/** Invoice date the age is measured from (Y-m-d) */
|
|
1342
|
+
invoiceDate: string;
|
|
1343
|
+
/** Invoice total */
|
|
1344
|
+
totalAmount: number;
|
|
1345
|
+
/** Amount paid so far */
|
|
1346
|
+
amountPaid: number;
|
|
1347
|
+
/** Amount still owed: totalAmount - amountPaid */
|
|
1348
|
+
balance: number;
|
|
1349
|
+
/** Whole days from invoiceDate to the as-of date */
|
|
1350
|
+
ageDays: number;
|
|
1351
|
+
/** Aging bucket key the invoice falls in */
|
|
1352
|
+
bucket: string;
|
|
1353
|
+
[key: string]: unknown;
|
|
1354
|
+
}
|
|
1355
|
+
/**
|
|
1356
|
+
* Customer Invoice Aging
|
|
1357
|
+
* Response data for GET /customer/{customerId}/aging — MINIMUM fields, extras pass through
|
|
1358
|
+
*
|
|
1359
|
+
* Returned by: api.customers.customer.aging.list(customerId, params)
|
|
1360
|
+
*/
|
|
1361
|
+
export interface CustomerAgingListData {
|
|
1362
|
+
/** Prophet 21 customer the report is for */
|
|
1363
|
+
customerId: string;
|
|
1364
|
+
/** Date the ages are measured to (Y-m-d) */
|
|
1365
|
+
asOf: string;
|
|
1366
|
+
/** Bucket keys in display order */
|
|
1367
|
+
bucketKeys: string[];
|
|
1368
|
+
/** Number of outstanding invoices across every bucket */
|
|
1369
|
+
invoiceCount: number;
|
|
1370
|
+
/** Outstanding balance across every bucket */
|
|
1371
|
+
totalBalance: number;
|
|
1372
|
+
/** Balance and invoice count per bucket, in bucketKeys order */
|
|
1373
|
+
totals: CustomerAgingListDataTotalsItem[];
|
|
1374
|
+
/** The requested page of outstanding invoices */
|
|
1375
|
+
data: CustomerAgingListDataDataItem[];
|
|
1376
|
+
[key: string]: unknown;
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* Lookup Customer Contacts
|
|
1380
|
+
* Response data for GET /customer/{customerId}/contacts — MINIMUM fields, extras pass through
|
|
1381
|
+
*
|
|
1382
|
+
* Returned by: api.customers.customer.contacts.list(customerId, params) (array items)
|
|
1383
|
+
*/
|
|
1384
|
+
export interface CustomerContactsListItem {
|
|
1385
|
+
/** Prophet 21 contact ID (max 16 chars) */
|
|
1386
|
+
id: string;
|
|
1387
|
+
/** Email address (max 255 chars) */
|
|
1388
|
+
emailAddress: string | null;
|
|
1389
|
+
/** First name (max 15 chars) */
|
|
1390
|
+
firstName: string;
|
|
1391
|
+
/** Last name (max 24 chars) */
|
|
1392
|
+
lastName: string;
|
|
1393
|
+
/** Job title (max 40 chars) */
|
|
1394
|
+
title: string | null;
|
|
1395
|
+
/** Direct phone number */
|
|
1396
|
+
phone: string | null;
|
|
1397
|
+
/** Phone extension */
|
|
1398
|
+
ext: string | null;
|
|
1399
|
+
/** Mobile phone number (max 20 chars) */
|
|
1400
|
+
cellular: string | null;
|
|
1401
|
+
/** Prophet 21 address the contact belongs to */
|
|
1402
|
+
addressId: number;
|
|
1403
|
+
/** Class 5 of the contact's address */
|
|
1404
|
+
addressClass5Id: string | null;
|
|
1405
|
+
[key: string]: unknown;
|
|
1406
|
+
}
|
|
1407
|
+
/** Returned by: api.customers.customer.contacts.list(customerId, params) */
|
|
1408
|
+
export type CustomerContactsListData = CustomerContactsListItem[];
|
|
1409
|
+
/**
|
|
1410
|
+
* Create new contact for customer_id
|
|
1411
|
+
* Response data for POST /customer/{customerId}/contacts — MINIMUM fields, extras pass through
|
|
1412
|
+
*
|
|
1413
|
+
* Returned by: api.customers.customer.contacts.create(customerId, data)
|
|
1414
|
+
*/
|
|
1415
|
+
export type CustomerContactsCreateData = boolean;
|
|
1416
|
+
/**
|
|
1417
|
+
* Create new contact for customer_id
|
|
1418
|
+
* Request body for POST /customer/{customerId}/contacts — MINIMUM fields, extras pass through
|
|
1419
|
+
*
|
|
1420
|
+
* Request body of: api.customers.customer.contacts.create(customerId, data)
|
|
1421
|
+
*/
|
|
1422
|
+
export interface CustomerContactsCreateBody {
|
|
1423
|
+
/** P21 ContactLeadSource fields ([] when empty) */
|
|
1424
|
+
contactLeadSources?: Record<string, unknown> | [] | null;
|
|
1425
|
+
/** P21 ContactLink fields ([] when empty) */
|
|
1426
|
+
contactLinks?: Record<string, unknown> | [] | null;
|
|
1427
|
+
/** P21 ContactSalesrep fields ([] when empty) */
|
|
1428
|
+
contactSalesreps?: Record<string, unknown> | [] | null;
|
|
1429
|
+
/** P21 user-defined fields keyed by field name ([] when empty) */
|
|
1430
|
+
userDefinedFields?: Record<string, unknown> | [] | null;
|
|
1431
|
+
[key: string]: unknown;
|
|
1432
|
+
}
|
|
1433
|
+
/**
|
|
1434
|
+
* get the customer document
|
|
1435
|
+
* Response data for GET /customer/{customerId}/doc — MINIMUM fields, extras pass through
|
|
1436
|
+
*
|
|
1437
|
+
* Returned by: api.customers.customer.doc.list(customerId)
|
|
1438
|
+
*/
|
|
1439
|
+
export type CustomerDocListData = ContactsCustomersListItem;
|
|
1440
|
+
/**
|
|
1441
|
+
* Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
|
|
1442
|
+
* Invoice lines
|
|
1443
|
+
*
|
|
1444
|
+
* Field `lines` of CustomerInvoicesListItem
|
|
1445
|
+
*/
|
|
1446
|
+
export interface CustomerInvoicesListItemLinesItem {
|
|
1447
|
+
/** Invoice line number */
|
|
1448
|
+
lineNo: number;
|
|
1449
|
+
/** Item (inv_mast) on the line; null for a non-stock line */
|
|
1450
|
+
invMastUid: number | null;
|
|
1451
|
+
/** Item ID (max 40 chars) */
|
|
1452
|
+
itemId: string | null;
|
|
1453
|
+
/** Item description (max 40 chars) */
|
|
1454
|
+
itemDesc: string;
|
|
1455
|
+
/** Item short code; null when the line has no item */
|
|
1456
|
+
shortCode: string | null;
|
|
1457
|
+
/** Unit of measure (max 10 chars) */
|
|
1458
|
+
unitOfMeasure: string | null;
|
|
1459
|
+
/** Unit price */
|
|
1460
|
+
unitPrice: number;
|
|
1461
|
+
/** Extended price */
|
|
1462
|
+
extendedPrice: number;
|
|
1463
|
+
/** Quantity requested */
|
|
1464
|
+
qtyRequested: number;
|
|
1465
|
+
/** Quantity shipped */
|
|
1466
|
+
qtyShipped: number;
|
|
1467
|
+
/** Order the line came from; misspelled duplicate of orderNo, kept for existing consumers */
|
|
1468
|
+
oderNo: string | null;
|
|
1469
|
+
/** Order the line came from (max 8 chars) */
|
|
1470
|
+
orderNo: string | null;
|
|
1471
|
+
/** Order line number the invoice line came from */
|
|
1472
|
+
oeLineNumber: number | null;
|
|
1473
|
+
[key: string]: unknown;
|
|
1474
|
+
}
|
|
1475
|
+
/**
|
|
1476
|
+
* List Customer Invoices
|
|
1477
|
+
* Response data for GET /customer/{customerId}/invoices — MINIMUM fields, extras pass through
|
|
1478
|
+
*
|
|
1479
|
+
* Returned by: api.customers.customer.invoices.list(customerId, params) (array items)
|
|
1480
|
+
* Returned by: api.customers.customer.invoices.get(customerId, invoiceNo)
|
|
1481
|
+
*/
|
|
1482
|
+
export interface CustomerInvoicesListItem {
|
|
1483
|
+
/** Invoice number (max 10 chars) */
|
|
1484
|
+
invoiceNo: string;
|
|
1485
|
+
/** Prophet 21 customer invoiced */
|
|
1486
|
+
customerId: number;
|
|
1487
|
+
/** Customer name */
|
|
1488
|
+
customerName: string | null;
|
|
1489
|
+
/** Order the invoice bills (max 8 chars) */
|
|
1490
|
+
orderNo: string | null;
|
|
1491
|
+
/** Invoice date (Y-m-d) */
|
|
1492
|
+
invoiceDate: string;
|
|
1493
|
+
/** Customer purchase order number (max 255 chars) */
|
|
1494
|
+
poNo: string | null;
|
|
1495
|
+
/** Ship-to name (max 50 chars) */
|
|
1496
|
+
ship2Name: string | null;
|
|
1497
|
+
/** Ship-to contact (max 30 chars) */
|
|
1498
|
+
ship2Contact: string | null;
|
|
1499
|
+
/** Ship-to address line 1 (max 50 chars) */
|
|
1500
|
+
ship2Address1: string | null;
|
|
1501
|
+
/** Ship-to address line 2 (max 50 chars) */
|
|
1502
|
+
ship2Address2: string | null;
|
|
1503
|
+
/** Ship-to address line 3 (max 50 chars) */
|
|
1504
|
+
ship2Address3: string | null;
|
|
1505
|
+
/** Ship-to city (max 50 chars) */
|
|
1506
|
+
ship2City: string | null;
|
|
1507
|
+
/** Ship-to state or province (max 50 chars) */
|
|
1508
|
+
ship2State: string | null;
|
|
1509
|
+
/** Ship-to postal code (max 10 chars) */
|
|
1510
|
+
ship2PostalCode: string | null;
|
|
1511
|
+
/** Ship-to country (max 50 chars) */
|
|
1512
|
+
ship2Country: string | null;
|
|
1513
|
+
/** Ship-to email address (max 255 chars) */
|
|
1514
|
+
ship2EmailAddress: string | null;
|
|
1515
|
+
/** Ship-to phone number (max 20 chars) */
|
|
1516
|
+
shipToPhone: string | null;
|
|
1517
|
+
/** Bill-to name (max 50 chars) */
|
|
1518
|
+
bill2Name: string | null;
|
|
1519
|
+
/** Bill-to contact (max 30 chars) */
|
|
1520
|
+
bill2Contact: string | null;
|
|
1521
|
+
/** Bill-to address line 1 (max 50 chars) */
|
|
1522
|
+
bill2Address1: string | null;
|
|
1523
|
+
/** Bill-to address line 2 (max 50 chars) */
|
|
1524
|
+
bill2Address2: string | null;
|
|
1525
|
+
/** Bill-to address line 3 (max 50 chars) */
|
|
1526
|
+
bill2Address3: string | null;
|
|
1527
|
+
/** Bill-to city (max 50 chars) */
|
|
1528
|
+
bill2City: string | null;
|
|
1529
|
+
/** Bill-to state or province (max 50 chars) */
|
|
1530
|
+
bill2State: string | null;
|
|
1531
|
+
/** Bill-to postal code (max 10 chars) */
|
|
1532
|
+
bill2PostalCode: string | null;
|
|
1533
|
+
/** Bill-to country (max 50 chars) */
|
|
1534
|
+
bill2Country: string | null;
|
|
1535
|
+
/** Invoice total */
|
|
1536
|
+
totalAmount: number;
|
|
1537
|
+
/** Amount paid so far */
|
|
1538
|
+
amountPaid: number;
|
|
1539
|
+
/** Y when the invoice is paid in full (max 1 chars) */
|
|
1540
|
+
paidInFullFlag: string | null;
|
|
1541
|
+
/** Tax on the invoice */
|
|
1542
|
+
taxAmount: number;
|
|
1543
|
+
/** Tax paid so far */
|
|
1544
|
+
taxAmountPaid: number;
|
|
1545
|
+
/** Shipping cost */
|
|
1546
|
+
shippingCost: number | null;
|
|
1547
|
+
/** Freight charged */
|
|
1548
|
+
freight: number | null;
|
|
1549
|
+
/** Date the invoice was paid (Y-m-d); null while unpaid */
|
|
1550
|
+
datePaid: string | null;
|
|
1551
|
+
/** Net due date (Y-m-d) */
|
|
1552
|
+
netDueDate: string | null;
|
|
1553
|
+
/** Prophet 21 terms ID (max 2 chars) */
|
|
1554
|
+
termsId: string | null;
|
|
1555
|
+
/** Terms description (max 20 chars) */
|
|
1556
|
+
termsDesc: string | null;
|
|
1557
|
+
/** Prophet 21 invoice adjustment type (document type; C is a credit memo) (max 1 chars) */
|
|
1558
|
+
invoiceAdjustmentType: string | null;
|
|
1559
|
+
/**
|
|
1560
|
+
* Prophet 21 invoice reference number; on a credit memo, the invoice it credits (max 10 chars)
|
|
1561
|
+
*/
|
|
1562
|
+
invoiceReferenceNo: string;
|
|
1563
|
+
/** Invoice lines */
|
|
1564
|
+
lines: CustomerInvoicesListItemLinesItem[];
|
|
1565
|
+
[key: string]: unknown;
|
|
1566
|
+
}
|
|
1567
|
+
/** Returned by: api.customers.customer.invoices.list(customerId, params) */
|
|
1568
|
+
export type CustomerInvoicesListData = CustomerInvoicesListItem[];
|
|
1569
|
+
/**
|
|
1570
|
+
* Get Customer Invoice
|
|
1571
|
+
* Response data for GET /customer/{customerId}/invoices/{invoiceNo} — MINIMUM fields, extras pass
|
|
1572
|
+
* through
|
|
1573
|
+
*
|
|
1574
|
+
* Returned by: api.customers.customer.invoices.get(customerId, invoiceNo)
|
|
1575
|
+
*/
|
|
1576
|
+
export type CustomerInvoicesGetData = CustomerInvoicesListItem;
|
|
1577
|
+
/**
|
|
1578
|
+
* Shape of data nested in CustomerOrdersListData (MINIMUM fields; reused wherever the same shape
|
|
1579
|
+
* appears)
|
|
1580
|
+
*
|
|
1581
|
+
* Nested in CustomerOrdersListData
|
|
1582
|
+
*/
|
|
1583
|
+
export interface CustomerOrdersListDataItemOption2 {
|
|
1584
|
+
/** Prophet 21 order number (max 8 chars) */
|
|
1585
|
+
orderNo: string;
|
|
1586
|
+
/** Unique id of the order header */
|
|
1587
|
+
oeHdrUid: number;
|
|
1588
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1589
|
+
dateCreated: string;
|
|
1590
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1591
|
+
dateLastModified: string;
|
|
1592
|
+
/** Prophet 21 customer the order is for */
|
|
1593
|
+
customerId: number;
|
|
1594
|
+
/** When the order was placed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1595
|
+
orderDate: string | null;
|
|
1596
|
+
/** Customer purchase order number (max 50 chars) */
|
|
1597
|
+
poNo: string | null;
|
|
1598
|
+
/** Y when the order is complete (max 1 chars) */
|
|
1599
|
+
completed: string | null;
|
|
1600
|
+
/** Prophet 21 company (max 8 chars) */
|
|
1601
|
+
companyId: string | null;
|
|
1602
|
+
/** Prophet 21 address id of the carrier */
|
|
1603
|
+
carrierId: number | null;
|
|
1604
|
+
/**
|
|
1605
|
+
* When Augur last checked the order against Prophet 21 (mysql-datetime, e.g. 2025-07-30 15:50:49)
|
|
1606
|
+
*/
|
|
1607
|
+
dateLastChecked: string;
|
|
1608
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
1609
|
+
updateCd: number;
|
|
1610
|
+
/** Web order reference number; null for orders not placed on the web (max 255 chars) */
|
|
1611
|
+
webReferenceNo: string | null;
|
|
1612
|
+
/** Ship-to name (max 50 chars) */
|
|
1613
|
+
ship2Name: string | null;
|
|
1614
|
+
/** Ship-to address line 1 (max 50 chars) */
|
|
1615
|
+
ship2Add1: string | null;
|
|
1616
|
+
/** Ship-to address line 2 (max 50 chars) */
|
|
1617
|
+
ship2Add2: string | null;
|
|
1618
|
+
/** Ship-to city (max 50 chars) */
|
|
1619
|
+
ship2City: string | null;
|
|
1620
|
+
/** Ship-to state or province (max 50 chars) */
|
|
1621
|
+
ship2State: string | null;
|
|
1622
|
+
/** Ship-to postal code (max 10 chars) */
|
|
1623
|
+
ship2Zip: string | null;
|
|
1624
|
+
/** Ship-to country (max 50 chars) */
|
|
1625
|
+
ship2Country: string | null;
|
|
1626
|
+
/** Ship-to email address (max 255 chars) */
|
|
1627
|
+
ship2EmailAddress: string | null;
|
|
1628
|
+
/** Ship-to address line 3 (max 50 chars) */
|
|
1629
|
+
ship2Add3: string | null;
|
|
1630
|
+
/** Ship-to phone number (max 20 chars) */
|
|
1631
|
+
shipToPhone: string | null;
|
|
1632
|
+
/** Prophet 21 location the order ships from */
|
|
1633
|
+
locationId: number | null;
|
|
1634
|
+
/** Delivery instructions for the carrier (max 255 chars) */
|
|
1635
|
+
deliveryInstructions: string | null;
|
|
1636
|
+
/** Y when the order is canceled (max 1 chars) */
|
|
1637
|
+
cancelFlag: string | null;
|
|
1638
|
+
/** Prophet 21 user who took the order (max 30 chars) */
|
|
1639
|
+
taker: string | null;
|
|
1640
|
+
/** Shipping route assigned to the order */
|
|
1641
|
+
shippingRouteUid: number | null;
|
|
1642
|
+
/** Prophet 21 payment terms (max 2 chars) */
|
|
1643
|
+
terms: string | null;
|
|
1644
|
+
/** Y when the order is approved (max 1 chars) */
|
|
1645
|
+
approved: string | null;
|
|
1646
|
+
/** Order class 1 (max 8 chars) */
|
|
1647
|
+
class1id: string | null;
|
|
1648
|
+
/** Order class 2 (max 8 chars) */
|
|
1649
|
+
class2id: string | null;
|
|
1650
|
+
/** Order class 3 (max 8 chars) */
|
|
1651
|
+
class3id: string | null;
|
|
1652
|
+
/** Order class 4 (max 8 chars) */
|
|
1653
|
+
class4id: string | null;
|
|
1654
|
+
/** Order class 5 (max 8 chars) */
|
|
1655
|
+
class5id: string | null;
|
|
1656
|
+
/** Prophet 21 contact who placed the order (max 16 chars) */
|
|
1657
|
+
contactId: string | null;
|
|
1658
|
+
/** Y when the order is projected (not yet firm) (max 1 chars) */
|
|
1659
|
+
projectedOrder: string | null;
|
|
1660
|
+
/** Prophet 21 source code of the order (706 = Order Entry) */
|
|
1661
|
+
sourceCodeNo: number;
|
|
1662
|
+
/** Order priority */
|
|
1663
|
+
orderPriorityUid: number | null;
|
|
1664
|
+
/** Outgoing freight charged on the order */
|
|
1665
|
+
freightOut: number;
|
|
1666
|
+
/** Y when the order is an RMA (max 1 chars) */
|
|
1667
|
+
rmaFlag: string | null;
|
|
1668
|
+
/** When the order was completed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1669
|
+
dateOrderCompleted: string | null;
|
|
1670
|
+
/** Job name (max 40 chars) */
|
|
1671
|
+
jobName: string | null;
|
|
1672
|
+
/** Date the customer requested the order (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1673
|
+
requestedDate: string | null;
|
|
1674
|
+
/** Augur status code of the record */
|
|
1675
|
+
statusCd: number;
|
|
1676
|
+
/** Down payment requested on the order */
|
|
1677
|
+
requestedDownpayment: number | null;
|
|
1678
|
+
/** Y when the down payment has been invoiced (max 1 chars) */
|
|
1679
|
+
downpaymentInvoiced: string | null;
|
|
1680
|
+
/** Order validation status (max 8 chars) */
|
|
1681
|
+
validationStatus: string | null;
|
|
1682
|
+
/** Prophet 21 address of the order */
|
|
1683
|
+
addressId: number | null;
|
|
1684
|
+
/** Y when the order is deleted (max 1 chars) */
|
|
1685
|
+
deleteFlag: string;
|
|
1686
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1687
|
+
processCd: number;
|
|
1688
|
+
[key: string]: unknown;
|
|
1689
|
+
}
|
|
1690
|
+
/**
|
|
1691
|
+
* Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
|
|
1692
|
+
* One order line in the light form orders list sends with fullDocument=L
|
|
1693
|
+
*
|
|
1694
|
+
* Field `lines` of CustomerOrdersListDataItemOption3
|
|
1695
|
+
*/
|
|
1696
|
+
export interface CustomerOrdersListDataItemOption3LinesItem {
|
|
1697
|
+
/** Line number on the order */
|
|
1698
|
+
lineNo: number;
|
|
1699
|
+
/** Item ID; null when the item is not in inv_mast */
|
|
1700
|
+
itemId: string | null;
|
|
1701
|
+
/** Quantity ordered */
|
|
1702
|
+
qtyOrdered: number | null;
|
|
1703
|
+
/** Price per unit of measure */
|
|
1704
|
+
unitPrice: number | null;
|
|
1705
|
+
/** Order line ID */
|
|
1706
|
+
oeLineUid: number;
|
|
1707
|
+
/** Parent line's oeLineUid for an assembly component; 0 for a top-level line */
|
|
1708
|
+
parentOeLineUid: number;
|
|
1709
|
+
[key: string]: unknown;
|
|
1710
|
+
}
|
|
1711
|
+
/**
|
|
1712
|
+
* Shape of data nested in CustomerOrdersListData (MINIMUM fields; reused wherever the same shape
|
|
1713
|
+
* appears)
|
|
1714
|
+
*
|
|
1715
|
+
* Nested in CustomerOrdersListData
|
|
1716
|
+
*/
|
|
1717
|
+
export interface CustomerOrdersListDataItemOption3 {
|
|
1718
|
+
/** Prophet 21 order number (max 8 chars) */
|
|
1719
|
+
orderNo: string;
|
|
1720
|
+
/** Unique id of the order header */
|
|
1721
|
+
oeHdrUid: number;
|
|
1722
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1723
|
+
dateCreated: string;
|
|
1724
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1725
|
+
dateLastModified: string;
|
|
1726
|
+
/** Prophet 21 customer the order is for */
|
|
1727
|
+
customerId: number;
|
|
1728
|
+
/** When the order was placed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1729
|
+
orderDate: string | null;
|
|
1730
|
+
/** Customer purchase order number (max 50 chars) */
|
|
1731
|
+
poNo: string | null;
|
|
1732
|
+
/** Y when the order is complete (max 1 chars) */
|
|
1733
|
+
completed: string | null;
|
|
1734
|
+
/** Prophet 21 company (max 8 chars) */
|
|
1735
|
+
companyId: string | null;
|
|
1736
|
+
/** Prophet 21 address id of the carrier */
|
|
1737
|
+
carrierId: number | null;
|
|
1738
|
+
/**
|
|
1739
|
+
* When Augur last checked the order against Prophet 21 (mysql-datetime, e.g. 2025-07-30 15:50:49)
|
|
1740
|
+
*/
|
|
1741
|
+
dateLastChecked: string;
|
|
1742
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
1743
|
+
updateCd: number;
|
|
1744
|
+
/** Web order reference number; null for orders not placed on the web (max 255 chars) */
|
|
1745
|
+
webReferenceNo: string | null;
|
|
1746
|
+
/** Ship-to name (max 50 chars) */
|
|
1747
|
+
ship2Name: string | null;
|
|
1748
|
+
/** Ship-to address line 1 (max 50 chars) */
|
|
1749
|
+
ship2Add1: string | null;
|
|
1750
|
+
/** Ship-to address line 2 (max 50 chars) */
|
|
1751
|
+
ship2Add2: string | null;
|
|
1752
|
+
/** Ship-to city (max 50 chars) */
|
|
1753
|
+
ship2City: string | null;
|
|
1754
|
+
/** Ship-to state or province (max 50 chars) */
|
|
1755
|
+
ship2State: string | null;
|
|
1756
|
+
/** Ship-to postal code (max 10 chars) */
|
|
1757
|
+
ship2Zip: string | null;
|
|
1758
|
+
/** Ship-to country (max 50 chars) */
|
|
1759
|
+
ship2Country: string | null;
|
|
1760
|
+
/** Ship-to email address (max 255 chars) */
|
|
1761
|
+
ship2EmailAddress: string | null;
|
|
1762
|
+
/** Ship-to address line 3 (max 50 chars) */
|
|
1763
|
+
ship2Add3: string | null;
|
|
1764
|
+
/** Ship-to phone number (max 20 chars) */
|
|
1765
|
+
shipToPhone: string | null;
|
|
1766
|
+
/** Prophet 21 location the order ships from */
|
|
1767
|
+
locationId: number | null;
|
|
1768
|
+
/** Delivery instructions for the carrier (max 255 chars) */
|
|
1769
|
+
deliveryInstructions: string | null;
|
|
1770
|
+
/** Y when the order is canceled (max 1 chars) */
|
|
1771
|
+
cancelFlag: string | null;
|
|
1772
|
+
/** Prophet 21 user who took the order (max 30 chars) */
|
|
1773
|
+
taker: string | null;
|
|
1774
|
+
/** Shipping route assigned to the order */
|
|
1775
|
+
shippingRouteUid: number | null;
|
|
1776
|
+
/** Prophet 21 payment terms (max 2 chars) */
|
|
1777
|
+
terms: string | null;
|
|
1778
|
+
/** Y when the order is approved (max 1 chars) */
|
|
1779
|
+
approved: string | null;
|
|
1780
|
+
/** Order class 1 (max 8 chars) */
|
|
1781
|
+
class1id: string | null;
|
|
1782
|
+
/** Order class 2 (max 8 chars) */
|
|
1783
|
+
class2id: string | null;
|
|
1784
|
+
/** Order class 3 (max 8 chars) */
|
|
1785
|
+
class3id: string | null;
|
|
1786
|
+
/** Order class 4 (max 8 chars) */
|
|
1787
|
+
class4id: string | null;
|
|
1788
|
+
/** Order class 5 (max 8 chars) */
|
|
1789
|
+
class5id: string | null;
|
|
1790
|
+
/** Prophet 21 contact who placed the order (max 16 chars) */
|
|
1791
|
+
contactId: string | null;
|
|
1792
|
+
/** Y when the order is projected (not yet firm) (max 1 chars) */
|
|
1793
|
+
projectedOrder: string | null;
|
|
1794
|
+
/** Prophet 21 source code of the order (706 = Order Entry) */
|
|
1795
|
+
sourceCodeNo: number;
|
|
1796
|
+
/** Order priority */
|
|
1797
|
+
orderPriorityUid: number | null;
|
|
1798
|
+
/** Outgoing freight charged on the order */
|
|
1799
|
+
freightOut: number;
|
|
1800
|
+
/** Y when the order is an RMA (max 1 chars) */
|
|
1801
|
+
rmaFlag: string | null;
|
|
1802
|
+
/** When the order was completed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1803
|
+
dateOrderCompleted: string | null;
|
|
1804
|
+
/** Job name (max 40 chars) */
|
|
1805
|
+
jobName: string | null;
|
|
1806
|
+
/** Date the customer requested the order (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1807
|
+
requestedDate: string | null;
|
|
1808
|
+
/** Augur status code of the record */
|
|
1809
|
+
statusCd: number;
|
|
1810
|
+
/** Down payment requested on the order */
|
|
1811
|
+
requestedDownpayment: number | null;
|
|
1812
|
+
/** Y when the down payment has been invoiced (max 1 chars) */
|
|
1813
|
+
downpaymentInvoiced: string | null;
|
|
1814
|
+
/** Order validation status (max 8 chars) */
|
|
1815
|
+
validationStatus: string | null;
|
|
1816
|
+
/** Prophet 21 address of the order */
|
|
1817
|
+
addressId: number | null;
|
|
1818
|
+
/** Y when the order is deleted (max 1 chars) */
|
|
1819
|
+
deleteFlag: string;
|
|
1820
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
1821
|
+
processCd: number;
|
|
1822
|
+
/** One order line in the light form orders list sends with fullDocument=L */
|
|
1823
|
+
lines: CustomerOrdersListDataItemOption3LinesItem[];
|
|
1824
|
+
[key: string]: unknown;
|
|
1825
|
+
}
|
|
1826
|
+
/**
|
|
1827
|
+
* List Customer Orders
|
|
1828
|
+
* Response data for GET /customer/{customerId}/orders — MINIMUM fields, extras pass through
|
|
1829
|
+
*
|
|
1830
|
+
* Returned by: api.customers.customer.orders.list(customerId, params)
|
|
1831
|
+
*/
|
|
1832
|
+
export type CustomerOrdersListData = Array<CustomerOrdersGetData | CustomerOrdersListDataItemOption2 | CustomerOrdersListDataItemOption3>;
|
|
1833
|
+
/**
|
|
1834
|
+
* Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
|
|
1835
|
+
* Order lines, by line number
|
|
1836
|
+
*
|
|
1837
|
+
* Field `lines` of CustomerOrdersGetData
|
|
1838
|
+
*/
|
|
1839
|
+
export interface CustomerOrdersGetDataLinesItem {
|
|
1840
|
+
/** Item (inv_mast) ordered on the line */
|
|
1841
|
+
invMastUid: number;
|
|
1842
|
+
/** Y when the line is canceled (max 1 chars) */
|
|
1843
|
+
cancelFlag: string | null;
|
|
1844
|
+
/** Y when the line is complete (max 1 chars) */
|
|
1845
|
+
complete: string | null;
|
|
1846
|
+
/** Y when the line is deleted in Prophet 21 (max 1 chars) */
|
|
1847
|
+
deleteFlag: string;
|
|
1848
|
+
/** Prophet 21 disposition code for unallocated quantity (e.g. B = backorder) (max 1 chars) */
|
|
1849
|
+
disposition: string | null;
|
|
1850
|
+
/** Item description */
|
|
1851
|
+
itemDesc: string | null;
|
|
1852
|
+
/** Item description shown on the storefront */
|
|
1853
|
+
displayDesc: string | null;
|
|
1854
|
+
/** Item ID */
|
|
1855
|
+
itemId: string;
|
|
1856
|
+
/** Item short code */
|
|
1857
|
+
shortCode: string | null;
|
|
1858
|
+
/** Line number on the order */
|
|
1859
|
+
lineNo: number;
|
|
1860
|
+
/** Order the line belongs to (max 8 chars) */
|
|
1861
|
+
orderNo: string;
|
|
1862
|
+
/** Quantity on the line when it was entered */
|
|
1863
|
+
originalQtyOrdered: number | null;
|
|
1864
|
+
/** Quantity allocated from stock */
|
|
1865
|
+
qtyAllocated: number | null;
|
|
1866
|
+
/** Quantity canceled */
|
|
1867
|
+
qtyCanceled: number | null;
|
|
1868
|
+
/** Quantity invoiced */
|
|
1869
|
+
qtyInvoiced: number | null;
|
|
1870
|
+
/** Quantity on open pick tickets */
|
|
1871
|
+
qtyOnPickTickets: number | null;
|
|
1872
|
+
/** Quantity ordered */
|
|
1873
|
+
qtyOrdered: number | null;
|
|
1874
|
+
/** Unit of measure the line was sold in (max 8 chars) */
|
|
1875
|
+
unitOfMeasure: string | null;
|
|
1876
|
+
/** Quantity in the line's unit of measure */
|
|
1877
|
+
unitQuantity: number;
|
|
1878
|
+
/** Base units per unit of measure */
|
|
1879
|
+
unitSize: number;
|
|
1880
|
+
/** Price per unit of measure */
|
|
1881
|
+
unitPrice: number | null;
|
|
1882
|
+
/** Line total */
|
|
1883
|
+
extendedPrice: number | null;
|
|
1884
|
+
/** Order line ID */
|
|
1885
|
+
oeLineUid: number;
|
|
1886
|
+
/** Parent line's oeLineUid for an assembly component; 0 for a top-level line */
|
|
1887
|
+
parentOeLineUid: number;
|
|
1888
|
+
/** Trinity private-label item ID (trinitysurfaces only) */
|
|
1889
|
+
trinityItemId: string | null;
|
|
1890
|
+
/** Trinity private-label item description (trinitysurfaces only) */
|
|
1891
|
+
trinityItemDesc: string | null;
|
|
1892
|
+
/** Agent private-label item ID (trinitysurfaces only) */
|
|
1893
|
+
agentItemId: string | null;
|
|
1894
|
+
/** Agent private-label item description (trinitysurfaces only) */
|
|
1895
|
+
agentItemDesc: string | null;
|
|
1896
|
+
[key: string]: unknown;
|
|
1897
|
+
}
|
|
1898
|
+
/**
|
|
1899
|
+
* Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
|
|
1900
|
+
* Lines on the pick ticket
|
|
1901
|
+
*
|
|
1902
|
+
* Field `lines` of CustomerOrdersGetDataPickTicketsItem
|
|
1903
|
+
*/
|
|
1904
|
+
export interface CustomerOrdersGetDataPickTicketsItemLinesItem {
|
|
1905
|
+
/** Line number on the pick ticket */
|
|
1906
|
+
lineNumber: number;
|
|
1907
|
+
/** Quantity shipped */
|
|
1908
|
+
shipQuantity: number | null;
|
|
1909
|
+
/** Quantity requested for picking */
|
|
1910
|
+
qtyRequested: number | null;
|
|
1911
|
+
/** Item (inv_mast) on the line */
|
|
1912
|
+
invMastUid: number;
|
|
1913
|
+
/** Item ID */
|
|
1914
|
+
itemId: string;
|
|
1915
|
+
/** Item description */
|
|
1916
|
+
itemDesc: string | null;
|
|
1917
|
+
/** Item description shown on the storefront */
|
|
1918
|
+
displayDesc: string | null;
|
|
1919
|
+
/** Trinity private-label item ID (trinitysurfaces only) */
|
|
1920
|
+
trinityItemId: string | null;
|
|
1921
|
+
/** Trinity private-label item description (trinitysurfaces only) */
|
|
1922
|
+
trinityItemDesc: string | null;
|
|
1923
|
+
/** Agent private-label item ID (trinitysurfaces only) */
|
|
1924
|
+
agentItemId: string | null;
|
|
1925
|
+
/** Agent private-label item description (trinitysurfaces only) */
|
|
1926
|
+
agentItemDesc: string | null;
|
|
1927
|
+
[key: string]: unknown;
|
|
1928
|
+
}
|
|
1929
|
+
/**
|
|
1930
|
+
* Shape of `pickTickets` (MINIMUM fields; reused wherever the same shape appears)
|
|
1931
|
+
* Pick tickets issued for the order
|
|
1932
|
+
*
|
|
1933
|
+
* Field `pickTickets` of CustomerOrdersGetData
|
|
1934
|
+
*/
|
|
1935
|
+
export interface CustomerOrdersGetDataPickTicketsItem {
|
|
1936
|
+
/** Pick ticket number */
|
|
1937
|
+
pickTicketNo: number;
|
|
1938
|
+
/** Carrier tracking number (max 40 chars) */
|
|
1939
|
+
trackingNo: string | null;
|
|
1940
|
+
/** Order the pick ticket belongs to (max 8 chars) */
|
|
1941
|
+
orderNo: string;
|
|
1942
|
+
/** Invoice raised for the pick ticket; null until invoiced */
|
|
1943
|
+
invoiceNo: number | null;
|
|
1944
|
+
/** Date the pick ticket shipped (Y-m-d) */
|
|
1945
|
+
shipDate: string | null;
|
|
1946
|
+
/** Y when the pick ticket has been printed (max 1 chars) */
|
|
1947
|
+
printedFlag: string | null;
|
|
1948
|
+
/** Date the pick ticket was printed (Y-m-d) */
|
|
1949
|
+
printDate: string | null;
|
|
1950
|
+
/** Picking or shipping instructions (max 255 chars) */
|
|
1951
|
+
instructions: string | null;
|
|
1952
|
+
/** Prophet 21 address id of the pick ticket's carrier */
|
|
1953
|
+
carrierId: number | null;
|
|
1954
|
+
/** Carrier name; empty when the pick ticket has no carrier */
|
|
1955
|
+
carrierName: string;
|
|
1956
|
+
/** Lines on the pick ticket */
|
|
1957
|
+
lines: CustomerOrdersGetDataPickTicketsItemLinesItem[];
|
|
1958
|
+
[key: string]: unknown;
|
|
1959
|
+
}
|
|
1960
|
+
/**
|
|
1961
|
+
* Get Customer Order
|
|
1962
|
+
* Response data for GET /customer/{customerId}/orders/{orderNo} — MINIMUM fields, extras pass
|
|
1963
|
+
* through
|
|
1964
|
+
*
|
|
1965
|
+
* Nested in CustomerOrdersListData
|
|
1966
|
+
* Returned by: api.customers.customer.orders.get(customerId, orderNo)
|
|
1967
|
+
* Returned by: api.customers.customer.quotes.list(customerId, params) (array items)
|
|
1968
|
+
* Returned by: api.customers.customer.quotes.get(customerId, quoteNo)
|
|
1969
|
+
* Returned by: api.customers.customer.rmas.list(customerId, params) (array items)
|
|
1970
|
+
* Returned by: api.customers.customer.rmas.get(customerId, rmaNo)
|
|
1971
|
+
*/
|
|
1972
|
+
export interface CustomerOrdersGetData {
|
|
1973
|
+
/** Prophet 21 order number (max 8 chars) */
|
|
1974
|
+
orderNo: string;
|
|
1975
|
+
/** Prophet 21 customer the order belongs to */
|
|
1976
|
+
customerId: number;
|
|
1977
|
+
/** Customer name */
|
|
1978
|
+
customerName: string | null;
|
|
1979
|
+
/** Job name entered on the order (max 40 chars) */
|
|
1980
|
+
jobName: string | null;
|
|
1981
|
+
/** Date the order was placed (Y-m-d) */
|
|
1982
|
+
orderDate: string | null;
|
|
1983
|
+
/** Date the customer requested delivery (Y-m-d) */
|
|
1984
|
+
requestedDate: string | null;
|
|
1985
|
+
/** Y when the order is canceled (max 1 chars) */
|
|
1986
|
+
cancelFlag: string | null;
|
|
1987
|
+
/** Y when the order is complete (fully shipped) (max 1 chars) */
|
|
1988
|
+
completed: string | null;
|
|
1989
|
+
/** Y when the order is deleted in Prophet 21 (max 1 chars) */
|
|
1990
|
+
deleteFlag: string;
|
|
1991
|
+
/** Customer purchase order number (max 50 chars) */
|
|
1992
|
+
poNo: string | null;
|
|
1993
|
+
/** Ship-to name (max 50 chars) */
|
|
1994
|
+
ship2Name: string | null;
|
|
1995
|
+
/** Ship-to address line 1 (max 50 chars) */
|
|
1996
|
+
ship2Add1: string | null;
|
|
1997
|
+
/** Ship-to address line 2 (max 50 chars) */
|
|
1998
|
+
ship2Add2: string | null;
|
|
1999
|
+
/** Ship-to address line 3 (max 50 chars) */
|
|
2000
|
+
ship2Add3: string | null;
|
|
2001
|
+
/** Ship-to city (max 50 chars) */
|
|
2002
|
+
ship2City: string | null;
|
|
2003
|
+
/** Ship-to state or province (max 50 chars) */
|
|
2004
|
+
ship2State: string | null;
|
|
2005
|
+
/** Ship-to postal code (max 10 chars) */
|
|
2006
|
+
ship2Zip: string | null;
|
|
2007
|
+
/** Ship-to country (max 50 chars) */
|
|
2008
|
+
ship2Country: string | null;
|
|
2009
|
+
/** Ship-to email address (max 255 chars) */
|
|
2010
|
+
ship2EmailAddress: string | null;
|
|
2011
|
+
/** Ship-to phone number (max 20 chars) */
|
|
2012
|
+
shipToPhone: string | null;
|
|
2013
|
+
/** Delivery instructions for the carrier (max 255 chars) */
|
|
2014
|
+
deliveryInstructions: string | null;
|
|
2015
|
+
/** Order class 1 */
|
|
2016
|
+
class1Id: string | null;
|
|
2017
|
+
/** Order class 2 */
|
|
2018
|
+
class2Id: string | null;
|
|
2019
|
+
/** Order class 3 */
|
|
2020
|
+
class3Id: string | null;
|
|
2021
|
+
/** Order class 4 */
|
|
2022
|
+
class4Id: string | null;
|
|
2023
|
+
/** Order class 5 */
|
|
2024
|
+
class5Id: string | null;
|
|
2025
|
+
/** Prophet 21 contact who placed the order (max 16 chars) */
|
|
2026
|
+
contactId: string | null;
|
|
2027
|
+
/** Web order reference number from the storefront (max 255 chars) */
|
|
2028
|
+
webReferenceNo: string | null;
|
|
2029
|
+
/**
|
|
2030
|
+
* PENDING, SUBMITTED, IN PROCESS, ON HOLD or SHIPPED, derived from the completed, approved,
|
|
2031
|
+
* cancel and validation flags
|
|
2032
|
+
*/
|
|
2033
|
+
orderStatus: string;
|
|
2034
|
+
/** User who entered the order (max 30 chars) */
|
|
2035
|
+
taker: string | null;
|
|
2036
|
+
/** First name of the ordering contact; null when the order has no contact */
|
|
2037
|
+
contactFirstName: string | null;
|
|
2038
|
+
/** Last name of the ordering contact; null when the order has no contact */
|
|
2039
|
+
contactLastName: string | null;
|
|
2040
|
+
/** Prophet 21 address id of the order's carrier */
|
|
2041
|
+
carrierId: number | null;
|
|
2042
|
+
/** Carrier name; empty when the order has no carrier */
|
|
2043
|
+
carrierName: string;
|
|
2044
|
+
/** Order lines, by line number */
|
|
2045
|
+
lines: CustomerOrdersGetDataLinesItem[];
|
|
2046
|
+
/** Pick tickets issued for the order */
|
|
2047
|
+
pickTickets: CustomerOrdersGetDataPickTicketsItem[];
|
|
2048
|
+
[key: string]: unknown;
|
|
2049
|
+
}
|
|
2050
|
+
/**
|
|
2051
|
+
* List Customer Purchased Items
|
|
2052
|
+
* Response data for GET /customer/{customerId}/purchased-items — MINIMUM fields, extras pass
|
|
2053
|
+
* through
|
|
2054
|
+
*
|
|
2055
|
+
* Returned by: api.customers.customer.purchasedItems.list(customerId, params) (array items)
|
|
2056
|
+
*/
|
|
2057
|
+
export interface CustomerPurchasedItemsListItem {
|
|
2058
|
+
/** Prophet 21 customer */
|
|
2059
|
+
customerId: number;
|
|
2060
|
+
/** Item (inv_mast) purchased */
|
|
2061
|
+
invMastUid: number;
|
|
2062
|
+
/** Total quantity purchased */
|
|
2063
|
+
count: number;
|
|
2064
|
+
/** Number of invoices the item appeared on */
|
|
2065
|
+
invoices: number;
|
|
2066
|
+
/** Most recent order the item was on */
|
|
2067
|
+
lastOrderNo: string | null;
|
|
2068
|
+
/** Date the item was last purchased (Y-m-d) */
|
|
2069
|
+
dateLastPurchased: string | null;
|
|
2070
|
+
/** Item ID */
|
|
2071
|
+
itemId: string;
|
|
2072
|
+
/** Item description */
|
|
2073
|
+
itemDesc: string | null;
|
|
2074
|
+
/** Item description shown on the storefront */
|
|
2075
|
+
displayDesc: string | null;
|
|
2076
|
+
[key: string]: unknown;
|
|
2077
|
+
}
|
|
2078
|
+
/** Returned by: api.customers.customer.purchasedItems.list(customerId, params) */
|
|
2079
|
+
export type CustomerPurchasedItemsListData = CustomerPurchasedItemsListItem[];
|
|
2080
|
+
/**
|
|
2081
|
+
* List Customer Quotes
|
|
2082
|
+
* Response data for GET /customer/{customerId}/quotes — MINIMUM fields, extras pass through
|
|
2083
|
+
*
|
|
2084
|
+
* Returned by: api.customers.customer.quotes.list(customerId, params) (array items)
|
|
2085
|
+
*/
|
|
2086
|
+
export type CustomerQuotesListItem = CustomerOrdersGetData;
|
|
2087
|
+
/** Returned by: api.customers.customer.quotes.list(customerId, params) */
|
|
2088
|
+
export type CustomerQuotesListData = CustomerQuotesListItem[];
|
|
2089
|
+
/**
|
|
2090
|
+
* Get Customer Quote
|
|
2091
|
+
* Response data for GET /customer/{customerId}/quotes/{quoteNo} — MINIMUM fields, extras pass
|
|
2092
|
+
* through
|
|
2093
|
+
*
|
|
2094
|
+
* Returned by: api.customers.customer.quotes.get(customerId, quoteNo)
|
|
2095
|
+
*/
|
|
2096
|
+
export type CustomerQuotesGetData = CustomerOrdersGetData;
|
|
2097
|
+
/**
|
|
2098
|
+
* List Customer Rewards Programs
|
|
2099
|
+
* Response data for GET /customer/{customerId}/rewards-programs — MINIMUM fields, extras pass
|
|
2100
|
+
* through
|
|
2101
|
+
*
|
|
2102
|
+
* Returned by: api.customers.customer.rewardsPrograms.list(customerId, params) (array items)
|
|
2103
|
+
*/
|
|
2104
|
+
export type CustomerRewardsProgramsListItem = CustomerXRewardsProgramListItem;
|
|
2105
|
+
/** Returned by: api.customers.customer.rewardsPrograms.list(customerId, params) */
|
|
2106
|
+
export type CustomerRewardsProgramsListData = CustomerRewardsProgramsListItem[];
|
|
2107
|
+
/**
|
|
2108
|
+
* List Customer RMAs
|
|
2109
|
+
* Response data for GET /customer/{customerId}/rmas — MINIMUM fields, extras pass through
|
|
2110
|
+
*
|
|
2111
|
+
* Returned by: api.customers.customer.rmas.list(customerId, params) (array items)
|
|
2112
|
+
*/
|
|
2113
|
+
export type CustomerRmasListItem = CustomerOrdersGetData;
|
|
2114
|
+
/** Returned by: api.customers.customer.rmas.list(customerId, params) */
|
|
2115
|
+
export type CustomerRmasListData = CustomerRmasListItem[];
|
|
2116
|
+
/**
|
|
2117
|
+
* Get Customer RMA
|
|
2118
|
+
* Response data for GET /customer/{customerId}/rmas/{rmaNo} — MINIMUM fields, extras pass through
|
|
2119
|
+
*
|
|
2120
|
+
* Returned by: api.customers.customer.rmas.get(customerId, rmaNo)
|
|
2121
|
+
*/
|
|
2122
|
+
export type CustomerRmasGetData = CustomerOrdersGetData;
|
|
2123
|
+
/**
|
|
2124
|
+
* Shape of `buckets` (MINIMUM fields; reused wherever the same shape appears)
|
|
2125
|
+
* Consumption per period, in bucketKeys order
|
|
2126
|
+
*
|
|
2127
|
+
* Field `buckets` of CustomerSalesUsageListDataDataItem
|
|
2128
|
+
*/
|
|
2129
|
+
export interface CustomerSalesUsageListDataDataItemBucketsItem {
|
|
2130
|
+
/** Period key, one of the response's bucketKeys */
|
|
2131
|
+
key: string;
|
|
2132
|
+
/** Quantity invoiced in the period */
|
|
2133
|
+
quantity: number;
|
|
2134
|
+
/** Sales total invoiced in the period */
|
|
2135
|
+
total: number;
|
|
2136
|
+
/** Number of invoice lines folded into the period */
|
|
2137
|
+
lines: number;
|
|
2138
|
+
[key: string]: unknown;
|
|
2139
|
+
}
|
|
2140
|
+
/**
|
|
2141
|
+
* Shape of `data` (MINIMUM fields; reused wherever the same shape appears)
|
|
2142
|
+
* The requested page of items
|
|
2143
|
+
*
|
|
2144
|
+
* Field `data` of CustomerSalesUsageListData
|
|
2145
|
+
*/
|
|
2146
|
+
export interface CustomerSalesUsageListDataDataItem {
|
|
2147
|
+
/** Item ID (max 40 chars) */
|
|
2148
|
+
itemId: string;
|
|
2149
|
+
/** Item description (max 40 chars) */
|
|
2150
|
+
itemDesc: string;
|
|
2151
|
+
/** Unit of measure the item was sold in (max 10 chars) */
|
|
2152
|
+
unitOfMeasure: string | null;
|
|
2153
|
+
/** Base units per sales unit */
|
|
2154
|
+
salesUnitSize: number | null;
|
|
2155
|
+
/** Base units per pricing unit */
|
|
2156
|
+
pricingUnitSize: number | null;
|
|
2157
|
+
/** Consumption per period, in bucketKeys order */
|
|
2158
|
+
buckets: CustomerSalesUsageListDataDataItemBucketsItem[];
|
|
2159
|
+
[key: string]: unknown;
|
|
2160
|
+
}
|
|
2161
|
+
/**
|
|
2162
|
+
* Customer Sales Usage Report
|
|
2163
|
+
* Response data for GET /customer/{customerId}/sales-usage — MINIMUM fields, extras pass through
|
|
2164
|
+
*
|
|
2165
|
+
* Returned by: api.customers.customer.salesUsage.list(customerId, params)
|
|
2166
|
+
*/
|
|
2167
|
+
export interface CustomerSalesUsageListData {
|
|
2168
|
+
/** Prophet 21 customer the report is for */
|
|
2169
|
+
customerId: string;
|
|
2170
|
+
/** Start of the invoice date range (Y-m-d) */
|
|
2171
|
+
invoicedFrom: string;
|
|
2172
|
+
/** End of the invoice date range (Y-m-d) */
|
|
2173
|
+
invoicedTo: string;
|
|
2174
|
+
/** Period the buckets are folded by: week, month or year */
|
|
2175
|
+
totalBy: string;
|
|
2176
|
+
/** Period keys in display order */
|
|
2177
|
+
bucketKeys: string[];
|
|
2178
|
+
/** Number of invoices in the date range */
|
|
2179
|
+
invoiceCount: number;
|
|
2180
|
+
/** Number of invoice lines folded into the report */
|
|
2181
|
+
linesFolded: number;
|
|
2182
|
+
/** Number of items across the whole report */
|
|
2183
|
+
itemCount: number;
|
|
2184
|
+
/** The requested page of items */
|
|
2185
|
+
data: CustomerSalesUsageListDataDataItem[];
|
|
2186
|
+
[key: string]: unknown;
|
|
2187
|
+
}
|
|
2188
|
+
/**
|
|
2189
|
+
* Create new ship_to for customer_id
|
|
2190
|
+
* Response data for POST /customer/{customerId}/ship-to — MINIMUM fields, extras pass through
|
|
2191
|
+
*
|
|
2192
|
+
* Returned by: api.customers.customer.shipTo.create(customerId, data)
|
|
2193
|
+
*/
|
|
2194
|
+
export type CustomerShipToCreateData = boolean;
|
|
2195
|
+
/**
|
|
2196
|
+
* Create new ship_to for customer_id
|
|
2197
|
+
* Request body for POST /customer/{customerId}/ship-to — MINIMUM fields, extras pass through
|
|
2198
|
+
*
|
|
2199
|
+
* Request body of: api.customers.customer.shipTo.create(customerId, data)
|
|
2200
|
+
*/
|
|
2201
|
+
export interface CustomerShipToCreateBody {
|
|
2202
|
+
/** P21 ShipToAddress fields (name, mail and physical address, phone) ([] when empty) */
|
|
2203
|
+
shipToAddress?: Record<string, unknown> | [] | null;
|
|
2204
|
+
[key: string]: unknown;
|
|
2205
|
+
}
|
|
2206
|
+
/**
|
|
2207
|
+
* Shape of `address` (MINIMUM fields; reused wherever the same shape appears)
|
|
2208
|
+
* The ship-to's address; null when no address row matches
|
|
2209
|
+
*
|
|
2210
|
+
* Field `address` of CustomerShipToListItem
|
|
2211
|
+
*/
|
|
2212
|
+
export interface CustomerShipToListItemAddress {
|
|
2213
|
+
/** Prophet 21 address ID */
|
|
2214
|
+
id: number;
|
|
2215
|
+
/** Address name (max 50 chars) */
|
|
2216
|
+
name: string;
|
|
2217
|
+
/** Mailing address line 1 (max 50 chars) */
|
|
2218
|
+
mailAddress1: string | null;
|
|
2219
|
+
/** Mailing address line 2 (max 50 chars) */
|
|
2220
|
+
mailAddress2: string | null;
|
|
2221
|
+
/** Mailing address line 3 (max 50 chars) */
|
|
2222
|
+
mailAddress3: string | null;
|
|
2223
|
+
/** Mailing city (max 50 chars) */
|
|
2224
|
+
mailCity: string | null;
|
|
2225
|
+
/** Mailing state or province (max 50 chars) */
|
|
2226
|
+
mailState: string | null;
|
|
2227
|
+
/** Mailing postal code (max 10 chars) */
|
|
2228
|
+
mailPostalCode: string | null;
|
|
2229
|
+
/** Mailing country (max 50 chars) */
|
|
2230
|
+
mailCountry: string | null;
|
|
2231
|
+
/** Physical address line 1 (max 50 chars) */
|
|
2232
|
+
physAddress1: string | null;
|
|
2233
|
+
/** Physical address line 2 (max 50 chars) */
|
|
2234
|
+
physAddress2: string | null;
|
|
2235
|
+
/** Physical address line 3 (max 50 chars) */
|
|
2236
|
+
physAddress3: string | null;
|
|
2237
|
+
/** Physical city (max 50 chars) */
|
|
2238
|
+
physCity: string | null;
|
|
2239
|
+
/** Physical state or province (max 50 chars) */
|
|
2240
|
+
physState: string | null;
|
|
2241
|
+
/** Physical postal code (max 10 chars) */
|
|
2242
|
+
physPostalCode: string | null;
|
|
2243
|
+
/** Physical country (max 50 chars) */
|
|
2244
|
+
physCountry: string | null;
|
|
2245
|
+
/** Address class 5 (max 8 chars) */
|
|
2246
|
+
class5Id: string | null;
|
|
2247
|
+
/** Main phone number (max 20 chars) */
|
|
2248
|
+
centralPhoneNumber: string | null;
|
|
2249
|
+
/** UPS code for the address (max 40 chars) */
|
|
2250
|
+
upsCode: string | null;
|
|
2251
|
+
[key: string]: unknown;
|
|
2252
|
+
}
|
|
2253
|
+
/**
|
|
2254
|
+
* List Customer Ship-To Addresses
|
|
2255
|
+
* Response data for GET /customer/{customerId}/ship-to — MINIMUM fields, extras pass through
|
|
2256
|
+
*
|
|
2257
|
+
* Returned by: api.customers.customer.shipTo.list(customerId, params) (array items)
|
|
2258
|
+
*/
|
|
2259
|
+
export interface CustomerShipToListItem {
|
|
2260
|
+
/** Prophet 21 ship-to ID (also its address ID) */
|
|
2261
|
+
shipToId: number;
|
|
2262
|
+
/** Prophet 21 customer the ship-to belongs to */
|
|
2263
|
+
customerId: number;
|
|
2264
|
+
/** Prophet 21 company (max 8 chars) */
|
|
2265
|
+
companyId: string;
|
|
2266
|
+
/** Default branch for the ship-to (max 8 chars) */
|
|
2267
|
+
defaultBranch: string;
|
|
2268
|
+
/** Prophet 21 address ID of the default carrier */
|
|
2269
|
+
defaultCarrierId: number | null;
|
|
2270
|
+
/** Prophet 21 location the ship-to prefers to ship from */
|
|
2271
|
+
preferredLocationId: number | null;
|
|
2272
|
+
/** Delivery instructions for the carrier (max 255 chars) */
|
|
2273
|
+
deliveryInstructions: string | null;
|
|
2274
|
+
/** Shipping route assigned to the ship-to */
|
|
2275
|
+
shippingRouteUid: number | null;
|
|
2276
|
+
/** Shipping route code */
|
|
2277
|
+
routeCode: string | null;
|
|
2278
|
+
/** Shipping route description */
|
|
2279
|
+
routeDescription: string | null;
|
|
2280
|
+
/** The ship-to's address; null when no address row matches */
|
|
2281
|
+
address: CustomerShipToListItemAddress | null;
|
|
2282
|
+
[key: string]: unknown;
|
|
2283
|
+
}
|
|
2284
|
+
/** Returned by: api.customers.customer.shipTo.list(customerId, params) */
|
|
2285
|
+
export type CustomerShipToListData = CustomerShipToListItem[];
|
|
2286
|
+
/**
|
|
2287
|
+
* Lookup Customer ShipTo
|
|
2288
|
+
* Response data for GET /customer/{customerId}/ship-to/lookup — MINIMUM fields, extras pass through
|
|
2289
|
+
*
|
|
2290
|
+
* Returned by: api.customers.customer.shipTo.lookup.get(customerId, params) (array items)
|
|
2291
|
+
*/
|
|
2292
|
+
export interface CustomerShipToLookupGetItem {
|
|
2293
|
+
/** Prophet 21 ship-to (address) ID */
|
|
2294
|
+
id: number;
|
|
2295
|
+
/** Ship-to name (max 50 chars) */
|
|
2296
|
+
name: string;
|
|
2297
|
+
/** Mailing address line 1 (max 50 chars) */
|
|
2298
|
+
mailAddress1: string;
|
|
2299
|
+
/** Mailing address line 2 (max 50 chars) */
|
|
2300
|
+
mailAddress2: string | null;
|
|
2301
|
+
/** Mailing address line 3 (max 50 chars) */
|
|
2302
|
+
mailAddress3: string | null;
|
|
2303
|
+
/** Mailing city (max 50 chars) */
|
|
2304
|
+
mailCity: string | null;
|
|
2305
|
+
/** Mailing state or province (max 50 chars) */
|
|
2306
|
+
mailState: string | null;
|
|
2307
|
+
/** Mailing postal code (max 10 chars) */
|
|
2308
|
+
mailPostalCode: string | null;
|
|
2309
|
+
/** Mailing country (max 50 chars) */
|
|
2310
|
+
mailCountry: string | null;
|
|
2311
|
+
/** Physical address line 1 (max 50 chars) */
|
|
2312
|
+
physAddress1: string | null;
|
|
2313
|
+
/** Physical address line 2 (max 50 chars) */
|
|
2314
|
+
physAddress2: string | null;
|
|
2315
|
+
/** Physical address line 3 (max 50 chars) */
|
|
2316
|
+
physAddress3: string | null;
|
|
2317
|
+
/** Physical city (max 50 chars) */
|
|
2318
|
+
physCity: string | null;
|
|
2319
|
+
/** Physical state or province (max 50 chars) */
|
|
2320
|
+
physState: string | null;
|
|
2321
|
+
/** Physical postal code (max 10 chars) */
|
|
2322
|
+
physPostalCode: string | null;
|
|
2323
|
+
/** Physical country (max 50 chars) */
|
|
2324
|
+
physCountry: string | null;
|
|
2325
|
+
/** Address class 5 (max 8 chars) */
|
|
2326
|
+
class5Id: string | null;
|
|
2327
|
+
/** Prophet 21 location the ship-to prefers to ship from */
|
|
2328
|
+
preferredLocationId: number | null;
|
|
2329
|
+
/** Default branch for the ship-to (max 8 chars) */
|
|
2330
|
+
defaultBranch: string;
|
|
2331
|
+
[key: string]: unknown;
|
|
2332
|
+
}
|
|
2333
|
+
/** Returned by: api.customers.customer.shipTo.lookup.get(customerId, params) */
|
|
2334
|
+
export type CustomerShipToLookupGetData = CustomerShipToLookupGetItem[];
|
|
2335
|
+
/**
|
|
2336
|
+
* Get Customer Ship-To Freight Code
|
|
2337
|
+
* Response data for GET /customer/{customerId}/ship-to/{shipToId}/freight-codes — MINIMUM fields,
|
|
2338
|
+
* extras pass through
|
|
2339
|
+
*
|
|
2340
|
+
* Returned by: api.customers.customer.shipTo.freightCodes.list(customerId, shipToId)
|
|
2341
|
+
*/
|
|
2342
|
+
export interface CustomerShipToFreightCodesListData {
|
|
2343
|
+
/** Unique Prophet 21 ID of the freight code */
|
|
2344
|
+
freightCodeUid: number;
|
|
2345
|
+
/** Prophet 21 company the freight code belongs to (max 8 chars) */
|
|
2346
|
+
companyId: string;
|
|
2347
|
+
/** Freight code (max 30 chars) */
|
|
2348
|
+
freightCd: string;
|
|
2349
|
+
/** Freight code description (max 255 chars) */
|
|
2350
|
+
freightDesc: string;
|
|
2351
|
+
/** Y when the code applies to incoming freight (max 1 chars) */
|
|
2352
|
+
incomingFreight: string;
|
|
2353
|
+
/** Y when the code applies to outgoing freight (max 1 chars) */
|
|
2354
|
+
outgoingFreight: string;
|
|
2355
|
+
/** Y when incoming freight reduces commission (max 1 chars) */
|
|
2356
|
+
incomingReduceCommission: string;
|
|
2357
|
+
/** Y when outgoing freight increases commission (max 1 chars) */
|
|
2358
|
+
outgoingIncreaseCommission: string;
|
|
2359
|
+
/** Prorate method (Prophet 21 code number) */
|
|
2360
|
+
prorateMethodCodeNo: number;
|
|
2361
|
+
/** Tax group for the freight charge (max 10 chars) */
|
|
2362
|
+
taxGroupId: string | null;
|
|
2363
|
+
/** General ledger revenue account for the freight charge (max 32 chars) */
|
|
2364
|
+
revenueAccountNo: string;
|
|
2365
|
+
/** Prophet 21 row status code */
|
|
2366
|
+
rowStatus: number;
|
|
2367
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2368
|
+
dateCreated: string | null;
|
|
2369
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2370
|
+
dateLastModified: string | null;
|
|
2371
|
+
/** Prophet 21 user who last changed the record (max 30 chars) */
|
|
2372
|
+
lastMaintainedBy: string;
|
|
2373
|
+
/** Basis for free freight (Prophet 21 code number) */
|
|
2374
|
+
freeFreightBasisCd: number | null;
|
|
2375
|
+
/** Minimum for free incoming freight */
|
|
2376
|
+
freeInFreightMin: number | null;
|
|
2377
|
+
/** Minimum for free outgoing freight */
|
|
2378
|
+
freeOutFreightMin: number | null;
|
|
2379
|
+
/** Y when direct shipments get free freight (max 1 chars) */
|
|
2380
|
+
directShipFreeFreightFlag: string | null;
|
|
2381
|
+
/** Minimum for free incoming freight on web orders */
|
|
2382
|
+
freeInFreightMinWeb: number | null;
|
|
2383
|
+
/** Minimum for free outgoing freight on web orders */
|
|
2384
|
+
freeOutFreightMinWeb: number | null;
|
|
2385
|
+
/** Handling charge option (Prophet 21 code number) */
|
|
2386
|
+
handlingChargeOptionCd: number | null;
|
|
2387
|
+
/** External tax product code for incoming freight (max 255 chars) */
|
|
2388
|
+
externalTaxProductCodeIn: string | null;
|
|
2389
|
+
/** External tax product code for outgoing freight (max 255 chars) */
|
|
2390
|
+
externalTaxProductCodeOut: string | null;
|
|
2391
|
+
/** Y when incoming freight increases commission (max 1 chars) */
|
|
2392
|
+
incomingIncreaseCommission: string | null;
|
|
2393
|
+
/** Prophet 21 pay special flag (max 1 chars) */
|
|
2394
|
+
paySpecialFlag: string | null;
|
|
2395
|
+
/** Prophet 21 skip-first-shipment flag (max 1 chars) */
|
|
2396
|
+
skipFirstShipmentFlag: string | null;
|
|
2397
|
+
/** Y when excluded from Sales Master Inquiry (max 1 chars) */
|
|
2398
|
+
excludeFromSalesMasterInquiry: string;
|
|
2399
|
+
/** Y when the freight charge is deductible (max 1 chars) */
|
|
2400
|
+
deductibleFlag: string | null;
|
|
2401
|
+
/** Y when cold freight is free (max 1 chars) */
|
|
2402
|
+
freeColdFreight: string;
|
|
2403
|
+
/** Y when hazmat freight is free (max 1 chars) */
|
|
2404
|
+
freeHazmatFreight: string;
|
|
2405
|
+
/** Y when express freight is free (max 1 chars) */
|
|
2406
|
+
freeExpressFreight: string;
|
|
2407
|
+
/** Y when bulk freight is free (max 1 chars) */
|
|
2408
|
+
freeBulkFreight: string;
|
|
2409
|
+
/** FedEx payment method code */
|
|
2410
|
+
fedexPaymentMethod: number | null;
|
|
2411
|
+
/** Prophet 21 exclude-discounted-freight flag (max 1 chars) */
|
|
2412
|
+
excludeDiscountedFreight: string;
|
|
2413
|
+
/** Y when free freight applies by default (max 1 chars) */
|
|
2414
|
+
freeFreightDefaultFlag: string | null;
|
|
2415
|
+
/** Y when outgoing freight adjusts commission by profit (max 1 chars) */
|
|
2416
|
+
outgoingAdjustCommissionByProfitFlag: string | null;
|
|
2417
|
+
/** Update code (704 = queued for refresh from Prophet 21, 1185 = current) */
|
|
2418
|
+
updateCd: number;
|
|
2419
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2420
|
+
statusCd: number;
|
|
2421
|
+
/** Process code */
|
|
2422
|
+
processCd: number;
|
|
2423
|
+
[key: string]: unknown;
|
|
2424
|
+
}
|
|
2425
|
+
/**
|
|
2426
|
+
* List customer tags
|
|
2427
|
+
* Response data for GET /customer/{customerId}/tags — MINIMUM fields, extras pass through
|
|
2428
|
+
*
|
|
2429
|
+
* Returned by: api.customers.customer.tags.list(customerId, params) (array items)
|
|
2430
|
+
* Returned by: api.customers.customer.tags.create(customerId, data)
|
|
2431
|
+
* Returned by: api.customers.customer.tags.get(customerId, customerTagsUid)
|
|
2432
|
+
* Returned by: api.customers.customer.tags.update(customerId, customerTagsUid, data)
|
|
2433
|
+
* Returned by: api.customers.customer.tags.delete(customerId, customerTagsUid)
|
|
2434
|
+
*/
|
|
2435
|
+
export interface CustomerTagsListItem {
|
|
2436
|
+
/** Customer tag ID */
|
|
2437
|
+
customerTagsUid: number;
|
|
2438
|
+
/** Prophet 21 customer the tag belongs to */
|
|
2439
|
+
customerId: number;
|
|
2440
|
+
/** Tag text (max 255 chars) */
|
|
2441
|
+
tag: string | null;
|
|
2442
|
+
/** Update code (1185 = Import Complete) */
|
|
2443
|
+
updateCd: number;
|
|
2444
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2445
|
+
statusCd: number;
|
|
2446
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
2447
|
+
processCd: number;
|
|
2448
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2449
|
+
dateCreated: string;
|
|
2450
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2451
|
+
dateLastModified: string;
|
|
2452
|
+
[key: string]: unknown;
|
|
2453
|
+
}
|
|
2454
|
+
/** Returned by: api.customers.customer.tags.list(customerId, params) */
|
|
2455
|
+
export type CustomerTagsListData = CustomerTagsListItem[];
|
|
2456
|
+
/**
|
|
2457
|
+
* Create a new customer tag
|
|
2458
|
+
* Response data for POST /customer/{customerId}/tags — MINIMUM fields, extras pass through
|
|
2459
|
+
*
|
|
2460
|
+
* Returned by: api.customers.customer.tags.create(customerId, data)
|
|
2461
|
+
*/
|
|
2462
|
+
export type CustomerTagsCreateData = CustomerTagsListItem;
|
|
2463
|
+
/**
|
|
2464
|
+
* Create a new customer tag
|
|
2465
|
+
* Request body for POST /customer/{customerId}/tags — MINIMUM fields, extras pass through
|
|
2466
|
+
*
|
|
2467
|
+
* Request body of: api.customers.customer.tags.create(customerId, data)
|
|
2468
|
+
*/
|
|
2469
|
+
export interface CustomerTagsCreateBody {
|
|
2470
|
+
/** Tag text; an existing tag with the same text is refreshed in place */
|
|
2471
|
+
tag: string;
|
|
2472
|
+
/**
|
|
2473
|
+
* Status code (704 = Active, 705 = Inactive, 700 = Deleted); defaults to 704, and 704 restores a
|
|
2474
|
+
* deleted tag
|
|
2475
|
+
*/
|
|
2476
|
+
statusCd?: number | null;
|
|
2477
|
+
/** Process code; defaults to 704 (Active) */
|
|
2478
|
+
processCd?: number | null;
|
|
2479
|
+
/** Update code; defaults to 1185 (Import Complete) */
|
|
2480
|
+
updateCd?: number | null;
|
|
2481
|
+
[key: string]: unknown;
|
|
2482
|
+
}
|
|
2483
|
+
/**
|
|
2484
|
+
* Get a customer tag
|
|
2485
|
+
* Response data for GET /customer/{customerId}/tags/{customerTagsUid} — MINIMUM fields, extras pass
|
|
2486
|
+
* through
|
|
2487
|
+
*
|
|
2488
|
+
* Returned by: api.customers.customer.tags.get(customerId, customerTagsUid)
|
|
2489
|
+
*/
|
|
2490
|
+
export type CustomerTagsGetData = CustomerTagsListItem;
|
|
2491
|
+
/**
|
|
2492
|
+
* Update a customer tag
|
|
2493
|
+
* Response data for PUT /customer/{customerId}/tags/{customerTagsUid} — MINIMUM fields, extras pass
|
|
2494
|
+
* through
|
|
2495
|
+
*
|
|
2496
|
+
* Returned by: api.customers.customer.tags.update(customerId, customerTagsUid, data)
|
|
2497
|
+
*/
|
|
2498
|
+
export type CustomerTagsUpdateData = CustomerTagsListItem;
|
|
2499
|
+
/**
|
|
2500
|
+
* Update a customer tag
|
|
2501
|
+
* Request body for PUT /customer/{customerId}/tags/{customerTagsUid} — MINIMUM fields, extras pass
|
|
2502
|
+
* through
|
|
2503
|
+
*
|
|
2504
|
+
* Request body of: api.customers.customer.tags.update(customerId, customerTagsUid, data)
|
|
2505
|
+
*/
|
|
2506
|
+
export interface CustomerTagsUpdateBody {
|
|
2507
|
+
/** New tag text; a blank value keeps the current text */
|
|
2508
|
+
tag?: string | null;
|
|
2509
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2510
|
+
statusCd?: number | null;
|
|
2511
|
+
/** Process code */
|
|
2512
|
+
processCd?: number | null;
|
|
2513
|
+
[key: string]: unknown;
|
|
2514
|
+
}
|
|
2515
|
+
/**
|
|
2516
|
+
* Soft-delete a customer tag
|
|
2517
|
+
* Response data for DELETE /customer/{customerId}/tags/{customerTagsUid} — MINIMUM fields, extras
|
|
2518
|
+
* pass through
|
|
2519
|
+
*
|
|
2520
|
+
* Returned by: api.customers.customer.tags.delete(customerId, customerTagsUid)
|
|
2521
|
+
*/
|
|
2522
|
+
export type CustomerTagsDeleteData = CustomerTagsListItem;
|
|
2523
|
+
/**
|
|
2524
|
+
* List Oe Contacts Customer Rows
|
|
2525
|
+
* Response data for GET /oe-contacts-customer — MINIMUM fields, extras pass through
|
|
2526
|
+
*
|
|
2527
|
+
* Returned by: api.customers.oeContactsCustomer.list(params) (array items)
|
|
2528
|
+
*/
|
|
2529
|
+
export interface OeContactsCustomerListItem {
|
|
2530
|
+
/** P21 company ID (max 8 chars) */
|
|
2531
|
+
companyId: string;
|
|
2532
|
+
/** P21 customer ID (customer.customer_id) */
|
|
2533
|
+
customerId: number;
|
|
2534
|
+
/** P21 contact ID (contacts.id) (max 16 chars) */
|
|
2535
|
+
contactId: string;
|
|
2536
|
+
/** Y when P21 marks the row deleted (max 1 chars) */
|
|
2537
|
+
deleteFlag: string;
|
|
2538
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2539
|
+
dateCreated: string;
|
|
2540
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2541
|
+
dateLastModified: string;
|
|
2542
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2543
|
+
lastMaintainedBy: string;
|
|
2544
|
+
/** P21 shopper UID on the contact */
|
|
2545
|
+
shopperUid: number;
|
|
2546
|
+
/** P21 statement_contact on the contact (max 1 chars) */
|
|
2547
|
+
statementContact: string;
|
|
2548
|
+
/** Credit card number on the contact (max 255 chars) */
|
|
2549
|
+
creditCardNo: string | null;
|
|
2550
|
+
/** Credit card type on the contact (max 255 chars) */
|
|
2551
|
+
creditCardType: string | null;
|
|
2552
|
+
/** Name on the contact credit card (max 255 chars) */
|
|
2553
|
+
creditCardName: string | null;
|
|
2554
|
+
/** Credit card expiration date on the contact (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2555
|
+
creditCardExpirationDate: string | null;
|
|
2556
|
+
/** P21 pedigree_contact on the contact (max 1 chars) */
|
|
2557
|
+
pedigreeContact: string;
|
|
2558
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2559
|
+
updateCd: number;
|
|
2560
|
+
/** When the row was created (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2561
|
+
createdAt: string;
|
|
2562
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2563
|
+
processCd: number;
|
|
2564
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2565
|
+
statusCd: number;
|
|
2566
|
+
[key: string]: unknown;
|
|
2567
|
+
}
|
|
2568
|
+
/** Returned by: api.customers.oeContactsCustomer.list(params) */
|
|
2569
|
+
export type OeContactsCustomerListData = OeContactsCustomerListItem[];
|
|
2570
|
+
/**
|
|
2571
|
+
* List Rewards Program Rows
|
|
2572
|
+
* Response data for GET /rewards-program — MINIMUM fields, extras pass through
|
|
2573
|
+
*
|
|
2574
|
+
* Returned by: api.customers.rewardsProgram.list(params) (array items)
|
|
2575
|
+
* Returned by: api.customers.rewardsProgram.get(rewardsProgramUid)
|
|
2576
|
+
*/
|
|
2577
|
+
export interface RewardsProgramListItem {
|
|
2578
|
+
/** Unique ID of the rewards program */
|
|
2579
|
+
rewardsProgramUid: number;
|
|
2580
|
+
/** P21 rewards program ID (max 255 chars) */
|
|
2581
|
+
rewardsProgramId: string;
|
|
2582
|
+
/** Rewards program description (max 255 chars) */
|
|
2583
|
+
rewardsProgramDesc: string;
|
|
2584
|
+
/** P21 accum_coop_dollars_flag on the rewards program (max 1 chars) */
|
|
2585
|
+
accumCoopDollarsFlag: string;
|
|
2586
|
+
/** P21 accum_incentive_points_flag on the rewards program (max 1 chars) */
|
|
2587
|
+
accumIncentivePointsFlag: string;
|
|
2588
|
+
/** P21 coop_dollar_accum_rate on the rewards program */
|
|
2589
|
+
coopDollarAccumRate: number;
|
|
2590
|
+
/** P21 incentive_points_accum_rate on the rewards program */
|
|
2591
|
+
incentivePointsAccumRate: number;
|
|
2592
|
+
/** P21 coop_dollar_accum_basis on the rewards program */
|
|
2593
|
+
coopDollarAccumBasis: number;
|
|
2594
|
+
/** P21 incentive_points_accum_basis on the rewards program */
|
|
2595
|
+
incentivePointsAccumBasis: number;
|
|
2596
|
+
/** When the rewards program begins (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2597
|
+
beginDate: string;
|
|
2598
|
+
/** When the rewards program ends (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2599
|
+
endDate: string;
|
|
2600
|
+
/** Dealer type UID (dealer_type.dealer_type_uid) */
|
|
2601
|
+
dealerTypeUid: number | null;
|
|
2602
|
+
/** Row status from P21 (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2603
|
+
rowStatusFlag: number;
|
|
2604
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2605
|
+
dateCreated: string;
|
|
2606
|
+
/** P21 user who created the row (max 255 chars) */
|
|
2607
|
+
createdBy: string;
|
|
2608
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2609
|
+
dateLastModified: string;
|
|
2610
|
+
/** P21 user who last changed the row (max 255 chars) */
|
|
2611
|
+
lastMaintainedBy: string;
|
|
2612
|
+
/** P21 coop_dollar_accum_basis_cd on the rewards program */
|
|
2613
|
+
coopDollarAccumBasisCd: number;
|
|
2614
|
+
/** P21 incentive_points_accum_basis_cd on the rewards program */
|
|
2615
|
+
incentivePointsAccumBasisCd: number;
|
|
2616
|
+
/** P21 universal_program_flag on the rewards program (max 1 chars) */
|
|
2617
|
+
universalProgramFlag: string;
|
|
2618
|
+
/** P21 allow_retroactive_rewards_flag on the rewards program (max 1 chars) */
|
|
2619
|
+
allowRetroactiveRewardsFlag: string;
|
|
2620
|
+
/** P21 coop_dollar_basis_min on the rewards program */
|
|
2621
|
+
coopDollarBasisMin: number | null;
|
|
2622
|
+
/** P21 incentive_points_basis_min on the rewards program */
|
|
2623
|
+
incentivePointsBasisMin: number | null;
|
|
2624
|
+
/** P21 allow_registration_flag on the rewards program (max 1 chars) */
|
|
2625
|
+
allowRegistrationFlag: string;
|
|
2626
|
+
/** P21 coop_dollar_pass_min_option on the rewards program */
|
|
2627
|
+
coopDollarPassMinOption: number | null;
|
|
2628
|
+
/** P21 incentive_points_pass_min_option on the rewards program */
|
|
2629
|
+
incentivePointsPassMinOption: number | null;
|
|
2630
|
+
/** P21 web_visible_flag on the rewards program (max 1 chars) */
|
|
2631
|
+
webVisibleFlag: string | null;
|
|
2632
|
+
/** P21 buy_get_promo_rewards_flag on the rewards program (max 1 chars) */
|
|
2633
|
+
buyGetPromoRewardsFlag: string | null;
|
|
2634
|
+
/** P21 program_option on the rewards program */
|
|
2635
|
+
programOption: number | null;
|
|
2636
|
+
/** P21 supplier ID (supplier.supplier_id) */
|
|
2637
|
+
supplierId: number | null;
|
|
2638
|
+
/** P21 promo_submission_method on the rewards program (max 255 chars) */
|
|
2639
|
+
promoSubmissionMethod: string | null;
|
|
2640
|
+
/** Supplier contact information for the rewards program (max 255 chars) */
|
|
2641
|
+
supplierContactInformation: string | null;
|
|
2642
|
+
/** Additional information on the rewards program (max 255 chars) */
|
|
2643
|
+
additionalInformation: string | null;
|
|
2644
|
+
/** Last order date eligible for the rewards program (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2645
|
+
finalOrderDate: string | null;
|
|
2646
|
+
/** P21 stackable_type_cd on the rewards program */
|
|
2647
|
+
stackableTypeCd: number | null;
|
|
2648
|
+
/** P21 company ID (max 8 chars) */
|
|
2649
|
+
companyId: string | null;
|
|
2650
|
+
/** P21 trade_promo_cost_source_cd on the rewards program */
|
|
2651
|
+
tradePromoCostSourceCd: number | null;
|
|
2652
|
+
/** P21 rebate supplier ID (supplier.supplier_id) */
|
|
2653
|
+
rebateSupplierId: number | null;
|
|
2654
|
+
/** P21 max_dollar_amt on the rewards program */
|
|
2655
|
+
maxDollarAmt: number | null;
|
|
2656
|
+
/** P21 max_qty on the rewards program */
|
|
2657
|
+
maxQty: number | null;
|
|
2658
|
+
/** P21 rebate_percentage on the rewards program */
|
|
2659
|
+
rebatePercentage: number | null;
|
|
2660
|
+
/** P21 rebates_flag on the rewards program (max 1 chars) */
|
|
2661
|
+
rebatesFlag: string;
|
|
2662
|
+
/** P21 vendor_billing_include_rma_flag on the rewards program (max 1 chars) */
|
|
2663
|
+
vendorBillingIncludeRmaFlag: string;
|
|
2664
|
+
/** P21 program_type on the rewards program (max 255 chars) */
|
|
2665
|
+
programType: string | null;
|
|
2666
|
+
/** P21 unbilled_trade_promo_acct on the rewards program (max 32 chars) */
|
|
2667
|
+
unbilledTradePromoAcct: string | null;
|
|
2668
|
+
/** P21 unbilled_offset_acct on the rewards program (max 32 chars) */
|
|
2669
|
+
unbilledOffsetAcct: string | null;
|
|
2670
|
+
/** P21 trade_promo_receivable_acct on the rewards program (max 32 chars) */
|
|
2671
|
+
tradePromoReceivableAcct: string | null;
|
|
2672
|
+
/** P21 program_qty_used on the rewards program */
|
|
2673
|
+
programQtyUsed: number | null;
|
|
2674
|
+
/** P21 program_value_used on the rewards program */
|
|
2675
|
+
programValueUsed: number | null;
|
|
2676
|
+
/** P21 start_program_quantity on the rewards program */
|
|
2677
|
+
startProgramQuantity: number | null;
|
|
2678
|
+
/** P21 start_program_value on the rewards program */
|
|
2679
|
+
startProgramValue: number | null;
|
|
2680
|
+
/** P21 rebate_correction_flag on the rewards program (max 1 chars) */
|
|
2681
|
+
rebateCorrectionFlag: string | null;
|
|
2682
|
+
/** P21 referenced_program_id on the rewards program (max 255 chars) */
|
|
2683
|
+
referencedProgramId: string | null;
|
|
2684
|
+
/** P21 amf_claims_flag on the rewards program (max 1 chars) */
|
|
2685
|
+
amfClaimsFlag: string;
|
|
2686
|
+
/** P21 unredeemed_claims_acct_no on the rewards program (max 32 chars) */
|
|
2687
|
+
unredeemedClaimsAcctNo: string | null;
|
|
2688
|
+
/** P21 redeemed_claims_acct_no on the rewards program (max 32 chars) */
|
|
2689
|
+
redeemedClaimsAcctNo: string | null;
|
|
2690
|
+
/** P21 maf_surcharge_flag on the rewards program (max 1 chars) */
|
|
2691
|
+
mafSurchargeFlag: string;
|
|
2692
|
+
/** P21 maf_surcharge_oc_inv_mast_uid on the rewards program */
|
|
2693
|
+
mafSurchargeOcInvMastUid: number | null;
|
|
2694
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2695
|
+
processCd: number;
|
|
2696
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2697
|
+
statusCd: number;
|
|
2698
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2699
|
+
updateCd: number;
|
|
2700
|
+
[key: string]: unknown;
|
|
2701
|
+
}
|
|
2702
|
+
/** Returned by: api.customers.rewardsProgram.list(params) */
|
|
2703
|
+
export type RewardsProgramListData = RewardsProgramListItem[];
|
|
2704
|
+
/**
|
|
2705
|
+
* Get Rewards Program
|
|
2706
|
+
* Response data for GET /rewards-program/{rewardsProgramUid} — MINIMUM fields, extras pass through
|
|
2707
|
+
*
|
|
2708
|
+
* Returned by: api.customers.rewardsProgram.get(rewardsProgramUid)
|
|
2709
|
+
*/
|
|
2710
|
+
export type RewardsProgramGetData = RewardsProgramListItem;
|
|
2711
|
+
/**
|
|
2712
|
+
* List Ship To Ud Rows
|
|
2713
|
+
* Response data for GET /ship-to-ud — MINIMUM fields, extras pass through
|
|
2714
|
+
*
|
|
2715
|
+
* Returned by: api.customers.shipToUd.list(params) (array items)
|
|
2716
|
+
* Returned by: api.customers.shipToUd.get(shipToUdUid)
|
|
2717
|
+
*/
|
|
2718
|
+
export interface ShipToUdListItem {
|
|
2719
|
+
/** Unique ID of the ship-to user-defined row */
|
|
2720
|
+
shipToUdUid: number;
|
|
2721
|
+
/** P21 company ID (max 8 chars) */
|
|
2722
|
+
companyId: string;
|
|
2723
|
+
/** P21 ship-to ID (ship_to.ship_to_id) */
|
|
2724
|
+
shipToId: number;
|
|
2725
|
+
/** When the row was created in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2726
|
+
dateCreated: string;
|
|
2727
|
+
/** When the row last changed in P21 (Y-m-d H:i:s) (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
2728
|
+
dateLastModified: string;
|
|
2729
|
+
/** P21 user who last changed the row (max 30 chars) */
|
|
2730
|
+
lastMaintainedBy: string;
|
|
2731
|
+
/** P21 user who created the row (max 255 chars) */
|
|
2732
|
+
createdBy: string | null;
|
|
2733
|
+
/** Update code (704 = queued for P21 refresh, 1185 = in sync) */
|
|
2734
|
+
updateCd: number;
|
|
2735
|
+
/** P21 user-defined data for the row */
|
|
2736
|
+
userData: string | null;
|
|
2737
|
+
/** Process code (704 = queued for processing, 1185 = complete) */
|
|
2738
|
+
processCd: number;
|
|
2739
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
2740
|
+
statusCd: number;
|
|
2741
|
+
[key: string]: unknown;
|
|
2742
|
+
}
|
|
2743
|
+
/** Returned by: api.customers.shipToUd.list(params) */
|
|
2744
|
+
export type ShipToUdListData = ShipToUdListItem[];
|
|
2745
|
+
/**
|
|
2746
|
+
* Get Ship To Ud
|
|
2747
|
+
* Response data for GET /ship-to-ud/{shipToUdUid} — MINIMUM fields, extras pass through
|
|
2748
|
+
*
|
|
2749
|
+
* Returned by: api.customers.shipToUd.get(shipToUdUid)
|
|
2750
|
+
*/
|
|
2751
|
+
export type ShipToUdGetData = ShipToUdListItem;
|
|
2752
|
+
export interface CustomersClientSpec {
|
|
2753
|
+
contactRole: {
|
|
2754
|
+
/**
|
|
2755
|
+
* List Contact Role Rows
|
|
2756
|
+
* Call: api.customers.contactRole.list(params)
|
|
2757
|
+
*
|
|
2758
|
+
* List contact role rows as Augur holds them locally
|
|
2759
|
+
*
|
|
2760
|
+
* Errors:
|
|
2761
|
+
* 400: OrderBy is not one contact_role column with ASC or DESC.
|
|
2762
|
+
*
|
|
2763
|
+
* GET https://customers.augur-api.com/contact-role
|
|
2764
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contact-role/get
|
|
2765
|
+
*
|
|
2766
|
+
* @param params ContactRoleListParams (query string)
|
|
2767
|
+
* @returns BaseResponse whose `data` is ContactRoleListData
|
|
2768
|
+
*/
|
|
2769
|
+
list: (params?: ContactRoleListParams) => Promise<BaseResponse<ContactRoleListData>>;
|
|
2770
|
+
/**
|
|
2771
|
+
* Get Contact Role
|
|
2772
|
+
* Call: api.customers.contactRole.get(contactRoleUid)
|
|
2773
|
+
*
|
|
2774
|
+
* Get one contact role row as Augur holds it locally
|
|
2775
|
+
*
|
|
2776
|
+
* Errors:
|
|
2777
|
+
* 404: No contact role row with this contactRoleUid.
|
|
2778
|
+
*
|
|
2779
|
+
* GET https://customers.augur-api.com/contact-role/{contactRoleUid}
|
|
2780
|
+
* Contract:
|
|
2781
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1contact-role~1{contactRoleUid}/get
|
|
2782
|
+
*
|
|
2783
|
+
* @param contactRoleUid Contact role key (contact_role.contact_role_uid)
|
|
2784
|
+
* @param params ContactRoleGetParams (query string)
|
|
2785
|
+
* @returns BaseResponse whose `data` is ContactRoleGetData
|
|
2786
|
+
*/
|
|
2787
|
+
get: (contactRoleUid: number, params?: ContactRoleGetParams) => Promise<BaseResponse<ContactRoleGetData>>;
|
|
2788
|
+
};
|
|
2789
|
+
contacts: {
|
|
2790
|
+
/**
|
|
2791
|
+
* List Contacts Rows
|
|
2792
|
+
* Call: api.customers.contacts.list(params)
|
|
2793
|
+
*
|
|
2794
|
+
* List contacts rows as Augur holds them locally
|
|
2795
|
+
*
|
|
2796
|
+
* Errors:
|
|
2797
|
+
* 400: DeleteFlag is not Y or N, or locationId or contactRoleUid is not a number, or orderBy
|
|
2798
|
+
* is not one contacts column with ASC or DESC.
|
|
2799
|
+
*
|
|
2800
|
+
* GET https://customers.augur-api.com/contacts
|
|
2801
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contacts/get
|
|
2802
|
+
*
|
|
2803
|
+
* @param params ContactsListParams (query string)
|
|
2804
|
+
* @returns BaseResponse whose `data` is ContactsListData
|
|
2805
|
+
*/
|
|
2806
|
+
list: (params?: ContactsListParams) => Promise<BaseResponse<ContactsListData>>;
|
|
2807
|
+
/**
|
|
2808
|
+
* Get Contacts
|
|
2809
|
+
* Call: api.customers.contacts.get(id)
|
|
2810
|
+
*
|
|
2811
|
+
* Get one contacts row as Augur holds it locally
|
|
2812
|
+
*
|
|
2813
|
+
* Errors:
|
|
2814
|
+
* 400: id is missing or invalid.
|
|
2815
|
+
* 404: No contacts row with this id.
|
|
2816
|
+
*
|
|
2817
|
+
* GET https://customers.augur-api.com/contacts/{id}
|
|
2818
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contacts~1{id}/get
|
|
2819
|
+
*
|
|
2820
|
+
* @param id Contacts key (contacts.id)
|
|
2821
|
+
* @param params ContactsGetParams (query string)
|
|
2822
|
+
* @returns BaseResponse whose `data` is ContactsGetData
|
|
2823
|
+
*/
|
|
2824
|
+
get: (id: string, params?: ContactsGetParams) => Promise<BaseResponse<ContactsGetData>>;
|
|
2825
|
+
customers: {
|
|
2826
|
+
/**
|
|
2827
|
+
* List Salesrep Customers
|
|
2828
|
+
* Call: api.customers.contacts.customers.list(id, params)
|
|
2829
|
+
*
|
|
2830
|
+
* Response data, each item: A Prophet 21 customer with its terms and user-defined fields
|
|
2831
|
+
*
|
|
2832
|
+
* Errors:
|
|
2833
|
+
* 400: orderBy is not column|ASC or column|DESC on a customer column.
|
|
2834
|
+
* 404: No contact with this id.
|
|
2835
|
+
*
|
|
2836
|
+
* GET https://customers.augur-api.com/contacts/{id}/customers
|
|
2837
|
+
* Contract:
|
|
2838
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1contacts~1{id}~1customers/get
|
|
2839
|
+
*
|
|
2840
|
+
* @param id contacts.id
|
|
2841
|
+
* @param params ContactsCustomersListParams (query string)
|
|
2842
|
+
* @returns BaseResponse whose `data` is ContactsCustomersListData
|
|
2843
|
+
*/
|
|
2844
|
+
list: (id: string, params?: ContactsCustomersListParams) => Promise<BaseResponse<ContactsCustomersListData>>;
|
|
2845
|
+
};
|
|
2846
|
+
doc: {
|
|
2847
|
+
/**
|
|
2848
|
+
* get the contact document
|
|
2849
|
+
* Call: api.customers.contacts.doc.list(id)
|
|
2850
|
+
*
|
|
2851
|
+
* Response data: A Prophet 21 contact with the address it belongs to
|
|
2852
|
+
*
|
|
2853
|
+
* Errors:
|
|
2854
|
+
* 404: No contact with this ID.
|
|
2855
|
+
*
|
|
2856
|
+
* GET https://customers.augur-api.com/contacts/{id}/doc
|
|
2857
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contacts~1{id}~1doc/get
|
|
2858
|
+
*
|
|
2859
|
+
* @param id contacts.id
|
|
2860
|
+
* @param params ContactsDocListParams (query string)
|
|
2861
|
+
* @returns BaseResponse whose `data` is ContactsDocListData
|
|
2862
|
+
*/
|
|
2863
|
+
list: (id: string, params?: ContactsDocListParams) => Promise<BaseResponse<ContactsDocListData>>;
|
|
2864
|
+
/** Alias for `list`: GET /contacts/{id}/doc. Call: api.customers.contacts.doc.get(id) */
|
|
2865
|
+
get: (id: string, params?: ContactsDocListParams) => Promise<BaseResponse<ContactsDocListData>>;
|
|
2866
|
+
};
|
|
2867
|
+
webAllowance: {
|
|
2868
|
+
/**
|
|
2869
|
+
* Get the web allowance for a contact_id (USCCO)
|
|
2870
|
+
* Call: api.customers.contacts.webAllowance.list(id)
|
|
2871
|
+
*
|
|
2872
|
+
* Response data: How much a contact may still order on the web in the customer's current
|
|
2873
|
+
* allowance period
|
|
2874
|
+
*
|
|
2875
|
+
* Errors:
|
|
2876
|
+
* 404: No contact with this ID on any customer.
|
|
2877
|
+
*
|
|
2878
|
+
* GET https://customers.augur-api.com/contacts/{id}/web-allowance
|
|
2879
|
+
* Contract:
|
|
2880
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1contacts~1{id}~1web-allowance/get
|
|
2881
|
+
*
|
|
2882
|
+
* @param id contacts.id
|
|
2883
|
+
* @param params ContactsWebAllowanceListParams (query string)
|
|
2884
|
+
* @returns BaseResponse whose `data` is ContactsWebAllowanceListData
|
|
2885
|
+
*/
|
|
2886
|
+
list: (id: string, params?: ContactsWebAllowanceListParams) => Promise<BaseResponse<ContactsWebAllowanceListData>>;
|
|
2887
|
+
};
|
|
2888
|
+
};
|
|
2889
|
+
contactsUd: {
|
|
2890
|
+
/**
|
|
2891
|
+
* List Contacts Ud Rows
|
|
2892
|
+
* Call: api.customers.contactsUd.list(params)
|
|
2893
|
+
*
|
|
2894
|
+
* List contacts ud rows as Augur holds them locally
|
|
2895
|
+
*
|
|
2896
|
+
* Errors:
|
|
2897
|
+
* 400: OrderBy is not one contacts_ud column with ASC or DESC.
|
|
2898
|
+
*
|
|
2899
|
+
* GET https://customers.augur-api.com/contacts-ud
|
|
2900
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contacts-ud/get
|
|
2901
|
+
*
|
|
2902
|
+
* @param params ContactsUdListParams (query string)
|
|
2903
|
+
* @returns BaseResponse whose `data` is ContactsUdListData
|
|
2904
|
+
*/
|
|
2905
|
+
list: (params?: ContactsUdListParams) => Promise<BaseResponse<ContactsUdListData>>;
|
|
2906
|
+
/**
|
|
2907
|
+
* List user defined fields for a contact
|
|
2908
|
+
* Call: api.customers.contactsUd.get(id)
|
|
2909
|
+
*
|
|
2910
|
+
* Response data: A Prophet 21 contact's user-defined fields, each field name a top-level key
|
|
2911
|
+
* beside the fixed ones
|
|
2912
|
+
*
|
|
2913
|
+
* Errors:
|
|
2914
|
+
* 404: No user-defined fields row for this contact.
|
|
2915
|
+
*
|
|
2916
|
+
* GET https://customers.augur-api.com/contacts-ud/{id}
|
|
2917
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contacts-ud~1{id}/get
|
|
2918
|
+
*
|
|
2919
|
+
* @param id contacts.id
|
|
2920
|
+
* @param params ContactsUdGetParams (query string)
|
|
2921
|
+
* @returns BaseResponse whose `data` is ContactsUdGetData
|
|
2922
|
+
*/
|
|
2923
|
+
get: (id: string, params?: ContactsUdGetParams) => Promise<BaseResponse<ContactsUdGetData>>;
|
|
2924
|
+
};
|
|
2925
|
+
contactsXShipTo: {
|
|
2926
|
+
/**
|
|
2927
|
+
* List Contacts X Ship To Rows
|
|
2928
|
+
* Call: api.customers.contactsXShipTo.list(params)
|
|
2929
|
+
*
|
|
2930
|
+
* List contacts x ship to rows as Augur holds them locally
|
|
2931
|
+
*
|
|
2932
|
+
* Errors:
|
|
2933
|
+
* 400: ShipToId is not a number, or orderBy is not one contacts_x_ship_to column with ASC or
|
|
2934
|
+
* DESC.
|
|
2935
|
+
*
|
|
2936
|
+
* GET https://customers.augur-api.com/contacts-x-ship-to
|
|
2937
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1contacts-x-ship-to/get
|
|
2938
|
+
*
|
|
2939
|
+
* @param params ContactsXShipToListParams (query string)
|
|
2940
|
+
* @returns BaseResponse whose `data` is ContactsXShipToListData
|
|
2941
|
+
*/
|
|
2942
|
+
list: (params?: ContactsXShipToListParams) => Promise<BaseResponse<ContactsXShipToListData>>;
|
|
2943
|
+
/**
|
|
2944
|
+
* Get Contacts X Ship To
|
|
2945
|
+
* Call: api.customers.contactsXShipTo.get(contactsXShipToUid)
|
|
2946
|
+
*
|
|
2947
|
+
* Get one contacts x ship to row as Augur holds it locally
|
|
2948
|
+
*
|
|
2949
|
+
* Errors:
|
|
2950
|
+
* 404: No contacts x ship to row with this contactsXShipToUid.
|
|
2951
|
+
*
|
|
2952
|
+
* GET https://customers.augur-api.com/contacts-x-ship-to/{contactsXShipToUid}
|
|
2953
|
+
* Contract:
|
|
2954
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1contacts-x-ship-to~1{contactsXShipToUid}/get
|
|
2955
|
+
*
|
|
2956
|
+
* @param contactsXShipToUid Contacts x ship to key (contacts_x_ship_to.contacts_x_ship_to_uid)
|
|
2957
|
+
* @param params ContactsXShipToGetParams (query string)
|
|
2958
|
+
* @returns BaseResponse whose `data` is ContactsXShipToGetData
|
|
2959
|
+
*/
|
|
2960
|
+
get: (contactsXShipToUid: number, params?: ContactsXShipToGetParams) => Promise<BaseResponse<ContactsXShipToGetData>>;
|
|
2961
|
+
};
|
|
2962
|
+
customer: {
|
|
2963
|
+
/**
|
|
2964
|
+
* list the customer documents
|
|
2965
|
+
* Call: api.customers.customer.list(params)
|
|
2966
|
+
*
|
|
2967
|
+
* Response data, each item: A Prophet 21 customer with its terms and user-defined fields
|
|
2968
|
+
*
|
|
2969
|
+
* Errors:
|
|
2970
|
+
* 400: orderBy is not column|ASC or column|DESC on a customer column.
|
|
2971
|
+
*
|
|
2972
|
+
* GET https://customers.augur-api.com/customer
|
|
2973
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1customer/get
|
|
2974
|
+
*
|
|
2975
|
+
* @param params CustomerListParams (query string)
|
|
2976
|
+
* @returns BaseResponse whose `data` is CustomerListData
|
|
2977
|
+
*/
|
|
2978
|
+
list: (params?: CustomerListParams) => Promise<BaseResponse<CustomerListData>>;
|
|
2979
|
+
address: {
|
|
2980
|
+
/**
|
|
2981
|
+
* Lookup Customer Addresses
|
|
2982
|
+
* Call: api.customers.customer.address.list(customerId, params)
|
|
2983
|
+
*
|
|
2984
|
+
* Response data, each item: One shipping address in a customer's address lookup
|
|
2985
|
+
*
|
|
2986
|
+
* Errors:
|
|
2987
|
+
* 404: No customer with this customerId.
|
|
2988
|
+
*
|
|
2989
|
+
* GET https://customers.augur-api.com/customer/{customerId}/address
|
|
2990
|
+
* Contract:
|
|
2991
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1address/get
|
|
2992
|
+
*
|
|
2993
|
+
* @param customerId customer.customer_id
|
|
2994
|
+
* @param params CustomerAddressListParams (query string)
|
|
2995
|
+
* @returns BaseResponse whose `data` is CustomerAddressListData
|
|
2996
|
+
*/
|
|
2997
|
+
list: (customerId: number, params?: CustomerAddressListParams) => Promise<BaseResponse<CustomerAddressListData>>;
|
|
2998
|
+
};
|
|
2999
|
+
addresses: {
|
|
3000
|
+
/**
|
|
3001
|
+
* List customer addresses
|
|
3002
|
+
* Call: api.customers.customer.addresses.list(customerId, params)
|
|
3003
|
+
*
|
|
3004
|
+
* Errors:
|
|
3005
|
+
* 400: orderBy is not column|ASC or column|DESC on a customer_address column.
|
|
3006
|
+
* 404: No customer with this customerId.
|
|
3007
|
+
*
|
|
3008
|
+
* GET https://customers.augur-api.com/customer/{customerId}/addresses
|
|
3009
|
+
* Contract:
|
|
3010
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1addresses/get
|
|
3011
|
+
*
|
|
3012
|
+
* @param customerId Prophet 21 customer the address belongs to
|
|
3013
|
+
* @param params CustomerAddressesListParams (query string)
|
|
3014
|
+
* @returns BaseResponse whose `data` is CustomerAddressesListData
|
|
3015
|
+
*/
|
|
3016
|
+
list: (customerId: number, params?: CustomerAddressesListParams) => Promise<BaseResponse<CustomerAddressesListData>>;
|
|
3017
|
+
/**
|
|
3018
|
+
* Create a new customer address
|
|
3019
|
+
* Call: api.customers.customer.addresses.create(customerId, data)
|
|
3020
|
+
*
|
|
3021
|
+
* Request body: Create a customer address; every field is optional
|
|
3022
|
+
*
|
|
3023
|
+
* Errors:
|
|
3024
|
+
* 404: No customer with this customerId.
|
|
3025
|
+
*
|
|
3026
|
+
* POST https://customers.augur-api.com/customer/{customerId}/addresses
|
|
3027
|
+
* Contract:
|
|
3028
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1addresses/post
|
|
3029
|
+
*
|
|
3030
|
+
* @param customerId Prophet 21 customer the address belongs to
|
|
3031
|
+
* @param data CustomerAddressesCreateBody (request body)
|
|
3032
|
+
* @returns BaseResponse whose `data` is CustomerAddressesCreateData
|
|
3033
|
+
*/
|
|
3034
|
+
create: (customerId: number, data: CustomerAddressesCreateBody) => Promise<BaseResponse<CustomerAddressesCreateData>>;
|
|
3035
|
+
/**
|
|
3036
|
+
* Get a customer address
|
|
3037
|
+
* Call: api.customers.customer.addresses.get(customerId, customerAddressUid)
|
|
3038
|
+
*
|
|
3039
|
+
* Get a customer address by UID
|
|
3040
|
+
*
|
|
3041
|
+
* Errors:
|
|
3042
|
+
* 404: No address with this ID for this customer.
|
|
3043
|
+
*
|
|
3044
|
+
* GET https://customers.augur-api.com/customer/{customerId}/addresses/{customerAddressUid}
|
|
3045
|
+
* Contract:
|
|
3046
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1addresses~1{customerAddressUid}/get
|
|
3047
|
+
*
|
|
3048
|
+
* @param customerId Prophet 21 customer the address belongs to
|
|
3049
|
+
* @param customerAddressUid Customer address ID
|
|
3050
|
+
* @param params CustomerAddressesGetParams (query string)
|
|
3051
|
+
* @returns BaseResponse whose `data` is CustomerAddressesGetData
|
|
3052
|
+
*/
|
|
3053
|
+
get: (customerId: number, customerAddressUid: number, params?: CustomerAddressesGetParams) => Promise<BaseResponse<CustomerAddressesGetData>>;
|
|
3054
|
+
/**
|
|
3055
|
+
* Update a customer address
|
|
3056
|
+
* Call: api.customers.customer.addresses.update(customerId, customerAddressUid, data)
|
|
3057
|
+
*
|
|
3058
|
+
* Request body: Partial update of a customer address; an absent field keeps its current value
|
|
3059
|
+
*
|
|
3060
|
+
* Errors:
|
|
3061
|
+
* 404: No address with this ID for this customer.
|
|
3062
|
+
*
|
|
3063
|
+
* PUT https://customers.augur-api.com/customer/{customerId}/addresses/{customerAddressUid}
|
|
3064
|
+
* Contract:
|
|
3065
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1addresses~1{customerAddressUid}/put
|
|
3066
|
+
*
|
|
3067
|
+
* @param customerId Prophet 21 customer the address belongs to
|
|
3068
|
+
* @param customerAddressUid Customer address ID
|
|
3069
|
+
* @param data CustomerAddressesUpdateBody (request body)
|
|
3070
|
+
* @returns BaseResponse whose `data` is CustomerAddressesUpdateData
|
|
3071
|
+
*/
|
|
3072
|
+
update: (customerId: number, customerAddressUid: number, data: CustomerAddressesUpdateBody) => Promise<BaseResponse<CustomerAddressesUpdateData>>;
|
|
3073
|
+
/**
|
|
3074
|
+
* Soft-delete a customer address
|
|
3075
|
+
* Call: api.customers.customer.addresses.delete(customerId, customerAddressUid)
|
|
3076
|
+
*
|
|
3077
|
+
* Errors:
|
|
3078
|
+
* 404: No address with this ID for this customer.
|
|
3079
|
+
*
|
|
3080
|
+
* DELETE https://customers.augur-api.com/customer/{customerId}/addresses/{customerAddressUid}
|
|
3081
|
+
* Contract:
|
|
3082
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1addresses~1{customerAddressUid}/delete
|
|
3083
|
+
*
|
|
3084
|
+
* @param customerId Prophet 21 customer the address belongs to
|
|
3085
|
+
* @param customerAddressUid Customer address ID
|
|
3086
|
+
* @returns BaseResponse whose `data` is CustomerAddressesDeleteData
|
|
3087
|
+
*/
|
|
3088
|
+
delete: (customerId: number, customerAddressUid: number) => Promise<BaseResponse<CustomerAddressesDeleteData>>;
|
|
3089
|
+
};
|
|
3090
|
+
aging: {
|
|
3091
|
+
/**
|
|
3092
|
+
* Customer Invoice Aging
|
|
3093
|
+
* Call: api.customers.customer.aging.list(customerId, params)
|
|
3094
|
+
*
|
|
3095
|
+
* Age outstanding customer invoice balances into current/30/60/90-day buckets
|
|
3096
|
+
*
|
|
3097
|
+
* Response data: A customer's outstanding invoice balances, aged into 30/60/90-day buckets.
|
|
3098
|
+
*
|
|
3099
|
+
* Errors:
|
|
3100
|
+
* 400: asOf is not a YYYY-MM-DD date, or orderBy is not column|ASC or column|DESC on an
|
|
3101
|
+
* invoice_hdr column.
|
|
3102
|
+
* 404: No customer with this customerId.
|
|
3103
|
+
*
|
|
3104
|
+
* GET https://customers.augur-api.com/customer/{customerId}/aging
|
|
3105
|
+
* Contract:
|
|
3106
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1aging/get
|
|
3107
|
+
*
|
|
3108
|
+
* @param customerId customer.customer_id
|
|
3109
|
+
* @param params CustomerAgingListParams (query string)
|
|
3110
|
+
* @returns BaseResponse whose `data` is CustomerAgingListData
|
|
3111
|
+
*/
|
|
3112
|
+
list: (customerId: number, params?: CustomerAgingListParams) => Promise<BaseResponse<CustomerAgingListData>>;
|
|
3113
|
+
};
|
|
3114
|
+
contacts: {
|
|
3115
|
+
/**
|
|
3116
|
+
* Lookup Customer Contacts
|
|
3117
|
+
* Call: api.customers.customer.contacts.list(customerId, params)
|
|
3118
|
+
*
|
|
3119
|
+
* Response data, each item: One contact in a customer's contact lookup
|
|
3120
|
+
*
|
|
3121
|
+
* Errors:
|
|
3122
|
+
* 400: orderBy is not column|ASC or column|DESC on a contacts column.
|
|
3123
|
+
* 404: No customer with this customerId.
|
|
3124
|
+
*
|
|
3125
|
+
* GET https://customers.augur-api.com/customer/{customerId}/contacts
|
|
3126
|
+
* Contract:
|
|
3127
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1contacts/get
|
|
3128
|
+
*
|
|
3129
|
+
* @param customerId customer.customer_id
|
|
3130
|
+
* @param params CustomerContactsListParams (query string)
|
|
3131
|
+
* @returns BaseResponse whose `data` is CustomerContactsListData
|
|
3132
|
+
*/
|
|
3133
|
+
list: (customerId: number, params?: CustomerContactsListParams) => Promise<BaseResponse<CustomerContactsListData>>;
|
|
3134
|
+
/**
|
|
3135
|
+
* Create new contact for customer_id
|
|
3136
|
+
* Call: api.customers.customer.contacts.create(customerId, data)
|
|
3137
|
+
*
|
|
3138
|
+
* Request body: A new Prophet 21 contact, passed to the P21 Entity API as sent
|
|
3139
|
+
*
|
|
3140
|
+
* Errors:
|
|
3141
|
+
* 404: No customer with this customerId.
|
|
3142
|
+
*
|
|
3143
|
+
* POST https://customers.augur-api.com/customer/{customerId}/contacts
|
|
3144
|
+
* Contract:
|
|
3145
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1contacts/post
|
|
3146
|
+
*
|
|
3147
|
+
* @param customerId customer.customer_id
|
|
3148
|
+
* @param data CustomerContactsCreateBody (request body)
|
|
3149
|
+
* @returns BaseResponse whose `data` is CustomerContactsCreateData
|
|
3150
|
+
*/
|
|
3151
|
+
create: (customerId: number, data: CustomerContactsCreateBody) => Promise<BaseResponse<CustomerContactsCreateData>>;
|
|
3152
|
+
};
|
|
3153
|
+
doc: {
|
|
3154
|
+
/**
|
|
3155
|
+
* get the customer document
|
|
3156
|
+
* Call: api.customers.customer.doc.list(customerId)
|
|
3157
|
+
*
|
|
3158
|
+
* Response data: A Prophet 21 customer with its terms and user-defined fields
|
|
3159
|
+
*
|
|
3160
|
+
* Errors:
|
|
3161
|
+
* 404: No customer with this ID.
|
|
3162
|
+
*
|
|
3163
|
+
* GET https://customers.augur-api.com/customer/{customerId}/doc
|
|
3164
|
+
* Contract:
|
|
3165
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1doc/get
|
|
3166
|
+
*
|
|
3167
|
+
* @param customerId customer.customer_id
|
|
3168
|
+
* @param params CustomerDocListParams (query string)
|
|
3169
|
+
* @returns BaseResponse whose `data` is CustomerDocListData
|
|
3170
|
+
*/
|
|
3171
|
+
list: (customerId: number, params?: CustomerDocListParams) => Promise<BaseResponse<CustomerDocListData>>;
|
|
3172
|
+
/**
|
|
3173
|
+
* Alias for `list`: GET /customer/{customerId}/doc. Call:
|
|
3174
|
+
* api.customers.customer.doc.get(customerId)
|
|
3175
|
+
*/
|
|
3176
|
+
get: (customerId: number, params?: CustomerDocListParams) => Promise<BaseResponse<CustomerDocListData>>;
|
|
3177
|
+
};
|
|
3178
|
+
invoices: {
|
|
3179
|
+
/**
|
|
3180
|
+
* List Customer Invoices
|
|
3181
|
+
* Call: api.customers.customer.invoices.list(customerId, params)
|
|
3182
|
+
*
|
|
3183
|
+
* Response data, each item: A Prophet 21 invoice with its lines
|
|
3184
|
+
*
|
|
3185
|
+
* Errors:
|
|
3186
|
+
* 400: orderBy is not column|ASC or column|DESC on an invoice_hdr column.
|
|
3187
|
+
* 404: No customer with this customerId.
|
|
3188
|
+
*
|
|
3189
|
+
* GET https://customers.augur-api.com/customer/{customerId}/invoices
|
|
3190
|
+
* Contract:
|
|
3191
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1invoices/get
|
|
3192
|
+
*
|
|
3193
|
+
* @param customerId customer.customer_id
|
|
3194
|
+
* @param params CustomerInvoicesListParams (query string)
|
|
3195
|
+
* @returns BaseResponse whose `data` is CustomerInvoicesListData
|
|
3196
|
+
*/
|
|
3197
|
+
list: (customerId: number, params?: CustomerInvoicesListParams) => Promise<BaseResponse<CustomerInvoicesListData>>;
|
|
3198
|
+
/**
|
|
3199
|
+
* Get Customer Invoice
|
|
3200
|
+
* Call: api.customers.customer.invoices.get(customerId, invoiceNo)
|
|
3201
|
+
*
|
|
3202
|
+
* Response data: A Prophet 21 invoice with its lines
|
|
3203
|
+
*
|
|
3204
|
+
* Errors:
|
|
3205
|
+
* 404: No invoice with this number for this customer.
|
|
3206
|
+
*
|
|
3207
|
+
* GET https://customers.augur-api.com/customer/{customerId}/invoices/{invoiceNo}
|
|
3208
|
+
* Contract:
|
|
3209
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1invoices~1{invoiceNo}/get
|
|
3210
|
+
*
|
|
3211
|
+
* @param customerId customer.customer_id
|
|
3212
|
+
* @param invoiceNo invoice_hdr.invoice_no
|
|
3213
|
+
* @param params CustomerInvoicesGetParams (query string)
|
|
3214
|
+
* @returns BaseResponse whose `data` is CustomerInvoicesGetData
|
|
3215
|
+
*/
|
|
3216
|
+
get: (customerId: number, invoiceNo: number, params?: CustomerInvoicesGetParams) => Promise<BaseResponse<CustomerInvoicesGetData>>;
|
|
3217
|
+
};
|
|
3218
|
+
lookup: {
|
|
3219
|
+
/**
|
|
3220
|
+
* lookup Customer Summary
|
|
3221
|
+
* Call: api.customers.customer.lookup.get(params)
|
|
3222
|
+
*
|
|
3223
|
+
* Lookup Customer summary
|
|
3224
|
+
*
|
|
3225
|
+
* Response data, each item: One customer in a customer lookup
|
|
3226
|
+
*
|
|
3227
|
+
* Errors:
|
|
3228
|
+
* 400: orderBy is not column|ASC or column|DESC on a customer column.
|
|
3229
|
+
*
|
|
3230
|
+
* GET https://customers.augur-api.com/customer/lookup
|
|
3231
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1customer~1lookup/get
|
|
3232
|
+
*
|
|
3233
|
+
* @param params CustomerLookupGetParams (query string)
|
|
3234
|
+
* @returns BaseResponse whose `data` is CustomerLookupGetData
|
|
3235
|
+
*/
|
|
3236
|
+
get: (params?: CustomerLookupGetParams) => Promise<BaseResponse<CustomerLookupGetData>>;
|
|
3237
|
+
};
|
|
3238
|
+
orders: {
|
|
3239
|
+
/**
|
|
3240
|
+
* List Customer Orders
|
|
3241
|
+
* Call: api.customers.customer.orders.list(customerId, params)
|
|
3242
|
+
*
|
|
3243
|
+
* Errors:
|
|
3244
|
+
* 400: customerId is below 1, or orderBy is not column|ASC or column|DESC on an oe_hdr
|
|
3245
|
+
* column.
|
|
3246
|
+
* 404: No customer with this customerId.
|
|
3247
|
+
*
|
|
3248
|
+
* GET https://customers.augur-api.com/customer/{customerId}/orders
|
|
3249
|
+
* Contract:
|
|
3250
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1orders/get
|
|
3251
|
+
*
|
|
3252
|
+
* @param customerId oe_hdr.customer_id
|
|
3253
|
+
* @param params CustomerOrdersListParams (query string)
|
|
3254
|
+
* @returns BaseResponse whose `data` is CustomerOrdersListData
|
|
3255
|
+
*/
|
|
3256
|
+
list: (customerId: number, params?: CustomerOrdersListParams) => Promise<BaseResponse<CustomerOrdersListData>>;
|
|
3257
|
+
/**
|
|
3258
|
+
* Get Customer Order
|
|
3259
|
+
* Call: api.customers.customer.orders.get(customerId, orderNo)
|
|
3260
|
+
*
|
|
3261
|
+
* Response data: One order, quote or RMA document: the `oe_hdr` header with its lines and
|
|
3262
|
+
* pick tickets.
|
|
3263
|
+
*
|
|
3264
|
+
* Errors:
|
|
3265
|
+
* 404: No order with this number for this customer.
|
|
3266
|
+
*
|
|
3267
|
+
* GET https://customers.augur-api.com/customer/{customerId}/orders/{orderNo}
|
|
3268
|
+
* Contract:
|
|
3269
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1orders~1{orderNo}/get
|
|
3270
|
+
*
|
|
3271
|
+
* @param customerId customer.customer_id
|
|
3272
|
+
* @param orderNo oe_hdr.order_no
|
|
3273
|
+
* @param params CustomerOrdersGetParams (query string)
|
|
3274
|
+
* @returns BaseResponse whose `data` is CustomerOrdersGetData
|
|
3275
|
+
*/
|
|
3276
|
+
get: (customerId: number, orderNo: string, params?: CustomerOrdersGetParams) => Promise<BaseResponse<CustomerOrdersGetData>>;
|
|
3277
|
+
};
|
|
3278
|
+
purchasedItems: {
|
|
3279
|
+
/**
|
|
3280
|
+
* List Customer Purchased Items
|
|
3281
|
+
* Call: api.customers.customer.purchasedItems.list(customerId, params)
|
|
3282
|
+
*
|
|
3283
|
+
* Response data, each item: One item a customer has bought, with how often and how recently
|
|
3284
|
+
*
|
|
3285
|
+
* Errors:
|
|
3286
|
+
* 400: orderBy is not column|ASC or column|DESC on an items_x_customer column.
|
|
3287
|
+
* 404: No customer with this customerId.
|
|
3288
|
+
*
|
|
3289
|
+
* GET https://customers.augur-api.com/customer/{customerId}/purchased-items
|
|
3290
|
+
* Contract:
|
|
3291
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1purchased-items/get
|
|
3292
|
+
*
|
|
3293
|
+
* @param customerId customer.customer_id
|
|
3294
|
+
* @param params CustomerPurchasedItemsListParams (query string)
|
|
3295
|
+
* @returns BaseResponse whose `data` is CustomerPurchasedItemsListData
|
|
3296
|
+
*/
|
|
3297
|
+
list: (customerId: number, params?: CustomerPurchasedItemsListParams) => Promise<BaseResponse<CustomerPurchasedItemsListData>>;
|
|
3298
|
+
};
|
|
3299
|
+
quotes: {
|
|
3300
|
+
/**
|
|
3301
|
+
* List Customer Quotes
|
|
3302
|
+
* Call: api.customers.customer.quotes.list(customerId, params)
|
|
3303
|
+
*
|
|
3304
|
+
* Response data, each item: One order, quote or RMA document: the `oe_hdr` header with its
|
|
3305
|
+
* lines and pick tickets.
|
|
3306
|
+
*
|
|
3307
|
+
* Errors:
|
|
3308
|
+
* 400: orderBy is not column|ASC or column|DESC on an oe_hdr column.
|
|
3309
|
+
* 404: No customer with this customerId.
|
|
3310
|
+
*
|
|
3311
|
+
* GET https://customers.augur-api.com/customer/{customerId}/quotes
|
|
3312
|
+
* Contract:
|
|
3313
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1quotes/get
|
|
3314
|
+
*
|
|
3315
|
+
* @param customerId customer.customer_id
|
|
3316
|
+
* @param params CustomerQuotesListParams (query string)
|
|
3317
|
+
* @returns BaseResponse whose `data` is CustomerQuotesListData
|
|
3318
|
+
*/
|
|
3319
|
+
list: (customerId: number, params?: CustomerQuotesListParams) => Promise<BaseResponse<CustomerQuotesListData>>;
|
|
3320
|
+
/**
|
|
3321
|
+
* Get Customer Quote
|
|
3322
|
+
* Call: api.customers.customer.quotes.get(customerId, quoteNo)
|
|
3323
|
+
*
|
|
3324
|
+
* Response data: One order, quote or RMA document: the `oe_hdr` header with its lines and
|
|
3325
|
+
* pick tickets.
|
|
3326
|
+
*
|
|
3327
|
+
* Errors:
|
|
3328
|
+
* 404: No quote with this number for this customer.
|
|
3329
|
+
*
|
|
3330
|
+
* GET https://customers.augur-api.com/customer/{customerId}/quotes/{quoteNo}
|
|
3331
|
+
* Contract:
|
|
3332
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1quotes~1{quoteNo}/get
|
|
3333
|
+
*
|
|
3334
|
+
* @param customerId customer.customer_id
|
|
3335
|
+
* @param quoteNo quotes.quote_no
|
|
3336
|
+
* @param params CustomerQuotesGetParams (query string)
|
|
3337
|
+
* @returns BaseResponse whose `data` is CustomerQuotesGetData
|
|
3338
|
+
*/
|
|
3339
|
+
get: (customerId: number, quoteNo: number, params?: CustomerQuotesGetParams) => Promise<BaseResponse<CustomerQuotesGetData>>;
|
|
3340
|
+
};
|
|
3341
|
+
rewardsPrograms: {
|
|
3342
|
+
/**
|
|
3343
|
+
* List Customer Rewards Programs
|
|
3344
|
+
* Call: api.customers.customer.rewardsPrograms.list(customerId, params)
|
|
3345
|
+
*
|
|
3346
|
+
* List one customer's rewards program enrollments as Augur holds them locally; 404 when the
|
|
3347
|
+
* customer does not exist
|
|
3348
|
+
*
|
|
3349
|
+
* Errors:
|
|
3350
|
+
* 400: orderBy is not one field|ASC or field|DESC on a customer_x_rewards_program column.
|
|
3351
|
+
* 404: No customer with this customerId.
|
|
3352
|
+
*
|
|
3353
|
+
* GET https://customers.augur-api.com/customer/{customerId}/rewards-programs
|
|
3354
|
+
* Contract:
|
|
3355
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1rewards-programs/get
|
|
3356
|
+
*
|
|
3357
|
+
* @param customerId P21 customer ID (customer.customer_id)
|
|
3358
|
+
* @param params CustomerRewardsProgramsListParams (query string)
|
|
3359
|
+
* @returns BaseResponse whose `data` is CustomerRewardsProgramsListData
|
|
3360
|
+
*/
|
|
3361
|
+
list: (customerId: number, params?: CustomerRewardsProgramsListParams) => Promise<BaseResponse<CustomerRewardsProgramsListData>>;
|
|
3362
|
+
};
|
|
3363
|
+
rmas: {
|
|
3364
|
+
/**
|
|
3365
|
+
* List Customer RMAs
|
|
3366
|
+
* Call: api.customers.customer.rmas.list(customerId, params)
|
|
3367
|
+
*
|
|
3368
|
+
* Response data, each item: One order, quote or RMA document: the `oe_hdr` header with its
|
|
3369
|
+
* lines and pick tickets.
|
|
3370
|
+
*
|
|
3371
|
+
* Errors:
|
|
3372
|
+
* 400: orderBy is not column|ASC or column|DESC on an oe_hdr column.
|
|
3373
|
+
* 404: No customer with this customerId.
|
|
3374
|
+
*
|
|
3375
|
+
* GET https://customers.augur-api.com/customer/{customerId}/rmas
|
|
3376
|
+
* Contract:
|
|
3377
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1rmas/get
|
|
3378
|
+
*
|
|
3379
|
+
* @param customerId customer.customer_id
|
|
3380
|
+
* @param params CustomerRmasListParams (query string)
|
|
3381
|
+
* @returns BaseResponse whose `data` is CustomerRmasListData
|
|
3382
|
+
*/
|
|
3383
|
+
list: (customerId: number, params?: CustomerRmasListParams) => Promise<BaseResponse<CustomerRmasListData>>;
|
|
3384
|
+
/**
|
|
3385
|
+
* Get Customer RMA
|
|
3386
|
+
* Call: api.customers.customer.rmas.get(customerId, rmaNo)
|
|
3387
|
+
*
|
|
3388
|
+
* Response data: One order, quote or RMA document: the `oe_hdr` header with its lines and
|
|
3389
|
+
* pick tickets.
|
|
3390
|
+
*
|
|
3391
|
+
* Errors:
|
|
3392
|
+
* 404: No RMA with this number for this customer.
|
|
3393
|
+
*
|
|
3394
|
+
* GET https://customers.augur-api.com/customer/{customerId}/rmas/{rmaNo}
|
|
3395
|
+
* Contract:
|
|
3396
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1rmas~1{rmaNo}/get
|
|
3397
|
+
*
|
|
3398
|
+
* @param customerId customer.customer_id
|
|
3399
|
+
* @param rmaNo rmas.rma_no
|
|
3400
|
+
* @param params CustomerRmasGetParams (query string)
|
|
3401
|
+
* @returns BaseResponse whose `data` is CustomerRmasGetData
|
|
3402
|
+
*/
|
|
3403
|
+
get: (customerId: number, rmaNo: number, params?: CustomerRmasGetParams) => Promise<BaseResponse<CustomerRmasGetData>>;
|
|
3404
|
+
};
|
|
3405
|
+
salesUsage: {
|
|
3406
|
+
/**
|
|
3407
|
+
* Customer Sales Usage Report
|
|
3408
|
+
* Call: api.customers.customer.salesUsage.list(customerId, params)
|
|
3409
|
+
*
|
|
3410
|
+
* List per-item, per-period sales usage for one customer, folded from invoiced history
|
|
3411
|
+
*
|
|
3412
|
+
* Response data: Per-customer, per-item consumption folded from invoiced sales history.
|
|
3413
|
+
*
|
|
3414
|
+
* Errors:
|
|
3415
|
+
* 400: invoicedFrom or invoicedTo is not a YYYY-MM-DD date, invoicedFrom is later than
|
|
3416
|
+
* invoicedTo, totalBy is not week, month or year, or orderBy is not item_id or
|
|
3417
|
+
* item_desc with |ASC or |DESC.
|
|
3418
|
+
* 404: No customer with this customerId.
|
|
3419
|
+
*
|
|
3420
|
+
* GET https://customers.augur-api.com/customer/{customerId}/sales-usage
|
|
3421
|
+
* Contract:
|
|
3422
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1sales-usage/get
|
|
3423
|
+
*
|
|
3424
|
+
* @param customerId customer.customer_id
|
|
3425
|
+
* @param params CustomerSalesUsageListParams (query string)
|
|
3426
|
+
* @returns BaseResponse whose `data` is CustomerSalesUsageListData
|
|
3427
|
+
*/
|
|
3428
|
+
list: (customerId: number, params?: CustomerSalesUsageListParams) => Promise<BaseResponse<CustomerSalesUsageListData>>;
|
|
3429
|
+
};
|
|
3430
|
+
shipTo: {
|
|
3431
|
+
/**
|
|
3432
|
+
* Create new ship_to for customer_id
|
|
3433
|
+
* Call: api.customers.customer.shipTo.create(customerId, data)
|
|
3434
|
+
*
|
|
3435
|
+
* Request body: A new Prophet 21 ship-to, passed to the P21 Entity API as sent
|
|
3436
|
+
*
|
|
3437
|
+
* Errors:
|
|
3438
|
+
* 404: No customer with this customerId.
|
|
3439
|
+
*
|
|
3440
|
+
* POST https://customers.augur-api.com/customer/{customerId}/ship-to
|
|
3441
|
+
* Contract:
|
|
3442
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1ship-to/post
|
|
3443
|
+
*
|
|
3444
|
+
* @param customerId customer.customer_id
|
|
3445
|
+
* @param data CustomerShipToCreateBody (request body)
|
|
3446
|
+
* @returns BaseResponse whose `data` is CustomerShipToCreateData
|
|
3447
|
+
*/
|
|
3448
|
+
create: (customerId: number, data: CustomerShipToCreateBody) => Promise<BaseResponse<CustomerShipToCreateData>>;
|
|
3449
|
+
/**
|
|
3450
|
+
* List Customer Ship-To Addresses
|
|
3451
|
+
* Call: api.customers.customer.shipTo.list(customerId, params)
|
|
3452
|
+
*
|
|
3453
|
+
* Response data, each item: One ship-to doc, backing an entry of `GET
|
|
3454
|
+
* /api/customer/{customerId}/ship-to`.
|
|
3455
|
+
*
|
|
3456
|
+
* Errors:
|
|
3457
|
+
* 400: orderBy is not column|ASC or column|DESC on a ship_to column.
|
|
3458
|
+
* 404: No customer with this customerId.
|
|
3459
|
+
*
|
|
3460
|
+
* GET https://customers.augur-api.com/customer/{customerId}/ship-to
|
|
3461
|
+
* Contract:
|
|
3462
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1ship-to/get
|
|
3463
|
+
*
|
|
3464
|
+
* @param customerId customer.customer_id
|
|
3465
|
+
* @param params CustomerShipToListParams (query string)
|
|
3466
|
+
* @returns BaseResponse whose `data` is CustomerShipToListData
|
|
3467
|
+
*/
|
|
3468
|
+
list: (customerId: number, params?: CustomerShipToListParams) => Promise<BaseResponse<CustomerShipToListData>>;
|
|
3469
|
+
freightCodes: {
|
|
3470
|
+
/**
|
|
3471
|
+
* Get Customer Ship-To Freight Code
|
|
3472
|
+
* Call: api.customers.customer.shipTo.freightCodes.list(customerId, shipToId)
|
|
3473
|
+
*
|
|
3474
|
+
* Get the freight code assigned to a customer ship-to
|
|
3475
|
+
*
|
|
3476
|
+
* Errors:
|
|
3477
|
+
* 404: The ship-to does not belong to this customer, or has no freight code.
|
|
3478
|
+
*
|
|
3479
|
+
* GET
|
|
3480
|
+
* https://customers.augur-api.com/customer/{customerId}/ship-to/{shipToId}/freight-codes
|
|
3481
|
+
* Contract:
|
|
3482
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1ship-to~1{shipToId}~1freight-codes/get
|
|
3483
|
+
*
|
|
3484
|
+
* @param customerId customer.customer_id
|
|
3485
|
+
* @param shipToId ship_to.ship_to_id
|
|
3486
|
+
* @param params CustomerShipToFreightCodesListParams (query string)
|
|
3487
|
+
* @returns BaseResponse whose `data` is CustomerShipToFreightCodesListData
|
|
3488
|
+
*/
|
|
3489
|
+
list: (customerId: number, shipToId: number, params?: CustomerShipToFreightCodesListParams) => Promise<BaseResponse<CustomerShipToFreightCodesListData>>;
|
|
3490
|
+
};
|
|
3491
|
+
lookup: {
|
|
3492
|
+
/**
|
|
3493
|
+
* Lookup Customer ShipTo
|
|
3494
|
+
* Call: api.customers.customer.shipTo.lookup.get(customerId, params)
|
|
3495
|
+
*
|
|
3496
|
+
* Response data, each item: One ship-to in a customer's ship-to lookup
|
|
3497
|
+
*
|
|
3498
|
+
* Errors:
|
|
3499
|
+
* 400: orderBy is not column|ASC or column|DESC on an address column.
|
|
3500
|
+
* 404: No customer with this customerId.
|
|
3501
|
+
*
|
|
3502
|
+
* GET https://customers.augur-api.com/customer/{customerId}/ship-to/lookup
|
|
3503
|
+
* Contract:
|
|
3504
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1ship-to~1lookup/get
|
|
3505
|
+
*
|
|
3506
|
+
* @param customerId customer.customer_id
|
|
3507
|
+
* @param params CustomerShipToLookupGetParams (query string)
|
|
3508
|
+
* @returns BaseResponse whose `data` is CustomerShipToLookupGetData
|
|
3509
|
+
*/
|
|
3510
|
+
get: (customerId: number, params?: CustomerShipToLookupGetParams) => Promise<BaseResponse<CustomerShipToLookupGetData>>;
|
|
3511
|
+
};
|
|
3512
|
+
};
|
|
3513
|
+
tags: {
|
|
3514
|
+
/**
|
|
3515
|
+
* List customer tags
|
|
3516
|
+
* Call: api.customers.customer.tags.list(customerId, params)
|
|
3517
|
+
*
|
|
3518
|
+
* Errors:
|
|
3519
|
+
* 400: orderBy is not column|ASC or column|DESC on a customer_tags column.
|
|
3520
|
+
* 404: No customer with this customerId.
|
|
3521
|
+
*
|
|
3522
|
+
* GET https://customers.augur-api.com/customer/{customerId}/tags
|
|
3523
|
+
* Contract:
|
|
3524
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1tags/get
|
|
3525
|
+
*
|
|
3526
|
+
* @param customerId Prophet 21 customer the tag belongs to
|
|
3527
|
+
* @param params CustomerTagsListParams (query string)
|
|
3528
|
+
* @returns BaseResponse whose `data` is CustomerTagsListData
|
|
3529
|
+
*/
|
|
3530
|
+
list: (customerId: number, params?: CustomerTagsListParams) => Promise<BaseResponse<CustomerTagsListData>>;
|
|
3531
|
+
/**
|
|
3532
|
+
* Create a new customer tag
|
|
3533
|
+
* Call: api.customers.customer.tags.create(customerId, data)
|
|
3534
|
+
*
|
|
3535
|
+
* Request body: Create a customer tag, or restore the one with the same tag text
|
|
3536
|
+
*
|
|
3537
|
+
* Errors:
|
|
3538
|
+
* 400: The tag is missing or blank.
|
|
3539
|
+
* 404: No customer with this customerId.
|
|
3540
|
+
*
|
|
3541
|
+
* POST https://customers.augur-api.com/customer/{customerId}/tags
|
|
3542
|
+
* Contract:
|
|
3543
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1tags/post
|
|
3544
|
+
*
|
|
3545
|
+
* @param customerId Prophet 21 customer the tag belongs to
|
|
3546
|
+
* @param data CustomerTagsCreateBody (request body)
|
|
3547
|
+
* @returns BaseResponse whose `data` is CustomerTagsCreateData
|
|
3548
|
+
*/
|
|
3549
|
+
create: (customerId: number, data: CustomerTagsCreateBody) => Promise<BaseResponse<CustomerTagsCreateData>>;
|
|
3550
|
+
/**
|
|
3551
|
+
* Get a customer tag
|
|
3552
|
+
* Call: api.customers.customer.tags.get(customerId, customerTagsUid)
|
|
3553
|
+
*
|
|
3554
|
+
* Get a customer tag by UID
|
|
3555
|
+
*
|
|
3556
|
+
* Errors:
|
|
3557
|
+
* 404: No tag with this ID for this customer.
|
|
3558
|
+
*
|
|
3559
|
+
* GET https://customers.augur-api.com/customer/{customerId}/tags/{customerTagsUid}
|
|
3560
|
+
* Contract:
|
|
3561
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1tags~1{customerTagsUid}/get
|
|
3562
|
+
*
|
|
3563
|
+
* @param customerId Prophet 21 customer the tag belongs to
|
|
3564
|
+
* @param customerTagsUid Customer tag ID
|
|
3565
|
+
* @param params CustomerTagsGetParams (query string)
|
|
3566
|
+
* @returns BaseResponse whose `data` is CustomerTagsGetData
|
|
3567
|
+
*/
|
|
3568
|
+
get: (customerId: number, customerTagsUid: number, params?: CustomerTagsGetParams) => Promise<BaseResponse<CustomerTagsGetData>>;
|
|
3569
|
+
/**
|
|
3570
|
+
* Update a customer tag
|
|
3571
|
+
* Call: api.customers.customer.tags.update(customerId, customerTagsUid, data)
|
|
3572
|
+
*
|
|
3573
|
+
* Request body: Partial update of a customer tag; an absent field keeps its current value
|
|
3574
|
+
*
|
|
3575
|
+
* Errors:
|
|
3576
|
+
* 404: No tag with this ID for this customer.
|
|
3577
|
+
*
|
|
3578
|
+
* PUT https://customers.augur-api.com/customer/{customerId}/tags/{customerTagsUid}
|
|
3579
|
+
* Contract:
|
|
3580
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1tags~1{customerTagsUid}/put
|
|
3581
|
+
*
|
|
3582
|
+
* @param customerId Prophet 21 customer the tag belongs to
|
|
3583
|
+
* @param customerTagsUid Customer tag ID
|
|
3584
|
+
* @param data CustomerTagsUpdateBody (request body)
|
|
3585
|
+
* @returns BaseResponse whose `data` is CustomerTagsUpdateData
|
|
3586
|
+
*/
|
|
3587
|
+
update: (customerId: number, customerTagsUid: number, data: CustomerTagsUpdateBody) => Promise<BaseResponse<CustomerTagsUpdateData>>;
|
|
3588
|
+
/**
|
|
3589
|
+
* Soft-delete a customer tag
|
|
3590
|
+
* Call: api.customers.customer.tags.delete(customerId, customerTagsUid)
|
|
3591
|
+
*
|
|
3592
|
+
* Errors:
|
|
3593
|
+
* 404: No tag with this ID for this customer.
|
|
3594
|
+
*
|
|
3595
|
+
* DELETE https://customers.augur-api.com/customer/{customerId}/tags/{customerTagsUid}
|
|
3596
|
+
* Contract:
|
|
3597
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer~1{customerId}~1tags~1{customerTagsUid}/delete
|
|
3598
|
+
*
|
|
3599
|
+
* @param customerId Prophet 21 customer the tag belongs to
|
|
3600
|
+
* @param customerTagsUid Customer tag ID
|
|
3601
|
+
* @returns BaseResponse whose `data` is CustomerTagsDeleteData
|
|
3602
|
+
*/
|
|
3603
|
+
delete: (customerId: number, customerTagsUid: number) => Promise<BaseResponse<CustomerTagsDeleteData>>;
|
|
3604
|
+
};
|
|
3605
|
+
};
|
|
3606
|
+
customerLanguage: {
|
|
3607
|
+
/**
|
|
3608
|
+
* List Customer Language Rows
|
|
3609
|
+
* Call: api.customers.customerLanguage.list(params)
|
|
3610
|
+
*
|
|
3611
|
+
* List customer language rows as Augur holds them locally
|
|
3612
|
+
*
|
|
3613
|
+
* Errors:
|
|
3614
|
+
* 400: CustomerId is not a number, or orderBy is not one customer_language column with ASC or
|
|
3615
|
+
* DESC.
|
|
3616
|
+
*
|
|
3617
|
+
* GET https://customers.augur-api.com/customer-language
|
|
3618
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1customer-language/get
|
|
3619
|
+
*
|
|
3620
|
+
* @param params CustomerLanguageListParams (query string)
|
|
3621
|
+
* @returns BaseResponse whose `data` is CustomerLanguageListData
|
|
3622
|
+
*/
|
|
3623
|
+
list: (params?: CustomerLanguageListParams) => Promise<BaseResponse<CustomerLanguageListData>>;
|
|
3624
|
+
/**
|
|
3625
|
+
* Get Customer Language
|
|
3626
|
+
* Call: api.customers.customerLanguage.get(customerLanguageUid)
|
|
3627
|
+
*
|
|
3628
|
+
* Get one customer language row as Augur holds it locally
|
|
3629
|
+
*
|
|
3630
|
+
* Errors:
|
|
3631
|
+
* 404: No customer language row with this customerLanguageUid.
|
|
3632
|
+
*
|
|
3633
|
+
* GET https://customers.augur-api.com/customer-language/{customerLanguageUid}
|
|
3634
|
+
* Contract:
|
|
3635
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer-language~1{customerLanguageUid}/get
|
|
3636
|
+
*
|
|
3637
|
+
* @param customerLanguageUid Customer language key (customer_language.customer_language_uid)
|
|
3638
|
+
* @param params CustomerLanguageGetParams (query string)
|
|
3639
|
+
* @returns BaseResponse whose `data` is CustomerLanguageGetData
|
|
3640
|
+
*/
|
|
3641
|
+
get: (customerLanguageUid: number, params?: CustomerLanguageGetParams) => Promise<BaseResponse<CustomerLanguageGetData>>;
|
|
3642
|
+
};
|
|
3643
|
+
customerUd: {
|
|
3644
|
+
/**
|
|
3645
|
+
* List Customer Ud Rows
|
|
3646
|
+
* Call: api.customers.customerUd.list(params)
|
|
3647
|
+
*
|
|
3648
|
+
* List customer ud rows as Augur holds them locally
|
|
3649
|
+
*
|
|
3650
|
+
* Errors:
|
|
3651
|
+
* 400: CustomerId is not a number, or orderBy is not one customer_ud column with ASC or DESC.
|
|
3652
|
+
*
|
|
3653
|
+
* GET https://customers.augur-api.com/customer-ud
|
|
3654
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1customer-ud/get
|
|
3655
|
+
*
|
|
3656
|
+
* @param params CustomerUdListParams (query string)
|
|
3657
|
+
* @returns BaseResponse whose `data` is CustomerUdListData
|
|
3658
|
+
*/
|
|
3659
|
+
list: (params?: CustomerUdListParams) => Promise<BaseResponse<CustomerUdListData>>;
|
|
3660
|
+
/**
|
|
3661
|
+
* Get Customer Ud
|
|
3662
|
+
* Call: api.customers.customerUd.get(customerUdUid)
|
|
3663
|
+
*
|
|
3664
|
+
* Get one customer ud row as Augur holds it locally
|
|
3665
|
+
*
|
|
3666
|
+
* Errors:
|
|
3667
|
+
* 404: No customer ud row with this customerUdUid.
|
|
3668
|
+
*
|
|
3669
|
+
* GET https://customers.augur-api.com/customer-ud/{customerUdUid}
|
|
3670
|
+
* Contract:
|
|
3671
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer-ud~1{customerUdUid}/get
|
|
3672
|
+
*
|
|
3673
|
+
* @param customerUdUid Customer ud key (customer_ud.customer_ud_uid)
|
|
3674
|
+
* @param params CustomerUdGetParams (query string)
|
|
3675
|
+
* @returns BaseResponse whose `data` is CustomerUdGetData
|
|
3676
|
+
*/
|
|
3677
|
+
get: (customerUdUid: number, params?: CustomerUdGetParams) => Promise<BaseResponse<CustomerUdGetData>>;
|
|
3678
|
+
};
|
|
3679
|
+
customerXRestrictedClass: {
|
|
3680
|
+
/**
|
|
3681
|
+
* List Customer X Restricted Class Rows
|
|
3682
|
+
* Call: api.customers.customerXRestrictedClass.list(params)
|
|
3683
|
+
*
|
|
3684
|
+
* List customer x restricted class rows as Augur holds them locally
|
|
3685
|
+
*
|
|
3686
|
+
* Errors:
|
|
3687
|
+
* 400: CustomerId or restrictedClassUid is not a number, or orderBy is not one
|
|
3688
|
+
* customer_x_restricted_class column with ASC or DESC.
|
|
3689
|
+
*
|
|
3690
|
+
* GET https://customers.augur-api.com/customer-x-restricted-class
|
|
3691
|
+
* Contract:
|
|
3692
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer-x-restricted-class/get
|
|
3693
|
+
*
|
|
3694
|
+
* @param params CustomerXRestrictedClassListParams (query string)
|
|
3695
|
+
* @returns BaseResponse whose `data` is CustomerXRestrictedClassListData
|
|
3696
|
+
*/
|
|
3697
|
+
list: (params?: CustomerXRestrictedClassListParams) => Promise<BaseResponse<CustomerXRestrictedClassListData>>;
|
|
3698
|
+
/**
|
|
3699
|
+
* Get Customer X Restricted Class
|
|
3700
|
+
* Call: api.customers.customerXRestrictedClass.get(customerXRestrictedClassUid)
|
|
3701
|
+
*
|
|
3702
|
+
* Get one customer x restricted class row as Augur holds it locally
|
|
3703
|
+
*
|
|
3704
|
+
* Errors:
|
|
3705
|
+
* 404: No customer x restricted class row with this customerXRestrictedClassUid.
|
|
3706
|
+
*
|
|
3707
|
+
* GET https://customers.augur-api.com/customer-x-restricted-class/{customerXRestrictedClassUid}
|
|
3708
|
+
* Contract:
|
|
3709
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer-x-restricted-class~1{customerXRestrictedClassUid}/get
|
|
3710
|
+
*
|
|
3711
|
+
* @param customerXRestrictedClassUid Customer x restricted class key
|
|
3712
|
+
* (customer_x_restricted_class.customer_x_restricted_class_uid)
|
|
3713
|
+
* @param params CustomerXRestrictedClassGetParams (query string)
|
|
3714
|
+
* @returns BaseResponse whose `data` is CustomerXRestrictedClassGetData
|
|
3715
|
+
*/
|
|
3716
|
+
get: (customerXRestrictedClassUid: number, params?: CustomerXRestrictedClassGetParams) => Promise<BaseResponse<CustomerXRestrictedClassGetData>>;
|
|
3717
|
+
};
|
|
3718
|
+
customerXRewardsProgram: {
|
|
3719
|
+
/**
|
|
3720
|
+
* List Customer X Rewards Program Rows
|
|
3721
|
+
* Call: api.customers.customerXRewardsProgram.list(params)
|
|
3722
|
+
*
|
|
3723
|
+
* List customer x rewards program rows as Augur holds them locally
|
|
3724
|
+
*
|
|
3725
|
+
* Errors:
|
|
3726
|
+
* 400: A filter is not a number, or orderBy is not one field|ASC or field|DESC on a
|
|
3727
|
+
* customer_x_rewards_program column.
|
|
3728
|
+
*
|
|
3729
|
+
* GET https://customers.augur-api.com/customer-x-rewards-program
|
|
3730
|
+
* Contract:
|
|
3731
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer-x-rewards-program/get
|
|
3732
|
+
*
|
|
3733
|
+
* @param params CustomerXRewardsProgramListParams (query string)
|
|
3734
|
+
* @returns BaseResponse whose `data` is CustomerXRewardsProgramListData
|
|
3735
|
+
*/
|
|
3736
|
+
list: (params?: CustomerXRewardsProgramListParams) => Promise<BaseResponse<CustomerXRewardsProgramListData>>;
|
|
3737
|
+
/**
|
|
3738
|
+
* Get Customer X Rewards Program
|
|
3739
|
+
* Call: api.customers.customerXRewardsProgram.get(customerXRewardsProgramUid)
|
|
3740
|
+
*
|
|
3741
|
+
* Get one customer x rewards program row as Augur holds it locally
|
|
3742
|
+
*
|
|
3743
|
+
* Errors:
|
|
3744
|
+
* 404: No customer x rewards program row with this customerXRewardsProgramUid.
|
|
3745
|
+
*
|
|
3746
|
+
* GET https://customers.augur-api.com/customer-x-rewards-program/{customerXRewardsProgramUid}
|
|
3747
|
+
* Contract:
|
|
3748
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1customer-x-rewards-program~1{customerXRewardsProgramUid}/get
|
|
3749
|
+
*
|
|
3750
|
+
* @param customerXRewardsProgramUid Customer x rewards program key
|
|
3751
|
+
* (customer_x_rewards_program.customer_x_rewards_program_uid)
|
|
3752
|
+
* @param params CustomerXRewardsProgramGetParams (query string)
|
|
3753
|
+
* @returns BaseResponse whose `data` is CustomerXRewardsProgramGetData
|
|
3754
|
+
*/
|
|
3755
|
+
get: (customerXRewardsProgramUid: number, params?: CustomerXRewardsProgramGetParams) => Promise<BaseResponse<CustomerXRewardsProgramGetData>>;
|
|
3756
|
+
};
|
|
3757
|
+
oeContactsCustomer: {
|
|
3758
|
+
/**
|
|
3759
|
+
* List Oe Contacts Customer Rows
|
|
3760
|
+
* Call: api.customers.oeContactsCustomer.list(params)
|
|
3761
|
+
*
|
|
3762
|
+
* List oe contacts customer rows as Augur holds them locally
|
|
3763
|
+
*
|
|
3764
|
+
* Errors:
|
|
3765
|
+
* 400: DeleteFlag is not Y or N, or customerId or shopperUid is not a number, or orderBy is
|
|
3766
|
+
* not one oe_contacts_customer column with ASC or DESC.
|
|
3767
|
+
*
|
|
3768
|
+
* GET https://customers.augur-api.com/oe-contacts-customer
|
|
3769
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1oe-contacts-customer/get
|
|
3770
|
+
*
|
|
3771
|
+
* @param params OeContactsCustomerListParams (query string)
|
|
3772
|
+
* @returns BaseResponse whose `data` is OeContactsCustomerListData
|
|
3773
|
+
*/
|
|
3774
|
+
list: (params?: OeContactsCustomerListParams) => Promise<BaseResponse<OeContactsCustomerListData>>;
|
|
3775
|
+
};
|
|
3776
|
+
rewardsProgram: {
|
|
3777
|
+
/**
|
|
3778
|
+
* List Rewards Program Rows
|
|
3779
|
+
* Call: api.customers.rewardsProgram.list(params)
|
|
3780
|
+
*
|
|
3781
|
+
* List rewards program rows as Augur holds them locally
|
|
3782
|
+
*
|
|
3783
|
+
* Errors:
|
|
3784
|
+
* 400: DealerTypeUid or supplierId or mafSurchargeOcInvMastUid is not a number, or orderBy is
|
|
3785
|
+
* not one rewards_program column with ASC or DESC.
|
|
3786
|
+
*
|
|
3787
|
+
* GET https://customers.augur-api.com/rewards-program
|
|
3788
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1rewards-program/get
|
|
3789
|
+
*
|
|
3790
|
+
* @param params RewardsProgramListParams (query string)
|
|
3791
|
+
* @returns BaseResponse whose `data` is RewardsProgramListData
|
|
3792
|
+
*/
|
|
3793
|
+
list: (params?: RewardsProgramListParams) => Promise<BaseResponse<RewardsProgramListData>>;
|
|
3794
|
+
/**
|
|
3795
|
+
* Get Rewards Program
|
|
3796
|
+
* Call: api.customers.rewardsProgram.get(rewardsProgramUid)
|
|
3797
|
+
*
|
|
3798
|
+
* Get one rewards program row as Augur holds it locally
|
|
3799
|
+
*
|
|
3800
|
+
* Errors:
|
|
3801
|
+
* 404: No rewards program row with this rewardsProgramUid.
|
|
3802
|
+
*
|
|
3803
|
+
* GET https://customers.augur-api.com/rewards-program/{rewardsProgramUid}
|
|
3804
|
+
* Contract:
|
|
3805
|
+
* https://customers.augur-api.com/openapi.json#/paths/~1rewards-program~1{rewardsProgramUid}/get
|
|
3806
|
+
*
|
|
3807
|
+
* @param rewardsProgramUid Rewards program key (rewards_program.rewards_program_uid)
|
|
3808
|
+
* @param params RewardsProgramGetParams (query string)
|
|
3809
|
+
* @returns BaseResponse whose `data` is RewardsProgramGetData
|
|
3810
|
+
*/
|
|
3811
|
+
get: (rewardsProgramUid: number, params?: RewardsProgramGetParams) => Promise<BaseResponse<RewardsProgramGetData>>;
|
|
3812
|
+
};
|
|
3813
|
+
shipToUd: {
|
|
3814
|
+
/**
|
|
3815
|
+
* List Ship To Ud Rows
|
|
3816
|
+
* Call: api.customers.shipToUd.list(params)
|
|
3817
|
+
*
|
|
3818
|
+
* List ship to ud rows as Augur holds them locally
|
|
3819
|
+
*
|
|
3820
|
+
* Errors:
|
|
3821
|
+
* 400: ShipToId is not a number, or orderBy is not one ship_to_ud column with ASC or DESC.
|
|
3822
|
+
*
|
|
3823
|
+
* GET https://customers.augur-api.com/ship-to-ud
|
|
3824
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1ship-to-ud/get
|
|
3825
|
+
*
|
|
3826
|
+
* @param params ShipToUdListParams (query string)
|
|
3827
|
+
* @returns BaseResponse whose `data` is ShipToUdListData
|
|
3828
|
+
*/
|
|
3829
|
+
list: (params?: ShipToUdListParams) => Promise<BaseResponse<ShipToUdListData>>;
|
|
3830
|
+
/**
|
|
3831
|
+
* Get Ship To Ud
|
|
3832
|
+
* Call: api.customers.shipToUd.get(shipToUdUid)
|
|
3833
|
+
*
|
|
3834
|
+
* Get one ship to ud row as Augur holds it locally
|
|
3835
|
+
*
|
|
3836
|
+
* Errors:
|
|
3837
|
+
* 404: No ship to ud row with this shipToUdUid.
|
|
3838
|
+
*
|
|
3839
|
+
* GET https://customers.augur-api.com/ship-to-ud/{shipToUdUid}
|
|
3840
|
+
* Contract: https://customers.augur-api.com/openapi.json#/paths/~1ship-to-ud~1{shipToUdUid}/get
|
|
3841
|
+
*
|
|
3842
|
+
* @param shipToUdUid Ship to ud key (ship_to_ud.ship_to_ud_uid)
|
|
3843
|
+
* @param params ShipToUdGetParams (query string)
|
|
3844
|
+
* @returns BaseResponse whose `data` is ShipToUdGetData
|
|
3845
|
+
*/
|
|
3846
|
+
get: (shipToUdUid: number, params?: ShipToUdGetParams) => Promise<BaseResponse<ShipToUdGetData>>;
|
|
3847
|
+
};
|
|
3848
|
+
}
|
|
3849
|
+
//# sourceMappingURL=types.d.ts.map
|