@simpleapps-com/augur-api 2026.10.31 → 2026.11.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +85 -34
- package/SKILL.md +25 -24
- package/dist/client.d.ts +336 -0
- package/dist/client.d.ts.map +1 -0
- package/dist/core/base-client.d.ts +159 -0
- package/dist/core/base-client.d.ts.map +1 -0
- package/dist/core/call-rules.d.ts +73 -0
- package/dist/core/call-rules.d.ts.map +1 -0
- package/dist/core/call.d.ts +48 -0
- package/dist/core/call.d.ts.map +1 -0
- package/dist/core/client.d.ts +112 -0
- package/dist/core/client.d.ts.map +1 -0
- package/dist/core/common-schemas.d.ts +522 -0
- package/dist/core/common-schemas.d.ts.map +1 -0
- package/dist/core/config.d.ts +72 -0
- package/dist/core/config.d.ts.map +1 -0
- package/dist/core/encoded-segment.d.ts +23 -0
- package/dist/core/encoded-segment.d.ts.map +1 -0
- package/dist/core/errors.d.ts +91 -0
- package/dist/core/errors.d.ts.map +1 -0
- package/dist/core/http-rules.d.ts +64 -0
- package/dist/core/http-rules.d.ts.map +1 -0
- package/dist/core/path-validation.d.ts +28 -0
- package/dist/core/path-validation.d.ts.map +1 -0
- package/dist/core/proxy-rules.d.ts +21 -0
- package/dist/core/proxy-rules.d.ts.map +1 -0
- package/dist/core/registry-rules.d.ts +15 -0
- package/dist/core/registry-rules.d.ts.map +1 -0
- package/dist/core/registry-tables.d.ts +3 -0
- package/dist/core/registry-tables.d.ts.map +1 -0
- package/dist/core/registry.d.ts +54 -0
- package/dist/core/registry.d.ts.map +1 -0
- package/dist/core/response-rules.d.ts +26 -0
- package/dist/core/response-rules.d.ts.map +1 -0
- package/dist/core/schemas.d.ts +71 -0
- package/dist/core/schemas.d.ts.map +1 -0
- package/dist/core/service-proxy.d.ts +81 -0
- package/dist/core/service-proxy.d.ts.map +1 -0
- package/dist/core/site-id-check.d.ts +6 -0
- package/dist/core/site-id-check.d.ts.map +1 -0
- package/dist/core/site-id.d.ts +15 -0
- package/dist/core/site-id.d.ts.map +1 -0
- package/dist/index.d.ts +71 -236
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +19565 -18212
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +19564 -18212
- package/dist/index.mjs.map +1 -1
- package/dist/services/agr-info/client.d.ts +71 -0
- package/dist/services/agr-info/client.d.ts.map +1 -0
- package/dist/services/agr-info/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-info/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-info/generated/schemas.d.ts +299 -0
- package/dist/services/agr-info/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-info/generated/types.d.ts +1111 -0
- package/dist/services/agr-info/generated/types.d.ts.map +1 -0
- package/dist/services/agr-info/index.d.ts +2 -0
- package/dist/services/agr-info/index.d.ts.map +1 -0
- package/dist/services/agr-int/client.d.ts +100 -0
- package/dist/services/agr-int/client.d.ts.map +1 -0
- package/dist/services/agr-int/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-int/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-int/generated/schemas.d.ts +595 -0
- package/dist/services/agr-int/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-int/generated/types.d.ts +1984 -0
- package/dist/services/agr-int/generated/types.d.ts.map +1 -0
- package/dist/services/agr-int/index.d.ts +2 -0
- package/dist/services/agr-int/index.d.ts.map +1 -0
- package/dist/services/agr-site/client.d.ts +112 -0
- package/dist/services/agr-site/client.d.ts.map +1 -0
- package/dist/services/agr-site/generated/endpoints.d.ts +42 -0
- package/dist/services/agr-site/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-site/generated/schemas.d.ts +537 -0
- package/dist/services/agr-site/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-site/generated/types.d.ts +1732 -0
- package/dist/services/agr-site/generated/types.d.ts.map +1 -0
- package/dist/services/agr-site/index.d.ts +2 -0
- package/dist/services/agr-site/index.d.ts.map +1 -0
- package/dist/services/agr-work/client.d.ts +23 -0
- package/dist/services/agr-work/client.d.ts.map +1 -0
- package/dist/services/agr-work/generated/endpoints.d.ts +41 -0
- package/dist/services/agr-work/generated/endpoints.d.ts.map +1 -0
- package/dist/services/agr-work/generated/schemas.d.ts +21 -0
- package/dist/services/agr-work/generated/schemas.d.ts.map +1 -0
- package/dist/services/agr-work/generated/types.d.ts +19 -0
- package/dist/services/agr-work/generated/types.d.ts.map +1 -0
- package/dist/services/agr-work/index.d.ts +2 -0
- package/dist/services/agr-work/index.d.ts.map +1 -0
- package/dist/services/avalara/client.d.ts +33 -0
- package/dist/services/avalara/client.d.ts.map +1 -0
- package/dist/services/avalara/generated/endpoints.d.ts +41 -0
- package/dist/services/avalara/generated/endpoints.d.ts.map +1 -0
- package/dist/services/avalara/generated/schemas.d.ts +22 -0
- package/dist/services/avalara/generated/schemas.d.ts.map +1 -0
- package/dist/services/avalara/generated/types.d.ts +103 -0
- package/dist/services/avalara/generated/types.d.ts.map +1 -0
- package/dist/services/avalara/index.d.ts +2 -0
- package/dist/services/avalara/index.d.ts.map +1 -0
- package/dist/services/basecamp2/client.d.ts +92 -0
- package/dist/services/basecamp2/client.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts +42 -0
- package/dist/services/basecamp2/generated/endpoints.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/schemas.d.ts +845 -0
- package/dist/services/basecamp2/generated/schemas.d.ts.map +1 -0
- package/dist/services/basecamp2/generated/types.d.ts +1587 -0
- package/dist/services/basecamp2/generated/types.d.ts.map +1 -0
- package/dist/services/basecamp2/index.d.ts +2 -0
- package/dist/services/basecamp2/index.d.ts.map +1 -0
- package/dist/services/brand-folder/client.d.ts +37 -0
- package/dist/services/brand-folder/client.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts +41 -0
- package/dist/services/brand-folder/generated/endpoints.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/schemas.d.ts +81 -0
- package/dist/services/brand-folder/generated/schemas.d.ts.map +1 -0
- package/dist/services/brand-folder/generated/types.d.ts +195 -0
- package/dist/services/brand-folder/generated/types.d.ts.map +1 -0
- package/dist/services/brand-folder/index.d.ts +2 -0
- package/dist/services/brand-folder/index.d.ts.map +1 -0
- package/dist/services/commerce/client.d.ts +57 -0
- package/dist/services/commerce/client.d.ts.map +1 -0
- package/dist/services/commerce/generated/endpoints.d.ts +42 -0
- package/dist/services/commerce/generated/endpoints.d.ts.map +1 -0
- package/dist/services/commerce/generated/schemas.d.ts +319 -0
- package/dist/services/commerce/generated/schemas.d.ts.map +1 -0
- package/dist/services/commerce/generated/types.d.ts +1134 -0
- package/dist/services/commerce/generated/types.d.ts.map +1 -0
- package/dist/services/commerce/index.d.ts +2 -0
- package/dist/services/commerce/index.d.ts.map +1 -0
- package/dist/services/customers/client.d.ts +162 -0
- package/dist/services/customers/client.d.ts.map +1 -0
- package/dist/services/customers/generated/endpoints.d.ts +42 -0
- package/dist/services/customers/generated/endpoints.d.ts.map +1 -0
- package/dist/services/customers/generated/schemas.d.ts +1970 -0
- package/dist/services/customers/generated/schemas.d.ts.map +1 -0
- package/dist/services/customers/generated/types.d.ts +3849 -0
- package/dist/services/customers/generated/types.d.ts.map +1 -0
- package/dist/services/customers/index.d.ts +2 -0
- package/dist/services/customers/index.d.ts.map +1 -0
- package/dist/services/goog-mc/client.d.ts +44 -0
- package/dist/services/goog-mc/client.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts +42 -0
- package/dist/services/goog-mc/generated/endpoints.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/schemas.d.ts +175 -0
- package/dist/services/goog-mc/generated/schemas.d.ts.map +1 -0
- package/dist/services/goog-mc/generated/types.d.ts +361 -0
- package/dist/services/goog-mc/generated/types.d.ts.map +1 -0
- package/dist/services/goog-mc/index.d.ts +2 -0
- package/dist/services/goog-mc/index.d.ts.map +1 -0
- package/dist/services/gregorovich/client.d.ts +34 -0
- package/dist/services/gregorovich/client.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts +42 -0
- package/dist/services/gregorovich/generated/endpoints.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/schemas.d.ts +35 -0
- package/dist/services/gregorovich/generated/schemas.d.ts.map +1 -0
- package/dist/services/gregorovich/generated/types.d.ts +70 -0
- package/dist/services/gregorovich/generated/types.d.ts.map +1 -0
- package/dist/services/gregorovich/index.d.ts +2 -0
- package/dist/services/gregorovich/index.d.ts.map +1 -0
- package/dist/services/items/client.d.ts +453 -0
- package/dist/services/items/client.d.ts.map +1 -0
- package/dist/services/items/generated/endpoints.d.ts +42 -0
- package/dist/services/items/generated/endpoints.d.ts.map +1 -0
- package/dist/services/items/generated/schemas.d.ts +4636 -0
- package/dist/services/items/generated/schemas.d.ts.map +1 -0
- package/dist/services/items/generated/types.d.ts +10513 -0
- package/dist/services/items/generated/types.d.ts.map +1 -0
- package/dist/services/items/index.d.ts +2 -0
- package/dist/services/items/index.d.ts.map +1 -0
- package/dist/services/joomla/client.d.ts +74 -0
- package/dist/services/joomla/client.d.ts.map +1 -0
- package/dist/services/joomla/generated/endpoints.d.ts +41 -0
- package/dist/services/joomla/generated/endpoints.d.ts.map +1 -0
- package/dist/services/joomla/generated/schemas.d.ts +550 -0
- package/dist/services/joomla/generated/schemas.d.ts.map +1 -0
- package/dist/services/joomla/generated/types.d.ts +1502 -0
- package/dist/services/joomla/generated/types.d.ts.map +1 -0
- package/dist/services/joomla/index.d.ts +2 -0
- package/dist/services/joomla/index.d.ts.map +1 -0
- package/dist/services/legacy/client.d.ts +75 -0
- package/dist/services/legacy/client.d.ts.map +1 -0
- package/dist/services/legacy/generated/endpoints.d.ts +41 -0
- package/dist/services/legacy/generated/endpoints.d.ts.map +1 -0
- package/dist/services/legacy/generated/schemas.d.ts +567 -0
- package/dist/services/legacy/generated/schemas.d.ts.map +1 -0
- package/dist/services/legacy/generated/types.d.ts +1454 -0
- package/dist/services/legacy/generated/types.d.ts.map +1 -0
- package/dist/services/legacy/index.d.ts +2 -0
- package/dist/services/legacy/index.d.ts.map +1 -0
- package/dist/services/logistics/client.d.ts +64 -0
- package/dist/services/logistics/client.d.ts.map +1 -0
- package/dist/services/logistics/generated/endpoints.d.ts +41 -0
- package/dist/services/logistics/generated/endpoints.d.ts.map +1 -0
- package/dist/services/logistics/generated/schemas.d.ts +375 -0
- package/dist/services/logistics/generated/schemas.d.ts.map +1 -0
- package/dist/services/logistics/generated/types.d.ts +925 -0
- package/dist/services/logistics/generated/types.d.ts.map +1 -0
- package/dist/services/logistics/index.d.ts +2 -0
- package/dist/services/logistics/index.d.ts.map +1 -0
- package/dist/services/markets/client.d.ts +47 -0
- package/dist/services/markets/client.d.ts.map +1 -0
- package/dist/services/markets/generated/endpoints.d.ts +41 -0
- package/dist/services/markets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/markets/generated/schemas.d.ts +180 -0
- package/dist/services/markets/generated/schemas.d.ts.map +1 -0
- package/dist/services/markets/generated/types.d.ts +405 -0
- package/dist/services/markets/generated/types.d.ts.map +1 -0
- package/dist/services/markets/index.d.ts +2 -0
- package/dist/services/markets/index.d.ts.map +1 -0
- package/dist/services/notifications/client.d.ts +58 -0
- package/dist/services/notifications/client.d.ts.map +1 -0
- package/dist/services/notifications/generated/endpoints.d.ts +41 -0
- package/dist/services/notifications/generated/endpoints.d.ts.map +1 -0
- package/dist/services/notifications/generated/schemas.d.ts +247 -0
- package/dist/services/notifications/generated/schemas.d.ts.map +1 -0
- package/dist/services/notifications/generated/types.d.ts +666 -0
- package/dist/services/notifications/generated/types.d.ts.map +1 -0
- package/dist/services/notifications/index.d.ts +2 -0
- package/dist/services/notifications/index.d.ts.map +1 -0
- package/dist/services/open-search/client.d.ts +69 -0
- package/dist/services/open-search/client.d.ts.map +1 -0
- package/dist/services/open-search/generated/endpoints.d.ts +42 -0
- package/dist/services/open-search/generated/endpoints.d.ts.map +1 -0
- package/dist/services/open-search/generated/schemas.d.ts +363 -0
- package/dist/services/open-search/generated/schemas.d.ts.map +1 -0
- package/dist/services/open-search/generated/types.d.ts +983 -0
- package/dist/services/open-search/generated/types.d.ts.map +1 -0
- package/dist/services/open-search/index.d.ts +2 -0
- package/dist/services/open-search/index.d.ts.map +1 -0
- package/dist/services/orders/client.d.ts +180 -0
- package/dist/services/orders/client.d.ts.map +1 -0
- package/dist/services/orders/generated/endpoints.d.ts +42 -0
- package/dist/services/orders/generated/endpoints.d.ts.map +1 -0
- package/dist/services/orders/generated/schemas.d.ts +2479 -0
- package/dist/services/orders/generated/schemas.d.ts.map +1 -0
- package/dist/services/orders/generated/types.d.ts +4717 -0
- package/dist/services/orders/generated/types.d.ts.map +1 -0
- package/dist/services/orders/index.d.ts +2 -0
- package/dist/services/orders/index.d.ts.map +1 -0
- package/dist/services/p21-apis/client.d.ts +59 -0
- package/dist/services/p21-apis/client.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-apis/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/schemas.d.ts +46 -0
- package/dist/services/p21-apis/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-apis/generated/types.d.ts +246 -0
- package/dist/services/p21-apis/generated/types.d.ts.map +1 -0
- package/dist/services/p21-apis/index.d.ts +2 -0
- package/dist/services/p21-apis/index.d.ts.map +1 -0
- package/dist/services/p21-core/client.d.ts +131 -0
- package/dist/services/p21-core/client.d.ts.map +1 -0
- package/dist/services/p21-core/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-core/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-core/generated/schemas.d.ts +1478 -0
- package/dist/services/p21-core/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-core/generated/types.d.ts +2718 -0
- package/dist/services/p21-core/generated/types.d.ts.map +1 -0
- package/dist/services/p21-core/index.d.ts +2 -0
- package/dist/services/p21-core/index.d.ts.map +1 -0
- package/dist/services/p21-pim/client.d.ts +75 -0
- package/dist/services/p21-pim/client.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts +41 -0
- package/dist/services/p21-pim/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/schemas.d.ts +383 -0
- package/dist/services/p21-pim/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-pim/generated/types.d.ts +933 -0
- package/dist/services/p21-pim/generated/types.d.ts.map +1 -0
- package/dist/services/p21-pim/index.d.ts +2 -0
- package/dist/services/p21-pim/index.d.ts.map +1 -0
- package/dist/services/p21-sism/client.d.ts +432 -0
- package/dist/services/p21-sism/client.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts +42 -0
- package/dist/services/p21-sism/generated/endpoints.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/schemas.d.ts +2844 -0
- package/dist/services/p21-sism/generated/schemas.d.ts.map +1 -0
- package/dist/services/p21-sism/generated/types.d.ts +6977 -0
- package/dist/services/p21-sism/generated/types.d.ts.map +1 -0
- package/dist/services/p21-sism/index.d.ts +37 -0
- package/dist/services/p21-sism/index.d.ts.map +1 -0
- package/dist/services/payments/client.d.ts +77 -0
- package/dist/services/payments/client.d.ts.map +1 -0
- package/dist/services/payments/generated/endpoints.d.ts +42 -0
- package/dist/services/payments/generated/endpoints.d.ts.map +1 -0
- package/dist/services/payments/generated/schemas.d.ts +1015 -0
- package/dist/services/payments/generated/schemas.d.ts.map +1 -0
- package/dist/services/payments/generated/types.d.ts +1432 -0
- package/dist/services/payments/generated/types.d.ts.map +1 -0
- package/dist/services/payments/index.d.ts +2 -0
- package/dist/services/payments/index.d.ts.map +1 -0
- package/dist/services/pricing/client.d.ts +216 -0
- package/dist/services/pricing/client.d.ts.map +1 -0
- package/dist/services/pricing/generated/endpoints.d.ts +42 -0
- package/dist/services/pricing/generated/endpoints.d.ts.map +1 -0
- package/dist/services/pricing/generated/schemas.d.ts +2048 -0
- package/dist/services/pricing/generated/schemas.d.ts.map +1 -0
- package/dist/services/pricing/generated/types.d.ts +4257 -0
- package/dist/services/pricing/generated/types.d.ts.map +1 -0
- package/dist/services/pricing/index.d.ts +2 -0
- package/dist/services/pricing/index.d.ts.map +1 -0
- package/dist/services/shipping/client.d.ts +33 -0
- package/dist/services/shipping/client.d.ts.map +1 -0
- package/dist/services/shipping/generated/endpoints.d.ts +41 -0
- package/dist/services/shipping/generated/endpoints.d.ts.map +1 -0
- package/dist/services/shipping/generated/schemas.d.ts +29 -0
- package/dist/services/shipping/generated/schemas.d.ts.map +1 -0
- package/dist/services/shipping/generated/types.d.ts +116 -0
- package/dist/services/shipping/generated/types.d.ts.map +1 -0
- package/dist/services/shipping/index.d.ts +2 -0
- package/dist/services/shipping/index.d.ts.map +1 -0
- package/dist/services/smarty-streets/client.d.ts +33 -0
- package/dist/services/smarty-streets/client.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts +41 -0
- package/dist/services/smarty-streets/generated/endpoints.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts +72 -0
- package/dist/services/smarty-streets/generated/schemas.d.ts.map +1 -0
- package/dist/services/smarty-streets/generated/types.d.ts +145 -0
- package/dist/services/smarty-streets/generated/types.d.ts.map +1 -0
- package/dist/services/smarty-streets/index.d.ts +2 -0
- package/dist/services/smarty-streets/index.d.ts.map +1 -0
- package/dist/services/ups/client.d.ts +32 -0
- package/dist/services/ups/client.d.ts.map +1 -0
- package/dist/services/ups/generated/endpoints.d.ts +40 -0
- package/dist/services/ups/generated/endpoints.d.ts.map +1 -0
- package/dist/services/ups/generated/schemas.d.ts +51 -0
- package/dist/services/ups/generated/schemas.d.ts.map +1 -0
- package/dist/services/ups/generated/types.d.ts +98 -0
- package/dist/services/ups/generated/types.d.ts.map +1 -0
- package/dist/services/ups/index.d.ts +2 -0
- package/dist/services/ups/index.d.ts.map +1 -0
- package/dist/services/vendors/client.d.ts +38 -0
- package/dist/services/vendors/client.d.ts.map +1 -0
- package/dist/services/vendors/generated/endpoints.d.ts +41 -0
- package/dist/services/vendors/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vendors/generated/schemas.d.ts +350 -0
- package/dist/services/vendors/generated/schemas.d.ts.map +1 -0
- package/dist/services/vendors/generated/types.d.ts +470 -0
- package/dist/services/vendors/generated/types.d.ts.map +1 -0
- package/dist/services/vendors/index.d.ts +2 -0
- package/dist/services/vendors/index.d.ts.map +1 -0
- package/dist/services/vmi/client.d.ts +129 -0
- package/dist/services/vmi/client.d.ts.map +1 -0
- package/dist/services/vmi/generated/endpoints.d.ts +41 -0
- package/dist/services/vmi/generated/endpoints.d.ts.map +1 -0
- package/dist/services/vmi/generated/schemas.d.ts +723 -0
- package/dist/services/vmi/generated/schemas.d.ts.map +1 -0
- package/dist/services/vmi/generated/types.d.ts +2620 -0
- package/dist/services/vmi/generated/types.d.ts.map +1 -0
- package/dist/services/vmi/index.d.ts +2 -0
- package/dist/services/vmi/index.d.ts.map +1 -0
- package/dist/testing.d.ts +9 -13
- package/dist/testing.d.ts.map +1 -0
- package/dist/testing.js +7 -17
- package/dist/testing.js.map +1 -1
- package/dist/testing.mjs +7 -17
- package/dist/testing.mjs.map +1 -1
- package/dist/utils/cross-site-auth.d.ts +88 -0
- package/dist/utils/cross-site-auth.d.ts.map +1 -0
- package/package.json +30 -47
- package/dist/client-TPJa269Y.d.mts +0 -58610
- package/dist/client-TPJa269Y.d.ts +0 -58610
- package/dist/index.d.mts +0 -236
- package/dist/testing.d.mts +0 -83
|
@@ -0,0 +1,2620 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Generated types for the vmi service.
|
|
3
|
+
* Vendor-managed inventory for distributor profiles, warehouse stock levels, restocking, and usage
|
|
4
|
+
* tracking
|
|
5
|
+
*
|
|
6
|
+
* Public specs (the source of truth for every shape below):
|
|
7
|
+
* https://vmi.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://vmi.augur-api.com/openapi.json: the full contract: request and response bodies field by
|
|
11
|
+
* field, descriptions, formats and documented errors.
|
|
12
|
+
* https://vmi.augur-api.com/llms.txt: the plain-text endpoint list and the other Augur services.
|
|
13
|
+
*
|
|
14
|
+
* Source: shared/specs/vmi.json
|
|
15
|
+
*
|
|
16
|
+
* DO NOT EDIT — regenerate with: pnpm -C tools/augur-api-generator generate ts
|
|
17
|
+
*/
|
|
18
|
+
import type { EdgeCacheParams } from "../../../core/common-schemas";
|
|
19
|
+
import type { BaseResponse } from "../../../core/schemas";
|
|
20
|
+
/** Params for GET /distributors */
|
|
21
|
+
export interface DistributorsListParams extends EdgeCacheParams {
|
|
22
|
+
/** Prophet 21 customer to filter by */
|
|
23
|
+
customerId: number;
|
|
24
|
+
/** Limit number of results (Default: 10) */
|
|
25
|
+
limit?: number;
|
|
26
|
+
/** Starting offset results (Default: 0) */
|
|
27
|
+
offset?: number;
|
|
28
|
+
/** Order By (Default: distributors_uid|ASC) */
|
|
29
|
+
orderBy?: string;
|
|
30
|
+
/**
|
|
31
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
32
|
+
* (704,705); -1 for every status. Default: 704
|
|
33
|
+
*/
|
|
34
|
+
statusCd?: number | number[];
|
|
35
|
+
}
|
|
36
|
+
/** Params for GET /distributors/{distributorsUid} */
|
|
37
|
+
export type DistributorsGetParams = EdgeCacheParams;
|
|
38
|
+
/** Params for GET /inv-profile-hdr */
|
|
39
|
+
export interface InvProfileHdrListParams extends EdgeCacheParams {
|
|
40
|
+
/** Prophet 21 customer to filter by */
|
|
41
|
+
customerId: number;
|
|
42
|
+
/** Limit number of results (Default: 10) */
|
|
43
|
+
limit?: number;
|
|
44
|
+
/** Starting offset results (Default: 0) */
|
|
45
|
+
offset?: number;
|
|
46
|
+
/** Order By (Default: inv_profile_hdr_uid|ASC) */
|
|
47
|
+
orderBy?: string;
|
|
48
|
+
/**
|
|
49
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
50
|
+
* (704,705); -1 for every status. Default: every status
|
|
51
|
+
*/
|
|
52
|
+
statusCd?: number | number[];
|
|
53
|
+
}
|
|
54
|
+
/** Params for GET /inv-profile-hdr/{invProfileHdrUid} */
|
|
55
|
+
export type InvProfileHdrGetParams = EdgeCacheParams;
|
|
56
|
+
/** Params for GET /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line */
|
|
57
|
+
export interface InvProfileHdrInvProfileLineListParams extends EdgeCacheParams {
|
|
58
|
+
/** Limit number of results (Default: 10) */
|
|
59
|
+
limit?: number;
|
|
60
|
+
/** Starting offset results (Default: 0) */
|
|
61
|
+
offset?: number;
|
|
62
|
+
/** Order By (Default: inv_profile_line_uid|ASC) */
|
|
63
|
+
orderBy?: string;
|
|
64
|
+
/** Search keywords field */
|
|
65
|
+
q?: string;
|
|
66
|
+
/**
|
|
67
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
68
|
+
* (704,705); -1 for every status. Default: 704 and 705 (deleted lines excluded)
|
|
69
|
+
*/
|
|
70
|
+
statusCd?: number | number[];
|
|
71
|
+
}
|
|
72
|
+
/** Params for GET /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid} */
|
|
73
|
+
export type InvProfileHdrInvProfileLineGetParams = EdgeCacheParams;
|
|
74
|
+
/** Params for GET /products */
|
|
75
|
+
export interface ProductsListParams extends EdgeCacheParams {
|
|
76
|
+
/** customer.customer_id */
|
|
77
|
+
customerId: number;
|
|
78
|
+
/** Distributor to filter by */
|
|
79
|
+
distributorsUid: number;
|
|
80
|
+
/** Limit number of results (Default: 10) */
|
|
81
|
+
limit?: number;
|
|
82
|
+
/** Starting offset results (Default: 0) */
|
|
83
|
+
offset?: number;
|
|
84
|
+
/** Order By (Default: products_uid|ASC) */
|
|
85
|
+
orderBy?: string;
|
|
86
|
+
/** Product Id Prefix */
|
|
87
|
+
prefix?: string;
|
|
88
|
+
/** Query String */
|
|
89
|
+
q?: string;
|
|
90
|
+
/**
|
|
91
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
92
|
+
* (704,705); -1 for every status. Default: 704
|
|
93
|
+
*/
|
|
94
|
+
statusCd?: number | number[];
|
|
95
|
+
}
|
|
96
|
+
/** Params for GET /products/find */
|
|
97
|
+
export interface ProductsFindListParams extends EdgeCacheParams {
|
|
98
|
+
/** customer.customer_id */
|
|
99
|
+
customerId: number;
|
|
100
|
+
/** Limit number of results (Default: 10) */
|
|
101
|
+
limit?: number;
|
|
102
|
+
/** Starting offset results (Default: 0) */
|
|
103
|
+
offset?: number;
|
|
104
|
+
/** Product Id Prefix */
|
|
105
|
+
prefix?: string;
|
|
106
|
+
/**
|
|
107
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
108
|
+
* (704,705); -1 for every status. Default: 704
|
|
109
|
+
*/
|
|
110
|
+
statusCd?: number | number[];
|
|
111
|
+
}
|
|
112
|
+
/** Params for GET /products/{productsUid} */
|
|
113
|
+
export type ProductsGetParams = EdgeCacheParams;
|
|
114
|
+
/** Params for GET /restock-hdr */
|
|
115
|
+
export interface RestockHdrListParams extends EdgeCacheParams {
|
|
116
|
+
/** Filter by Distributor UID */
|
|
117
|
+
distributorsUid?: number;
|
|
118
|
+
/** Limit number of results (Default: 10) */
|
|
119
|
+
limit?: number;
|
|
120
|
+
/** Starting offset results (Default: 0) */
|
|
121
|
+
offset?: number;
|
|
122
|
+
/** Order By (Default: restock_hdr_uid|ASC) */
|
|
123
|
+
orderBy?: string;
|
|
124
|
+
/**
|
|
125
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
126
|
+
* (704,705); -1 for every status. Default: every status
|
|
127
|
+
*/
|
|
128
|
+
statusCd?: number | number[];
|
|
129
|
+
/** Filter by Warehouse UID */
|
|
130
|
+
warehouseUid?: number;
|
|
131
|
+
}
|
|
132
|
+
/** Params for GET /restock-hdr/{restockHdrUid} */
|
|
133
|
+
export type RestockHdrGetParams = EdgeCacheParams;
|
|
134
|
+
/** Params for GET /sections */
|
|
135
|
+
export interface SectionsListParams extends EdgeCacheParams {
|
|
136
|
+
/** Prophet 21 customer to filter by */
|
|
137
|
+
customerId: number;
|
|
138
|
+
/** Limit number of results (Default: 10) */
|
|
139
|
+
limit?: number;
|
|
140
|
+
/** Starting offset results (Default: 0) */
|
|
141
|
+
offset?: number;
|
|
142
|
+
/** Order By (Default: sections_uid|ASC) */
|
|
143
|
+
orderBy?: string;
|
|
144
|
+
/**
|
|
145
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
146
|
+
* (704,705); -1 for every status. Default: 704
|
|
147
|
+
*/
|
|
148
|
+
statusCd?: number | number[];
|
|
149
|
+
}
|
|
150
|
+
/** Params for GET /sections/{sectionsUid} */
|
|
151
|
+
export type SectionsGetParams = EdgeCacheParams;
|
|
152
|
+
/** Params for GET /warehouse */
|
|
153
|
+
export interface WarehouseListParams extends EdgeCacheParams {
|
|
154
|
+
/** Prophet 21 customer to filter by */
|
|
155
|
+
customerId: number;
|
|
156
|
+
/** Limit number of results (Default: 10) */
|
|
157
|
+
limit?: number;
|
|
158
|
+
/** Starting offset results (Default: 0) */
|
|
159
|
+
offset?: number;
|
|
160
|
+
/** Order By (Default: warehouse_uid|ASC) */
|
|
161
|
+
orderBy?: string;
|
|
162
|
+
/** Search Query */
|
|
163
|
+
q?: string;
|
|
164
|
+
/**
|
|
165
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
166
|
+
* (704,705); -1 for every status. Default: 704
|
|
167
|
+
*/
|
|
168
|
+
statusCd?: number | number[];
|
|
169
|
+
/** joomla.users.id; lists only the warehouses this user is assigned to */
|
|
170
|
+
usersId?: number;
|
|
171
|
+
}
|
|
172
|
+
/** Params for GET /warehouse/{warehouseUid} */
|
|
173
|
+
export type WarehouseGetParams = EdgeCacheParams;
|
|
174
|
+
/** Params for GET /warehouse/{warehouseUid}/availability */
|
|
175
|
+
export interface WarehouseAvailabilityListParams extends EdgeCacheParams {
|
|
176
|
+
/** search query */
|
|
177
|
+
q: string;
|
|
178
|
+
}
|
|
179
|
+
/** Params for GET /warehouse/{warehouseUid}/replenish */
|
|
180
|
+
export interface WarehouseReplenishListParams extends EdgeCacheParams {
|
|
181
|
+
/** Distributor to filter by; absent lists every distributor */
|
|
182
|
+
distributorsUid?: number;
|
|
183
|
+
}
|
|
184
|
+
/** Params for GET /warehouse/{warehouseUid}/users */
|
|
185
|
+
export interface WarehouseUsersListParams extends EdgeCacheParams {
|
|
186
|
+
/** Limit number of results (Default: 10) */
|
|
187
|
+
limit?: number;
|
|
188
|
+
/** Starting offset results (Default: 0) */
|
|
189
|
+
offset?: number;
|
|
190
|
+
/** Order By (Default: warehouse_x_users_uid|ASC) */
|
|
191
|
+
orderBy?: string;
|
|
192
|
+
/**
|
|
193
|
+
* Status code or list of codes (700=DELETE, 704=ACTIVE, 705=INACTIVE), sent comma-joined
|
|
194
|
+
* (704,705); -1 for every status. Default: every status
|
|
195
|
+
*/
|
|
196
|
+
statusCd?: number | number[];
|
|
197
|
+
/**
|
|
198
|
+
* Deprecated: use statusCd. CSV of status codes [700|704|705], read only when statusCd is absent
|
|
199
|
+
*/
|
|
200
|
+
statusCdList?: string;
|
|
201
|
+
}
|
|
202
|
+
/** Params for POST /warehouse/{warehouseUid}/users */
|
|
203
|
+
export interface WarehouseUsersCreateParams {
|
|
204
|
+
/** make_primary_user (y|N) */
|
|
205
|
+
makePrimaryUser?: string;
|
|
206
|
+
}
|
|
207
|
+
/** Params for GET /warehouse/{warehouseUid}/users/{usersId} */
|
|
208
|
+
export type WarehouseUsersGetParams = EdgeCacheParams;
|
|
209
|
+
/**
|
|
210
|
+
* List distributors
|
|
211
|
+
* Response data for GET /distributors — MINIMUM fields, extras pass through
|
|
212
|
+
*
|
|
213
|
+
* Returned by: api.vmi.distributors.list(params) (array items)
|
|
214
|
+
* Returned by: api.vmi.distributors.create(data)
|
|
215
|
+
* Returned by: api.vmi.distributors.get(distributorsUid)
|
|
216
|
+
*/
|
|
217
|
+
export interface DistributorsListItem {
|
|
218
|
+
/** Distributor ID */
|
|
219
|
+
distributorsUid: number;
|
|
220
|
+
/** Prophet 21 customer the record belongs to */
|
|
221
|
+
customerId: number;
|
|
222
|
+
/** Distributor key derived from the name (max 255 chars) */
|
|
223
|
+
distributorsId: string;
|
|
224
|
+
/** Distributor name (max 255 chars) */
|
|
225
|
+
distributorsName: string;
|
|
226
|
+
/** Distributor description (max 255 chars) */
|
|
227
|
+
distributorsDesc: string;
|
|
228
|
+
/** Distributor contact email (max 255 chars) */
|
|
229
|
+
distributorsEmail: string;
|
|
230
|
+
/** Customer's account number with the distributor (max 255 chars) */
|
|
231
|
+
distributorsAccount: string;
|
|
232
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
233
|
+
dateCreated: string;
|
|
234
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
235
|
+
dateLastModified: string;
|
|
236
|
+
/** Update code (1185 = Import Complete) */
|
|
237
|
+
updateCd: number;
|
|
238
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
239
|
+
statusCd: number;
|
|
240
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
241
|
+
processCd: number;
|
|
242
|
+
[key: string]: unknown;
|
|
243
|
+
}
|
|
244
|
+
/** Returned by: api.vmi.distributors.list(params) */
|
|
245
|
+
export type DistributorsListData = DistributorsListItem[];
|
|
246
|
+
/**
|
|
247
|
+
* Create distributor
|
|
248
|
+
* Response data for POST /distributors — MINIMUM fields, extras pass through
|
|
249
|
+
*
|
|
250
|
+
* Returned by: api.vmi.distributors.create(data)
|
|
251
|
+
*/
|
|
252
|
+
export type DistributorsCreateData = DistributorsListItem;
|
|
253
|
+
/**
|
|
254
|
+
* Create distributor
|
|
255
|
+
* Request body for POST /distributors — MINIMUM fields, extras pass through
|
|
256
|
+
*
|
|
257
|
+
* Request body of: api.vmi.distributors.create(data)
|
|
258
|
+
*/
|
|
259
|
+
export interface DistributorsCreateBody {
|
|
260
|
+
/** Prophet 21 customer the distributor belongs to; without it nothing is created */
|
|
261
|
+
customerId: number | null;
|
|
262
|
+
/**
|
|
263
|
+
* Distributor name; distributors_id is derived from it. Without it nothing is created (max 255
|
|
264
|
+
* chars)
|
|
265
|
+
*/
|
|
266
|
+
distributorsName: string | null;
|
|
267
|
+
/** Distributor description (max 255 chars) */
|
|
268
|
+
distributorsDesc?: string | null;
|
|
269
|
+
/** Distributor contact email (max 255 chars) */
|
|
270
|
+
distributorsEmail?: string | null;
|
|
271
|
+
/** Customer's account number with the distributor (max 255 chars) */
|
|
272
|
+
distributorsAccount?: string | null;
|
|
273
|
+
[key: string]: unknown;
|
|
274
|
+
}
|
|
275
|
+
/**
|
|
276
|
+
* Get distributor Details
|
|
277
|
+
* Response data for GET /distributors/{distributorsUid} — MINIMUM fields, extras pass through
|
|
278
|
+
*
|
|
279
|
+
* Returned by: api.vmi.distributors.get(distributorsUid)
|
|
280
|
+
*/
|
|
281
|
+
export type DistributorsGetData = DistributorsListItem;
|
|
282
|
+
/**
|
|
283
|
+
* Update distributor
|
|
284
|
+
* Response data for PUT /distributors/{distributorsUid} — MINIMUM fields, extras pass through
|
|
285
|
+
*
|
|
286
|
+
* Returned by: api.vmi.distributors.update(distributorsUid, data)
|
|
287
|
+
*/
|
|
288
|
+
export type DistributorsUpdateData = boolean;
|
|
289
|
+
/**
|
|
290
|
+
* Update distributor
|
|
291
|
+
* Request body for PUT /distributors/{distributorsUid} — MINIMUM fields, extras pass through
|
|
292
|
+
*
|
|
293
|
+
* Request body of: api.vmi.distributors.update(distributorsUid, data)
|
|
294
|
+
*/
|
|
295
|
+
export interface DistributorsUpdateBody {
|
|
296
|
+
/** Prophet 21 customer the distributor belongs to */
|
|
297
|
+
customerId?: number | null;
|
|
298
|
+
/** Distributor name; distributors_id is re-derived from it (max 255 chars) */
|
|
299
|
+
distributorsName?: string | null;
|
|
300
|
+
/** Distributor description (max 255 chars) */
|
|
301
|
+
distributorsDesc?: string | null;
|
|
302
|
+
/** Distributor contact email (max 255 chars) */
|
|
303
|
+
distributorsEmail?: string | null;
|
|
304
|
+
/** Customer's account number with the distributor (max 255 chars) */
|
|
305
|
+
distributorsAccount?: string | null;
|
|
306
|
+
[key: string]: unknown;
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* DELETE distributor
|
|
310
|
+
* Response data for DELETE /distributors/{distributorsUid} — MINIMUM fields, extras pass through
|
|
311
|
+
*
|
|
312
|
+
* Returned by: api.vmi.distributors.delete(distributorsUid)
|
|
313
|
+
*/
|
|
314
|
+
export type DistributorsDeleteData = boolean;
|
|
315
|
+
/**
|
|
316
|
+
* Enable/Disable/Delete distributor
|
|
317
|
+
* Response data for PUT /distributors/{distributorsUid}/enable — MINIMUM fields, extras pass
|
|
318
|
+
* through
|
|
319
|
+
*
|
|
320
|
+
* Returned by: api.vmi.distributors.enable.update(distributorsUid, data)
|
|
321
|
+
* Returned by: api.vmi.products.enable.update(productsUid, data)
|
|
322
|
+
* Returned by: api.vmi.sections.enable.update(sectionsUid, data)
|
|
323
|
+
* Returned by: api.vmi.warehouse.enable.update(warehouseUid, data)
|
|
324
|
+
*/
|
|
325
|
+
export interface DistributorsEnableUpdateData {
|
|
326
|
+
/** Status applied: 704 (enable), 705 (disable), or 700 (delete) */
|
|
327
|
+
statusCd: number;
|
|
328
|
+
/** enable, disable, or delete, matching statusCd */
|
|
329
|
+
statusName: string;
|
|
330
|
+
/** true when the record's status changed; false when it already had this status */
|
|
331
|
+
updated: boolean;
|
|
332
|
+
/** Status before the request */
|
|
333
|
+
originalStatusCd: number;
|
|
334
|
+
[key: string]: unknown;
|
|
335
|
+
}
|
|
336
|
+
/**
|
|
337
|
+
* Enable/Disable/Delete distributor
|
|
338
|
+
* Request body for PUT /distributors/{distributorsUid}/enable — MINIMUM fields, extras pass through
|
|
339
|
+
*
|
|
340
|
+
* Request body of: api.vmi.distributors.enable.update(distributorsUid, data)
|
|
341
|
+
* Request body of: api.vmi.products.enable.update(productsUid, data)
|
|
342
|
+
* Request body of: api.vmi.sections.enable.update(sectionsUid, data)
|
|
343
|
+
* Request body of: api.vmi.warehouse.enable.update(warehouseUid, data)
|
|
344
|
+
*/
|
|
345
|
+
export interface DistributorsEnableUpdateBody {
|
|
346
|
+
/** enable, disable, or delete; used only when statusCd is absent */
|
|
347
|
+
statusName?: string | null;
|
|
348
|
+
/** 704 (enable), 705 (disable), or 700 (delete); any other value enables */
|
|
349
|
+
statusCd?: number | null;
|
|
350
|
+
[key: string]: unknown;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* Create Product
|
|
354
|
+
* Response data for POST /distributors/{distributorsUid}/products — MINIMUM fields, extras pass
|
|
355
|
+
* through
|
|
356
|
+
*
|
|
357
|
+
* Returned by: api.vmi.distributors.products.create(distributorsUid, data)
|
|
358
|
+
* Returned by: api.vmi.products.list(params) (array items)
|
|
359
|
+
* Returned by: api.vmi.products.get(productsUid)
|
|
360
|
+
*/
|
|
361
|
+
export interface DistributorsProductsCreateData {
|
|
362
|
+
/** Product ID */
|
|
363
|
+
productsUid: number;
|
|
364
|
+
/** Distributor that supplies the product */
|
|
365
|
+
distributorsUid: number;
|
|
366
|
+
/** Product ID within the distributor (max 255 chars) */
|
|
367
|
+
productsId: string;
|
|
368
|
+
/** Product description (max 255 chars) */
|
|
369
|
+
productsDesc: string;
|
|
370
|
+
/** Default selling unit (max 255 chars) */
|
|
371
|
+
defaultSellingUnit: string;
|
|
372
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
373
|
+
dateCreated: string;
|
|
374
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
375
|
+
dateLastModified: string;
|
|
376
|
+
/** Update code (1185 = Import Complete) */
|
|
377
|
+
updateCd: number;
|
|
378
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
379
|
+
statusCd: number;
|
|
380
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
381
|
+
processCd: number;
|
|
382
|
+
/** UPC or EAN id (max 15 chars) */
|
|
383
|
+
upcOrEanId: string | null;
|
|
384
|
+
/** image url (max 255 chars) */
|
|
385
|
+
imageUrl: string | null;
|
|
386
|
+
/** manufacturer part number (max 255 chars) */
|
|
387
|
+
partNumber: string | null;
|
|
388
|
+
[key: string]: unknown;
|
|
389
|
+
}
|
|
390
|
+
/**
|
|
391
|
+
* Create Product
|
|
392
|
+
* Request body for POST /distributors/{distributorsUid}/products — MINIMUM fields, extras pass
|
|
393
|
+
* through
|
|
394
|
+
*
|
|
395
|
+
* Request body of: api.vmi.distributors.products.create(distributorsUid, data)
|
|
396
|
+
*/
|
|
397
|
+
export interface DistributorsProductsCreateBody {
|
|
398
|
+
/** Product ID within the distributor; without it nothing is created */
|
|
399
|
+
productsId: string | null;
|
|
400
|
+
/** Product description; defaults to the product ID */
|
|
401
|
+
productsDesc?: string | null;
|
|
402
|
+
/** Default selling unit; defaults to EA */
|
|
403
|
+
defaultSellingUnit?: string | null;
|
|
404
|
+
/** Product image URL */
|
|
405
|
+
imageUrl?: string | null;
|
|
406
|
+
/** Manufacturer part number */
|
|
407
|
+
partNumber?: string | null;
|
|
408
|
+
/** UPC or EAN code */
|
|
409
|
+
upcOrEanId?: string | null;
|
|
410
|
+
[key: string]: unknown;
|
|
411
|
+
}
|
|
412
|
+
/**
|
|
413
|
+
* List Inventory Profile Headers
|
|
414
|
+
* Response data for GET /inv-profile-hdr — MINIMUM fields, extras pass through
|
|
415
|
+
*
|
|
416
|
+
* Returned by: api.vmi.invProfileHdr.list(params) (array items)
|
|
417
|
+
* Returned by: api.vmi.invProfileHdr.get(invProfileHdrUid)
|
|
418
|
+
*/
|
|
419
|
+
export interface InvProfileHdrListItem {
|
|
420
|
+
/** Inventory profile ID */
|
|
421
|
+
invProfileHdrUid: number;
|
|
422
|
+
/** Profile key derived from the description (max 255 chars) */
|
|
423
|
+
invProfileHdrId: string;
|
|
424
|
+
/** Profile description (max 255 chars) */
|
|
425
|
+
invProfileHdrDesc: string;
|
|
426
|
+
/** Prophet 21 customer the profile belongs to */
|
|
427
|
+
customerId: number;
|
|
428
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
429
|
+
statusCd: number;
|
|
430
|
+
/** Active warehouses of the same customer that stock this profile */
|
|
431
|
+
warehouses: WarehouseListItem[];
|
|
432
|
+
/** Number of entries in warehouses */
|
|
433
|
+
warehousesCount: number;
|
|
434
|
+
[key: string]: unknown;
|
|
435
|
+
}
|
|
436
|
+
/** Returned by: api.vmi.invProfileHdr.list(params) */
|
|
437
|
+
export type InvProfileHdrListData = InvProfileHdrListItem[];
|
|
438
|
+
/**
|
|
439
|
+
* Create Inventory Profile Header
|
|
440
|
+
* Response data for POST /inv-profile-hdr — MINIMUM fields, extras pass through
|
|
441
|
+
*
|
|
442
|
+
* Returned by: api.vmi.invProfileHdr.create(data)
|
|
443
|
+
* Returned by: api.vmi.invProfileHdr.update(invProfileHdrUid, data)
|
|
444
|
+
*/
|
|
445
|
+
export interface InvProfileHdrCreateData {
|
|
446
|
+
/** Inventory profile ID */
|
|
447
|
+
invProfileHdrUid: number;
|
|
448
|
+
/** Profile key derived from the description (max 255 chars) */
|
|
449
|
+
invProfileHdrId: string;
|
|
450
|
+
/** Profile description (max 255 chars) */
|
|
451
|
+
invProfileHdrDesc: string;
|
|
452
|
+
/** Prophet 21 customer the record belongs to */
|
|
453
|
+
customerId: number;
|
|
454
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
455
|
+
dateCreated: string;
|
|
456
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
457
|
+
dateLastModified: string;
|
|
458
|
+
/** Update code (1185 = Import Complete) */
|
|
459
|
+
updateCd: number;
|
|
460
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
461
|
+
statusCd: number;
|
|
462
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
463
|
+
processCd: number;
|
|
464
|
+
[key: string]: unknown;
|
|
465
|
+
}
|
|
466
|
+
/**
|
|
467
|
+
* Create Inventory Profile Header
|
|
468
|
+
* Request body for POST /inv-profile-hdr — MINIMUM fields, extras pass through
|
|
469
|
+
*
|
|
470
|
+
* Request body of: api.vmi.invProfileHdr.create(data)
|
|
471
|
+
*/
|
|
472
|
+
export interface InvProfileHdrCreateBody {
|
|
473
|
+
/**
|
|
474
|
+
* Profile description; inv_profile_hdr_id is derived from it. Without it nothing is created (max
|
|
475
|
+
* 255 chars)
|
|
476
|
+
*/
|
|
477
|
+
invProfileHdrDesc: string | null;
|
|
478
|
+
/** Prophet 21 customer the profile belongs to; without it nothing is created */
|
|
479
|
+
customerId: number | null;
|
|
480
|
+
[key: string]: unknown;
|
|
481
|
+
}
|
|
482
|
+
/**
|
|
483
|
+
* Upload Excel file to create inventory profile headers
|
|
484
|
+
* Response data for POST /inv-profile-hdr/{customerId}/upload — MINIMUM fields, extras pass through
|
|
485
|
+
*
|
|
486
|
+
* Returned by: api.vmi.invProfileHdr.upload.create(customerId, data)
|
|
487
|
+
*/
|
|
488
|
+
export interface InvProfileHdrUploadCreateData {
|
|
489
|
+
/** true when the file and its metadata were saved for processing */
|
|
490
|
+
success: boolean;
|
|
491
|
+
/** Prophet 21 customer the profile is for */
|
|
492
|
+
customerId: number | null;
|
|
493
|
+
/** Name the file was saved under (upload_{timestamp}.xlsx) */
|
|
494
|
+
fileName: string | null;
|
|
495
|
+
/** Full path of the saved file */
|
|
496
|
+
filePath: string | null;
|
|
497
|
+
/** Full path of the metadata JSON saved beside the file */
|
|
498
|
+
metadataFile: string | null;
|
|
499
|
+
/** Decoded file size in bytes */
|
|
500
|
+
fileSize: number | null;
|
|
501
|
+
/** Result message; says why when the upload failed */
|
|
502
|
+
message: string;
|
|
503
|
+
[key: string]: unknown;
|
|
504
|
+
}
|
|
505
|
+
/**
|
|
506
|
+
* Upload Excel file to create inventory profile headers
|
|
507
|
+
* Request body for POST /inv-profile-hdr/{customerId}/upload — MINIMUM fields, extras pass through
|
|
508
|
+
*
|
|
509
|
+
* Request body of: api.vmi.invProfileHdr.upload.create(customerId, data)
|
|
510
|
+
*/
|
|
511
|
+
export interface InvProfileHdrUploadCreateBody {
|
|
512
|
+
/** Base64-encoded .xlsx file; a missing or empty value is rejected with 400 */
|
|
513
|
+
fileData: string | null;
|
|
514
|
+
/** Original file name, kept in the upload metadata */
|
|
515
|
+
fileName?: string | null;
|
|
516
|
+
/** Description for the inventory profile the file creates */
|
|
517
|
+
invProfileHdrDesc?: string | null;
|
|
518
|
+
[key: string]: unknown;
|
|
519
|
+
}
|
|
520
|
+
/**
|
|
521
|
+
* Get Inventory Profile Header Details
|
|
522
|
+
* Response data for GET /inv-profile-hdr/{invProfileHdrUid} — MINIMUM fields, extras pass through
|
|
523
|
+
*
|
|
524
|
+
* Returned by: api.vmi.invProfileHdr.get(invProfileHdrUid)
|
|
525
|
+
*/
|
|
526
|
+
export type InvProfileHdrGetData = InvProfileHdrListItem;
|
|
527
|
+
/**
|
|
528
|
+
* Update Inventory Profile Header
|
|
529
|
+
* Response data for PUT /inv-profile-hdr/{invProfileHdrUid} — MINIMUM fields, extras pass through
|
|
530
|
+
*
|
|
531
|
+
* Returned by: api.vmi.invProfileHdr.update(invProfileHdrUid, data)
|
|
532
|
+
*/
|
|
533
|
+
export type InvProfileHdrUpdateData = InvProfileHdrCreateData;
|
|
534
|
+
/**
|
|
535
|
+
* Update Inventory Profile Header
|
|
536
|
+
* Request body for PUT /inv-profile-hdr/{invProfileHdrUid} — MINIMUM fields, extras pass through
|
|
537
|
+
*
|
|
538
|
+
* Request body of: api.vmi.invProfileHdr.update(invProfileHdrUid, data)
|
|
539
|
+
*/
|
|
540
|
+
export interface InvProfileHdrUpdateBody {
|
|
541
|
+
/** Profile description; inv_profile_hdr_id is re-derived from it */
|
|
542
|
+
invProfileHdrDesc?: string | null;
|
|
543
|
+
/** Update code */
|
|
544
|
+
updateCd?: number | null;
|
|
545
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
546
|
+
statusCd?: number | null;
|
|
547
|
+
/** Process code */
|
|
548
|
+
processCd?: number | null;
|
|
549
|
+
[key: string]: unknown;
|
|
550
|
+
}
|
|
551
|
+
/**
|
|
552
|
+
* DELETE Inventory Profile Header
|
|
553
|
+
* Response data for DELETE /inv-profile-hdr/{invProfileHdrUid} — MINIMUM fields, extras pass
|
|
554
|
+
* through
|
|
555
|
+
*
|
|
556
|
+
* Returned by: api.vmi.invProfileHdr.delete(invProfileHdrUid)
|
|
557
|
+
*/
|
|
558
|
+
export type InvProfileHdrDeleteData = boolean;
|
|
559
|
+
/**
|
|
560
|
+
* List Inventory Profile Lines
|
|
561
|
+
* Response data for GET /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line — MINIMUM fields,
|
|
562
|
+
* extras pass through
|
|
563
|
+
*
|
|
564
|
+
* Returned by: api.vmi.invProfileHdr.invProfileLine.list(invProfileHdrUid, params) (array items)
|
|
565
|
+
* Returned by: api.vmi.invProfileHdr.invProfileLine.create(invProfileHdrUid, data) (array items)
|
|
566
|
+
* Returned by: api.vmi.invProfileHdr.invProfileLine.get(invProfileHdrUid, invProfileLineUid)
|
|
567
|
+
*/
|
|
568
|
+
export interface InvProfileHdrInvProfileLineListItem {
|
|
569
|
+
/** Inventory profile line ID */
|
|
570
|
+
invProfileLineUid: number;
|
|
571
|
+
/** Inventory profile the line belongs to */
|
|
572
|
+
invProfileHdrUid: number;
|
|
573
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
574
|
+
invMastUid: number;
|
|
575
|
+
/** Item source: products or prophet21 (max 255 chars) */
|
|
576
|
+
invProfileLineType: string;
|
|
577
|
+
/** Minimum quantity to keep on hand */
|
|
578
|
+
invProfileHdrMinQty: number;
|
|
579
|
+
/** Maximum quantity to keep on hand; -1 for no maximum */
|
|
580
|
+
invProfileHdrMaxQty: number;
|
|
581
|
+
/** Quantity to reorder */
|
|
582
|
+
invProfileHdrReorderQty: number;
|
|
583
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
584
|
+
dateCreated: string;
|
|
585
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
586
|
+
dateLastModified: string;
|
|
587
|
+
/** Update code (1185 = Import Complete) */
|
|
588
|
+
updateCd: number;
|
|
589
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
590
|
+
statusCd: number;
|
|
591
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
592
|
+
processCd: number;
|
|
593
|
+
/** Warehouse section the item is stocked in; 0 when none */
|
|
594
|
+
sectionsUid: number;
|
|
595
|
+
/** Item ID and description words, for searching profile lines (max 255 chars) */
|
|
596
|
+
keywords: string | null;
|
|
597
|
+
[key: string]: unknown;
|
|
598
|
+
}
|
|
599
|
+
/** Returned by: api.vmi.invProfileHdr.invProfileLine.list(invProfileHdrUid, params) */
|
|
600
|
+
export type InvProfileHdrInvProfileLineListData = InvProfileHdrInvProfileLineListItem[];
|
|
601
|
+
/**
|
|
602
|
+
* Create Inventory Profile Lines
|
|
603
|
+
* Response data for POST /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line — MINIMUM fields,
|
|
604
|
+
* extras pass through
|
|
605
|
+
*
|
|
606
|
+
* Returned by: api.vmi.invProfileHdr.invProfileLine.create(invProfileHdrUid, data) (array items)
|
|
607
|
+
*/
|
|
608
|
+
export type InvProfileHdrInvProfileLineCreateItem = InvProfileHdrInvProfileLineListItem;
|
|
609
|
+
/** Returned by: api.vmi.invProfileHdr.invProfileLine.create(invProfileHdrUid, data) */
|
|
610
|
+
export type InvProfileHdrInvProfileLineCreateData = InvProfileHdrInvProfileLineCreateItem[];
|
|
611
|
+
/**
|
|
612
|
+
* Create Inventory Profile Lines
|
|
613
|
+
* Request body for POST /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line — MINIMUM fields,
|
|
614
|
+
* extras pass through
|
|
615
|
+
*
|
|
616
|
+
* Request body of: api.vmi.invProfileHdr.invProfileLine.create(invProfileHdrUid, data) (array
|
|
617
|
+
* items)
|
|
618
|
+
*/
|
|
619
|
+
export interface InvProfileHdrInvProfileLineCreateBodyItem {
|
|
620
|
+
/**
|
|
621
|
+
* products_uid for a VMI product, inv_mast_uid for a Prophet 21 item; without it the line is
|
|
622
|
+
* skipped
|
|
623
|
+
*/
|
|
624
|
+
invMastUid: number | null;
|
|
625
|
+
/** Item source: products or prophet21; without it the line is skipped (max 255 chars) */
|
|
626
|
+
invProfileLineType: string | null;
|
|
627
|
+
/** Minimum quantity to keep on hand; defaults to 1 */
|
|
628
|
+
invProfileHdrMinQty?: number | null;
|
|
629
|
+
/** Maximum quantity to keep on hand; defaults to -1 (no maximum) */
|
|
630
|
+
invProfileHdrMaxQty?: number | null;
|
|
631
|
+
/** Quantity to reorder; defaults to 1 */
|
|
632
|
+
invProfileHdrReorderQty?: number | null;
|
|
633
|
+
/** Warehouse section the item is stocked in; defaults to 0 (none) */
|
|
634
|
+
sectionsUid?: number | null;
|
|
635
|
+
[key: string]: unknown;
|
|
636
|
+
}
|
|
637
|
+
/** Request body of: api.vmi.invProfileHdr.invProfileLine.create(invProfileHdrUid, data) */
|
|
638
|
+
export type InvProfileHdrInvProfileLineCreateBody = InvProfileHdrInvProfileLineCreateBodyItem[];
|
|
639
|
+
/**
|
|
640
|
+
* Get Inventory Profile line Details
|
|
641
|
+
* Response data for GET /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid} —
|
|
642
|
+
* MINIMUM fields, extras pass through
|
|
643
|
+
*
|
|
644
|
+
* Returned by: api.vmi.invProfileHdr.invProfileLine.get(invProfileHdrUid, invProfileLineUid)
|
|
645
|
+
*/
|
|
646
|
+
export type InvProfileHdrInvProfileLineGetData = InvProfileHdrInvProfileLineListItem;
|
|
647
|
+
/**
|
|
648
|
+
* Update Inventory Profile Line
|
|
649
|
+
* Response data for PUT /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid} —
|
|
650
|
+
* MINIMUM fields, extras pass through
|
|
651
|
+
*
|
|
652
|
+
* Returned by:
|
|
653
|
+
* api.vmi.invProfileHdr.invProfileLine.update(invProfileHdrUid, invProfileLineUid, data)
|
|
654
|
+
*/
|
|
655
|
+
export type InvProfileHdrInvProfileLineUpdateData = boolean;
|
|
656
|
+
/**
|
|
657
|
+
* Update Inventory Profile Line
|
|
658
|
+
* Request body for PUT /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid} —
|
|
659
|
+
* MINIMUM fields, extras pass through
|
|
660
|
+
*
|
|
661
|
+
* Request body of:
|
|
662
|
+
* api.vmi.invProfileHdr.invProfileLine.update(invProfileHdrUid, invProfileLineUid, data)
|
|
663
|
+
*/
|
|
664
|
+
export interface InvProfileHdrInvProfileLineUpdateBody {
|
|
665
|
+
/** Inventory profile the line belongs to */
|
|
666
|
+
invProfileHdrUid?: number | null;
|
|
667
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
668
|
+
invMastUid?: number | null;
|
|
669
|
+
/** Item source: products or prophet21 (max 255 chars) */
|
|
670
|
+
invProfileLineType?: string | null;
|
|
671
|
+
/** Minimum quantity to keep on hand */
|
|
672
|
+
invProfileHdrMinQty?: number | null;
|
|
673
|
+
/** Maximum quantity to keep on hand; -1 for no maximum */
|
|
674
|
+
invProfileHdrMaxQty?: number | null;
|
|
675
|
+
/** Quantity to reorder */
|
|
676
|
+
invProfileHdrReorderQty?: number | null;
|
|
677
|
+
/** Warehouse section the item is stocked in */
|
|
678
|
+
sectionsUid?: number | null;
|
|
679
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
680
|
+
statusCd?: number | null;
|
|
681
|
+
/** Process code */
|
|
682
|
+
processCd?: number | null;
|
|
683
|
+
/** Update code; defaults to 1185 (Import Complete) */
|
|
684
|
+
updateCd?: number | null;
|
|
685
|
+
[key: string]: unknown;
|
|
686
|
+
}
|
|
687
|
+
/**
|
|
688
|
+
* DELETE Inventory Profile line
|
|
689
|
+
* Response data for DELETE /inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}
|
|
690
|
+
* — MINIMUM fields, extras pass through
|
|
691
|
+
*
|
|
692
|
+
* Returned by: api.vmi.invProfileHdr.invProfileLine.delete(invProfileHdrUid, invProfileLineUid)
|
|
693
|
+
*/
|
|
694
|
+
export type InvProfileHdrInvProfileLineDeleteData = boolean;
|
|
695
|
+
/**
|
|
696
|
+
* List Products
|
|
697
|
+
* Response data for GET /products — MINIMUM fields, extras pass through
|
|
698
|
+
*
|
|
699
|
+
* Returned by: api.vmi.products.list(params) (array items)
|
|
700
|
+
*/
|
|
701
|
+
export type ProductsListItem = DistributorsProductsCreateData;
|
|
702
|
+
/** Returned by: api.vmi.products.list(params) */
|
|
703
|
+
export type ProductsListData = ProductsListItem[];
|
|
704
|
+
/**
|
|
705
|
+
* Find Products
|
|
706
|
+
* Response data for GET /products/find — MINIMUM fields, extras pass through
|
|
707
|
+
*
|
|
708
|
+
* Returned by: api.vmi.products.find.list(params) (array items)
|
|
709
|
+
*/
|
|
710
|
+
export interface ProductsFindListItem {
|
|
711
|
+
/** Default selling unit */
|
|
712
|
+
defaultSellingUnit: string | null;
|
|
713
|
+
/** Product or item description */
|
|
714
|
+
description: string | null;
|
|
715
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
716
|
+
invMastUid: number;
|
|
717
|
+
/** Product or item ID */
|
|
718
|
+
itemId: string;
|
|
719
|
+
/** Source of the match: products or prophet21 */
|
|
720
|
+
type: string;
|
|
721
|
+
[key: string]: unknown;
|
|
722
|
+
}
|
|
723
|
+
/** Returned by: api.vmi.products.find.list(params) */
|
|
724
|
+
export type ProductsFindListData = ProductsFindListItem[];
|
|
725
|
+
/**
|
|
726
|
+
* Get Product Details
|
|
727
|
+
* Response data for GET /products/{productsUid} — MINIMUM fields, extras pass through
|
|
728
|
+
*
|
|
729
|
+
* Returned by: api.vmi.products.get(productsUid)
|
|
730
|
+
*/
|
|
731
|
+
export type ProductsGetData = DistributorsProductsCreateData;
|
|
732
|
+
/**
|
|
733
|
+
* Update Product
|
|
734
|
+
* Response data for PUT /products/{productsUid} — MINIMUM fields, extras pass through
|
|
735
|
+
*
|
|
736
|
+
* Returned by: api.vmi.products.update(productsUid, data)
|
|
737
|
+
*/
|
|
738
|
+
export type ProductsUpdateData = boolean;
|
|
739
|
+
/**
|
|
740
|
+
* Update Product
|
|
741
|
+
* Request body for PUT /products/{productsUid} — MINIMUM fields, extras pass through
|
|
742
|
+
*
|
|
743
|
+
* Request body of: api.vmi.products.update(productsUid, data)
|
|
744
|
+
*/
|
|
745
|
+
export interface ProductsUpdateBody {
|
|
746
|
+
/** Distributor the product belongs to */
|
|
747
|
+
distributorsUid?: number | null;
|
|
748
|
+
/** Product ID; trimmed and upper-cased */
|
|
749
|
+
productsId?: string | null;
|
|
750
|
+
/** Product description */
|
|
751
|
+
productsDesc?: string | null;
|
|
752
|
+
/** Default selling unit */
|
|
753
|
+
defaultSellingUnit?: string | null;
|
|
754
|
+
/** Product image URL */
|
|
755
|
+
imageUrl?: string | null;
|
|
756
|
+
/** Manufacturer part number */
|
|
757
|
+
partNumber?: string | null;
|
|
758
|
+
/** UPC or EAN code */
|
|
759
|
+
upcOrEanId?: string | null;
|
|
760
|
+
/** Update code */
|
|
761
|
+
updateCd?: number | null;
|
|
762
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
763
|
+
statusCd?: number | null;
|
|
764
|
+
/** Process code */
|
|
765
|
+
processCd?: number | null;
|
|
766
|
+
[key: string]: unknown;
|
|
767
|
+
}
|
|
768
|
+
/**
|
|
769
|
+
* DELETE Product
|
|
770
|
+
* Response data for DELETE /products/{productsUid} — MINIMUM fields, extras pass through
|
|
771
|
+
*
|
|
772
|
+
* Returned by: api.vmi.products.delete(productsUid)
|
|
773
|
+
*/
|
|
774
|
+
export type ProductsDeleteData = boolean;
|
|
775
|
+
/**
|
|
776
|
+
* Enable/Disable/Delete Product
|
|
777
|
+
* Response data for PUT /products/{productsUid}/enable — MINIMUM fields, extras pass through
|
|
778
|
+
*
|
|
779
|
+
* Returned by: api.vmi.products.enable.update(productsUid, data)
|
|
780
|
+
*/
|
|
781
|
+
export type ProductsEnableUpdateData = DistributorsEnableUpdateData;
|
|
782
|
+
/**
|
|
783
|
+
* Enable/Disable/Delete Product
|
|
784
|
+
* Request body for PUT /products/{productsUid}/enable — MINIMUM fields, extras pass through
|
|
785
|
+
*
|
|
786
|
+
* Request body of: api.vmi.products.enable.update(productsUid, data)
|
|
787
|
+
*/
|
|
788
|
+
export type ProductsEnableUpdateBody = DistributorsEnableUpdateBody;
|
|
789
|
+
/**
|
|
790
|
+
* List Restock Headers
|
|
791
|
+
* Response data for GET /restock-hdr — MINIMUM fields, extras pass through
|
|
792
|
+
*
|
|
793
|
+
* Returned by: api.vmi.restockHdr.list(params) (array items)
|
|
794
|
+
* Returned by: api.vmi.restockHdr.get(restockHdrUid)
|
|
795
|
+
*/
|
|
796
|
+
export interface RestockHdrListItem {
|
|
797
|
+
/** Restock request ID */
|
|
798
|
+
restockHdrUid: number;
|
|
799
|
+
/** Warehouse being restocked */
|
|
800
|
+
warehouseUid: number;
|
|
801
|
+
/** Distributor ordered from */
|
|
802
|
+
distributorsUid: number;
|
|
803
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
804
|
+
dateCreated: string;
|
|
805
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
806
|
+
dateLastModified: string;
|
|
807
|
+
/** Update code (1185 = Import Complete) */
|
|
808
|
+
updateCd: number;
|
|
809
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
810
|
+
statusCd: number;
|
|
811
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
812
|
+
processCd: number;
|
|
813
|
+
/** The create request body, JSON-encoded */
|
|
814
|
+
jsonData: string | null;
|
|
815
|
+
/** Processing state of the restock order (max 30 chars) */
|
|
816
|
+
processState: string;
|
|
817
|
+
/** Customer purchase order number (max 50 chars) */
|
|
818
|
+
poNo: string | null;
|
|
819
|
+
/** joomla.users.id */
|
|
820
|
+
usersId: number;
|
|
821
|
+
/** Prophet 21 customer placing the restock */
|
|
822
|
+
customerId: number;
|
|
823
|
+
/** Prophet 21 contact placing the restock (max 16 chars) */
|
|
824
|
+
contactId: string | null;
|
|
825
|
+
/** Delivery instructions for the order (max 255 chars) */
|
|
826
|
+
deliveryInstructions: string | null;
|
|
827
|
+
[key: string]: unknown;
|
|
828
|
+
}
|
|
829
|
+
/** Returned by: api.vmi.restockHdr.list(params) */
|
|
830
|
+
export type RestockHdrListData = RestockHdrListItem[];
|
|
831
|
+
/**
|
|
832
|
+
* Shape of `restockItems` (MINIMUM fields; reused wherever the same shape appears)
|
|
833
|
+
* Items on the request
|
|
834
|
+
*
|
|
835
|
+
* Field `restockItems` of RestockHdrCreateData
|
|
836
|
+
*/
|
|
837
|
+
export interface RestockHdrCreateDataRestockItemsItem {
|
|
838
|
+
/** Restock line ID */
|
|
839
|
+
restockLineUid: number;
|
|
840
|
+
/** Restock request the line belongs to */
|
|
841
|
+
restockHdrUid: number;
|
|
842
|
+
/** Line number, starting at 1 */
|
|
843
|
+
lineNo: number;
|
|
844
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
845
|
+
invMastUid: number;
|
|
846
|
+
/** Item source: products or prophet21 (max 255 chars) */
|
|
847
|
+
invProfileLineType: string;
|
|
848
|
+
/** Quantity to restock */
|
|
849
|
+
unitQty: number;
|
|
850
|
+
/** When the line was created (Y-m-d H:i:s) */
|
|
851
|
+
dateCreated: string;
|
|
852
|
+
/** When the line last changed (Y-m-d H:i:s) */
|
|
853
|
+
dateLastModified: string;
|
|
854
|
+
/** Update code */
|
|
855
|
+
updateCd: number;
|
|
856
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
857
|
+
statusCd: number;
|
|
858
|
+
/** Process code */
|
|
859
|
+
processCd: number;
|
|
860
|
+
/**
|
|
861
|
+
* Distributor the item is ordered from; null until processing assigns it, -1 for a Prophet 21
|
|
862
|
+
* item
|
|
863
|
+
*/
|
|
864
|
+
distributorsUid: number | null;
|
|
865
|
+
[key: string]: unknown;
|
|
866
|
+
}
|
|
867
|
+
/**
|
|
868
|
+
* Create Restock Header
|
|
869
|
+
* Response data for POST /restock-hdr — MINIMUM fields, extras pass through
|
|
870
|
+
*
|
|
871
|
+
* Returned by: api.vmi.restockHdr.create(data)
|
|
872
|
+
*/
|
|
873
|
+
export interface RestockHdrCreateData {
|
|
874
|
+
/** Restock request ID */
|
|
875
|
+
restockHdrUid: number;
|
|
876
|
+
/** Warehouse being restocked */
|
|
877
|
+
warehouseUid: number;
|
|
878
|
+
/** Distributor ordered from */
|
|
879
|
+
distributorsUid: number;
|
|
880
|
+
/** When the request was created (Y-m-d H:i:s) */
|
|
881
|
+
dateCreated: string;
|
|
882
|
+
/** When the request last changed (Y-m-d H:i:s) */
|
|
883
|
+
dateLastModified: string;
|
|
884
|
+
/** Update code */
|
|
885
|
+
updateCd: number;
|
|
886
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
887
|
+
statusCd: number;
|
|
888
|
+
/** Process code (704 = waiting for processing) */
|
|
889
|
+
processCd: number;
|
|
890
|
+
/** The create request body, JSON-encoded */
|
|
891
|
+
jsonData: string | null;
|
|
892
|
+
/** Processing state (max 30 chars) */
|
|
893
|
+
processState: string;
|
|
894
|
+
/** Customer purchase order number (max 50 chars) */
|
|
895
|
+
poNo: string | null;
|
|
896
|
+
/** joomla.users.id of the requester */
|
|
897
|
+
usersId: number;
|
|
898
|
+
/** Prophet 21 customer placing the restock */
|
|
899
|
+
customerId: number;
|
|
900
|
+
/** Prophet 21 contact placing the restock (max 16 chars) */
|
|
901
|
+
contactId: string | null;
|
|
902
|
+
/** Delivery instructions for the order (max 255 chars) */
|
|
903
|
+
deliveryInstructions: string | null;
|
|
904
|
+
/** Items on the request */
|
|
905
|
+
restockItems: RestockHdrCreateDataRestockItemsItem[];
|
|
906
|
+
[key: string]: unknown;
|
|
907
|
+
}
|
|
908
|
+
/**
|
|
909
|
+
* Shape of `restockItems` (MINIMUM fields; reused wherever the same shape appears)
|
|
910
|
+
* Items to restock; an empty list creates nothing
|
|
911
|
+
*
|
|
912
|
+
* Field `restockItems` of RestockHdrCreateBody
|
|
913
|
+
*/
|
|
914
|
+
export interface RestockHdrCreateBodyRestockItemsItem {
|
|
915
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
916
|
+
invMastUid: number | null;
|
|
917
|
+
/** Item source: products or prophet21 (max 255 chars) */
|
|
918
|
+
invProfileLineType: string | null;
|
|
919
|
+
/** Quantity to restock */
|
|
920
|
+
unitQty: number | null;
|
|
921
|
+
[key: string]: unknown;
|
|
922
|
+
}
|
|
923
|
+
/**
|
|
924
|
+
* Create Restock Header
|
|
925
|
+
* Request body for POST /restock-hdr — MINIMUM fields, extras pass through
|
|
926
|
+
*
|
|
927
|
+
* Request body of: api.vmi.restockHdr.create(data)
|
|
928
|
+
*/
|
|
929
|
+
export interface RestockHdrCreateBody {
|
|
930
|
+
/** Warehouse to restock */
|
|
931
|
+
warehouseUid: number | null;
|
|
932
|
+
/** Distributor to order from */
|
|
933
|
+
distributorsUid: number | null;
|
|
934
|
+
/** joomla.users.id of the requester */
|
|
935
|
+
usersId: number | null;
|
|
936
|
+
/** Prophet 21 customer placing the restock */
|
|
937
|
+
customerId: number | null;
|
|
938
|
+
/** Prophet 21 contact placing the restock (max 16 chars) */
|
|
939
|
+
contactId: string | null;
|
|
940
|
+
/** Items to restock; an empty list creates nothing */
|
|
941
|
+
restockItems: RestockHdrCreateBodyRestockItemsItem[];
|
|
942
|
+
/** Customer purchase order number (max 50 chars) */
|
|
943
|
+
poNo?: string | null;
|
|
944
|
+
/** Delivery instructions for the order (max 255 chars) */
|
|
945
|
+
deliveryInstructions?: string | null;
|
|
946
|
+
[key: string]: unknown;
|
|
947
|
+
}
|
|
948
|
+
/**
|
|
949
|
+
* Get Restock Header Details
|
|
950
|
+
* Response data for GET /restock-hdr/{restockHdrUid} — MINIMUM fields, extras pass through
|
|
951
|
+
*
|
|
952
|
+
* Returned by: api.vmi.restockHdr.get(restockHdrUid)
|
|
953
|
+
*/
|
|
954
|
+
export type RestockHdrGetData = RestockHdrListItem;
|
|
955
|
+
/**
|
|
956
|
+
* Update Restock Header
|
|
957
|
+
* Response data for PUT /restock-hdr/{restockHdrUid} — MINIMUM fields, extras pass through
|
|
958
|
+
*
|
|
959
|
+
* Returned by: api.vmi.restockHdr.update(restockHdrUid, data)
|
|
960
|
+
*/
|
|
961
|
+
export type RestockHdrUpdateData = boolean;
|
|
962
|
+
/**
|
|
963
|
+
* Update Restock Header
|
|
964
|
+
* Request body for PUT /restock-hdr/{restockHdrUid} — MINIMUM fields, extras pass through
|
|
965
|
+
*
|
|
966
|
+
* Request body of: api.vmi.restockHdr.update(restockHdrUid, data)
|
|
967
|
+
*/
|
|
968
|
+
export interface RestockHdrUpdateBody {
|
|
969
|
+
/** Update code */
|
|
970
|
+
updateCd?: number | null;
|
|
971
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
972
|
+
statusCd?: number | null;
|
|
973
|
+
/** Process code */
|
|
974
|
+
processCd?: number | null;
|
|
975
|
+
/** Delivery instructions for the order */
|
|
976
|
+
deliveryInstructions?: string | null;
|
|
977
|
+
[key: string]: unknown;
|
|
978
|
+
}
|
|
979
|
+
/**
|
|
980
|
+
* DELETE Restock Header
|
|
981
|
+
* Response data for DELETE /restock-hdr/{restockHdrUid} — MINIMUM fields, extras pass through
|
|
982
|
+
*
|
|
983
|
+
* Returned by: api.vmi.restockHdr.delete(restockHdrUid)
|
|
984
|
+
*/
|
|
985
|
+
export type RestockHdrDeleteData = boolean;
|
|
986
|
+
/**
|
|
987
|
+
* List sections
|
|
988
|
+
* Response data for GET /sections — MINIMUM fields, extras pass through
|
|
989
|
+
*
|
|
990
|
+
* Returned by: api.vmi.sections.list(params) (array items)
|
|
991
|
+
* Returned by: api.vmi.sections.create(data)
|
|
992
|
+
* Returned by: api.vmi.sections.get(sectionsUid)
|
|
993
|
+
*/
|
|
994
|
+
export interface SectionsListItem {
|
|
995
|
+
/** unique identifier */
|
|
996
|
+
sectionsUid: number;
|
|
997
|
+
/** customer id from Prophet21 */
|
|
998
|
+
customerId: number;
|
|
999
|
+
/** section id normalized from section name (max 255 chars) */
|
|
1000
|
+
sectionsId: string;
|
|
1001
|
+
/** Name of the section (max 255 chars) */
|
|
1002
|
+
sectionsName: string;
|
|
1003
|
+
/** Description of the section, defaults to section name (max 255 chars) */
|
|
1004
|
+
sectionsDesc: string;
|
|
1005
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1006
|
+
dateCreated: string;
|
|
1007
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1008
|
+
dateLastModified: string;
|
|
1009
|
+
/** Update code (1185 = Import Complete) */
|
|
1010
|
+
updateCd: number;
|
|
1011
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1012
|
+
statusCd: number;
|
|
1013
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
1014
|
+
processCd: number;
|
|
1015
|
+
[key: string]: unknown;
|
|
1016
|
+
}
|
|
1017
|
+
/** Returned by: api.vmi.sections.list(params) */
|
|
1018
|
+
export type SectionsListData = SectionsListItem[];
|
|
1019
|
+
/**
|
|
1020
|
+
* Create section
|
|
1021
|
+
* Response data for POST /sections — MINIMUM fields, extras pass through
|
|
1022
|
+
*
|
|
1023
|
+
* Returned by: api.vmi.sections.create(data)
|
|
1024
|
+
*/
|
|
1025
|
+
export type SectionsCreateData = SectionsListItem;
|
|
1026
|
+
/**
|
|
1027
|
+
* Create section
|
|
1028
|
+
* Request body for POST /sections — MINIMUM fields, extras pass through
|
|
1029
|
+
*
|
|
1030
|
+
* Request body of: api.vmi.sections.create(data)
|
|
1031
|
+
*/
|
|
1032
|
+
export interface SectionsCreateBody {
|
|
1033
|
+
/** Section name; sections_id is derived from it. Without it nothing is created (max 255 chars) */
|
|
1034
|
+
sectionsName: string | null;
|
|
1035
|
+
/** Prophet 21 customer the section belongs to; without it nothing is created */
|
|
1036
|
+
customerId: number | null;
|
|
1037
|
+
/** Section description; defaults to the section name (max 255 chars) */
|
|
1038
|
+
sectionsDesc?: string | null;
|
|
1039
|
+
[key: string]: unknown;
|
|
1040
|
+
}
|
|
1041
|
+
/**
|
|
1042
|
+
* Get section Details
|
|
1043
|
+
* Response data for GET /sections/{sectionsUid} — MINIMUM fields, extras pass through
|
|
1044
|
+
*
|
|
1045
|
+
* Returned by: api.vmi.sections.get(sectionsUid)
|
|
1046
|
+
*/
|
|
1047
|
+
export type SectionsGetData = SectionsListItem;
|
|
1048
|
+
/**
|
|
1049
|
+
* Update section
|
|
1050
|
+
* Response data for PUT /sections/{sectionsUid} — MINIMUM fields, extras pass through
|
|
1051
|
+
*
|
|
1052
|
+
* Returned by: api.vmi.sections.update(sectionsUid, data)
|
|
1053
|
+
*/
|
|
1054
|
+
export type SectionsUpdateData = boolean;
|
|
1055
|
+
/**
|
|
1056
|
+
* Update section
|
|
1057
|
+
* Request body for PUT /sections/{sectionsUid} — MINIMUM fields, extras pass through
|
|
1058
|
+
*
|
|
1059
|
+
* Request body of: api.vmi.sections.update(sectionsUid, data)
|
|
1060
|
+
*/
|
|
1061
|
+
export interface SectionsUpdateBody {
|
|
1062
|
+
/** Section name; sections_id is re-derived from it */
|
|
1063
|
+
sectionsName?: string | null;
|
|
1064
|
+
/** Section description */
|
|
1065
|
+
sectionsDesc?: string | null;
|
|
1066
|
+
[key: string]: unknown;
|
|
1067
|
+
}
|
|
1068
|
+
/**
|
|
1069
|
+
* DELETE section
|
|
1070
|
+
* Response data for DELETE /sections/{sectionsUid} — MINIMUM fields, extras pass through
|
|
1071
|
+
*
|
|
1072
|
+
* Returned by: api.vmi.sections.delete(sectionsUid)
|
|
1073
|
+
*/
|
|
1074
|
+
export type SectionsDeleteData = boolean;
|
|
1075
|
+
/**
|
|
1076
|
+
* Enable/Disable/Delete section
|
|
1077
|
+
* Response data for PUT /sections/{sectionsUid}/enable — MINIMUM fields, extras pass through
|
|
1078
|
+
*
|
|
1079
|
+
* Returned by: api.vmi.sections.enable.update(sectionsUid, data)
|
|
1080
|
+
*/
|
|
1081
|
+
export type SectionsEnableUpdateData = DistributorsEnableUpdateData;
|
|
1082
|
+
/**
|
|
1083
|
+
* Enable/Disable/Delete section
|
|
1084
|
+
* Request body for PUT /sections/{sectionsUid}/enable — MINIMUM fields, extras pass through
|
|
1085
|
+
*
|
|
1086
|
+
* Request body of: api.vmi.sections.enable.update(sectionsUid, data)
|
|
1087
|
+
*/
|
|
1088
|
+
export type SectionsEnableUpdateBody = DistributorsEnableUpdateBody;
|
|
1089
|
+
/**
|
|
1090
|
+
* List Warehouses
|
|
1091
|
+
* Response data for GET /warehouse — MINIMUM fields, extras pass through
|
|
1092
|
+
*
|
|
1093
|
+
* Field `warehouses` of InvProfileHdrListItem
|
|
1094
|
+
* Returned by: api.vmi.warehouse.list(params) (array items)
|
|
1095
|
+
* Returned by: api.vmi.warehouse.get(warehouseUid)
|
|
1096
|
+
*/
|
|
1097
|
+
export interface WarehouseListItem {
|
|
1098
|
+
/** Warehouse ID */
|
|
1099
|
+
warehouseUid: number;
|
|
1100
|
+
/** Warehouse key derived from the name (max 255 chars) */
|
|
1101
|
+
warehouseId: string;
|
|
1102
|
+
/** Warehouse name (max 255 chars) */
|
|
1103
|
+
warehouseName: string;
|
|
1104
|
+
/** Warehouse description (max 255 chars) */
|
|
1105
|
+
warehouseDesc: string;
|
|
1106
|
+
/** When the warehouse was created (Y-m-d H:i:s) */
|
|
1107
|
+
dateCreated: string;
|
|
1108
|
+
/** When the warehouse last changed (Y-m-d H:i:s) */
|
|
1109
|
+
dateLastModified: string;
|
|
1110
|
+
/** Update code */
|
|
1111
|
+
updateCd: number;
|
|
1112
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1113
|
+
statusCd: number;
|
|
1114
|
+
/** Process code */
|
|
1115
|
+
processCd: number;
|
|
1116
|
+
/** Prophet 21 customer the warehouse belongs to */
|
|
1117
|
+
customerId: number;
|
|
1118
|
+
/** Inventory profile stocked in the warehouse; 0 when none */
|
|
1119
|
+
invProfileHdrUid: number;
|
|
1120
|
+
/** Active users assigned to the warehouse */
|
|
1121
|
+
users: WarehouseUsersListItem[];
|
|
1122
|
+
/** Number of entries in users */
|
|
1123
|
+
userCount: number;
|
|
1124
|
+
[key: string]: unknown;
|
|
1125
|
+
}
|
|
1126
|
+
/** Returned by: api.vmi.warehouse.list(params) */
|
|
1127
|
+
export type WarehouseListData = WarehouseListItem[];
|
|
1128
|
+
/**
|
|
1129
|
+
* Create Warehouse
|
|
1130
|
+
* Response data for POST /warehouse — MINIMUM fields, extras pass through
|
|
1131
|
+
*
|
|
1132
|
+
* Returned by: api.vmi.warehouse.create(data)
|
|
1133
|
+
* Returned by: api.vmi.warehouse.update(warehouseUid, data)
|
|
1134
|
+
* Returned by: api.vmi.warehouse.delete(warehouseUid)
|
|
1135
|
+
*/
|
|
1136
|
+
export interface WarehouseCreateData {
|
|
1137
|
+
/** Warehouse ID */
|
|
1138
|
+
warehouseUid: number;
|
|
1139
|
+
/** Warehouse key derived from the name (max 255 chars) */
|
|
1140
|
+
warehouseId: string;
|
|
1141
|
+
/** Warehouse name (max 255 chars) */
|
|
1142
|
+
warehouseName: string;
|
|
1143
|
+
/** Warehouse description (max 255 chars) */
|
|
1144
|
+
warehouseDesc: string;
|
|
1145
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1146
|
+
dateCreated: string;
|
|
1147
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1148
|
+
dateLastModified: string;
|
|
1149
|
+
/** Update code (1185 = Import Complete) */
|
|
1150
|
+
updateCd: number;
|
|
1151
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1152
|
+
statusCd: number;
|
|
1153
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
1154
|
+
processCd: number;
|
|
1155
|
+
/** Prophet 21 customer the record belongs to */
|
|
1156
|
+
customerId: number;
|
|
1157
|
+
/** Inventory profile stocked in the warehouse; 0 when none */
|
|
1158
|
+
invProfileHdrUid: number;
|
|
1159
|
+
[key: string]: unknown;
|
|
1160
|
+
}
|
|
1161
|
+
/**
|
|
1162
|
+
* Create Warehouse
|
|
1163
|
+
* Request body for POST /warehouse — MINIMUM fields, extras pass through
|
|
1164
|
+
*
|
|
1165
|
+
* Request body of: api.vmi.warehouse.create(data)
|
|
1166
|
+
*/
|
|
1167
|
+
export interface WarehouseCreateBody {
|
|
1168
|
+
/** Prophet 21 customer the warehouse belongs to */
|
|
1169
|
+
customerId: number | null;
|
|
1170
|
+
/** Warehouse name; warehouse_id is derived from it (max 255 chars) */
|
|
1171
|
+
warehouseName: string | null;
|
|
1172
|
+
/** Warehouse description (max 255 chars) */
|
|
1173
|
+
warehouseDesc: string | null;
|
|
1174
|
+
/** Inventory profile stocked in the warehouse; defaults to 0 (none) */
|
|
1175
|
+
invProfileHdrUid?: number | null;
|
|
1176
|
+
[key: string]: unknown;
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* Get Warehouse Details
|
|
1180
|
+
* Response data for GET /warehouse/{warehouseUid} — MINIMUM fields, extras pass through
|
|
1181
|
+
*
|
|
1182
|
+
* Returned by: api.vmi.warehouse.get(warehouseUid)
|
|
1183
|
+
*/
|
|
1184
|
+
export type WarehouseGetData = WarehouseListItem;
|
|
1185
|
+
/**
|
|
1186
|
+
* Update Warehouse
|
|
1187
|
+
* Response data for PUT /warehouse/{warehouseUid} — MINIMUM fields, extras pass through
|
|
1188
|
+
*
|
|
1189
|
+
* Returned by: api.vmi.warehouse.update(warehouseUid, data)
|
|
1190
|
+
*/
|
|
1191
|
+
export type WarehouseUpdateData = WarehouseCreateData;
|
|
1192
|
+
/**
|
|
1193
|
+
* Update Warehouse
|
|
1194
|
+
* Request body for PUT /warehouse/{warehouseUid} — MINIMUM fields, extras pass through
|
|
1195
|
+
*
|
|
1196
|
+
* Request body of: api.vmi.warehouse.update(warehouseUid, data)
|
|
1197
|
+
*/
|
|
1198
|
+
export interface WarehouseUpdateBody {
|
|
1199
|
+
/** Warehouse name; warehouse_id is re-derived from it (max 255 chars) */
|
|
1200
|
+
warehouseName?: string | null;
|
|
1201
|
+
/** Warehouse description (max 255 chars) */
|
|
1202
|
+
warehouseDesc?: string | null;
|
|
1203
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1204
|
+
statusCd?: number | null;
|
|
1205
|
+
/** Prophet 21 customer the warehouse belongs to */
|
|
1206
|
+
customerId?: number | null;
|
|
1207
|
+
/** Inventory profile stocked in the warehouse */
|
|
1208
|
+
invProfileHdrUid?: number | null;
|
|
1209
|
+
/** Update code */
|
|
1210
|
+
updateCd?: number | null;
|
|
1211
|
+
[key: string]: unknown;
|
|
1212
|
+
}
|
|
1213
|
+
/**
|
|
1214
|
+
* DELETE Warehouse
|
|
1215
|
+
* Response data for DELETE /warehouse/{warehouseUid} — MINIMUM fields, extras pass through
|
|
1216
|
+
*
|
|
1217
|
+
* Returned by: api.vmi.warehouse.delete(warehouseUid)
|
|
1218
|
+
*/
|
|
1219
|
+
export type WarehouseDeleteData = WarehouseCreateData;
|
|
1220
|
+
/**
|
|
1221
|
+
* Adjust Inventory
|
|
1222
|
+
* Response data for POST /warehouse/{warehouseUid}/adjust — MINIMUM fields, extras pass through
|
|
1223
|
+
*
|
|
1224
|
+
* Returned by: api.vmi.warehouse.adjust.create(warehouseUid, data) (array items)
|
|
1225
|
+
*/
|
|
1226
|
+
export interface WarehouseAdjustCreateItem {
|
|
1227
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1228
|
+
invMastUid: number;
|
|
1229
|
+
/** Item source: products or prophet21 */
|
|
1230
|
+
invProfileLineType: string;
|
|
1231
|
+
/** New quantity on hand */
|
|
1232
|
+
qtyAdjusted: number;
|
|
1233
|
+
/** Warehouse the count applies to */
|
|
1234
|
+
warehouseUid: number;
|
|
1235
|
+
[key: string]: unknown;
|
|
1236
|
+
}
|
|
1237
|
+
/** Returned by: api.vmi.warehouse.adjust.create(warehouseUid, data) */
|
|
1238
|
+
export type WarehouseAdjustCreateData = WarehouseAdjustCreateItem[];
|
|
1239
|
+
/**
|
|
1240
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
1241
|
+
* Items to count; at least one is required
|
|
1242
|
+
*
|
|
1243
|
+
* Field `items` of WarehouseAdjustCreateBody
|
|
1244
|
+
*/
|
|
1245
|
+
export interface WarehouseAdjustCreateBodyItemsItem {
|
|
1246
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1247
|
+
invMastUid: number | null;
|
|
1248
|
+
/** Item source: products or prophet21 */
|
|
1249
|
+
invProfileLineType: string | null;
|
|
1250
|
+
/** New quantity on hand; replaces the current count */
|
|
1251
|
+
qtyAdjusted: number | null;
|
|
1252
|
+
[key: string]: unknown;
|
|
1253
|
+
}
|
|
1254
|
+
/**
|
|
1255
|
+
* Adjust Inventory
|
|
1256
|
+
* Request body for POST /warehouse/{warehouseUid}/adjust — MINIMUM fields, extras pass through
|
|
1257
|
+
*
|
|
1258
|
+
* Request body of: api.vmi.warehouse.adjust.create(warehouseUid, data)
|
|
1259
|
+
*/
|
|
1260
|
+
export interface WarehouseAdjustCreateBody {
|
|
1261
|
+
/** Items to count; at least one is required */
|
|
1262
|
+
items: WarehouseAdjustCreateBodyItemsItem[];
|
|
1263
|
+
[key: string]: unknown;
|
|
1264
|
+
}
|
|
1265
|
+
/**
|
|
1266
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
1267
|
+
* Items stocked in the section
|
|
1268
|
+
*
|
|
1269
|
+
* Field `items` of WarehouseAvailabilityListDataSectionsValue
|
|
1270
|
+
*/
|
|
1271
|
+
export interface WarehouseAvailabilityListDataSectionsValueItemsItem {
|
|
1272
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1273
|
+
invMastUid: number;
|
|
1274
|
+
/** Item source: products or prophet21 (max 255 chars) */
|
|
1275
|
+
invProfileLineType: string;
|
|
1276
|
+
/** Quantity on hand in the warehouse */
|
|
1277
|
+
qtyOnHand: number;
|
|
1278
|
+
/** Item ID, or Unknown when the item is not found */
|
|
1279
|
+
itemId: string;
|
|
1280
|
+
/** Item description, or Unknown when the item is not found */
|
|
1281
|
+
itemDesc: string | null;
|
|
1282
|
+
[key: string]: unknown;
|
|
1283
|
+
}
|
|
1284
|
+
/**
|
|
1285
|
+
* Shape of `sections` (MINIMUM fields; reused wherever the same shape appears)
|
|
1286
|
+
* Sections keyed by sectionsId; an empty list when the warehouse has no profile items
|
|
1287
|
+
*
|
|
1288
|
+
* Field `sections` of WarehouseAvailabilityListData
|
|
1289
|
+
*/
|
|
1290
|
+
export interface WarehouseAvailabilityListDataSectionsValue {
|
|
1291
|
+
/** Section name, or Unknown for items with no section */
|
|
1292
|
+
sectionsName: string;
|
|
1293
|
+
/** Section key, or Unknown for items with no section */
|
|
1294
|
+
sectionsId: string;
|
|
1295
|
+
/** Section description, or Unknown for items with no section */
|
|
1296
|
+
sectionsDesc: string;
|
|
1297
|
+
/** Items stocked in the section */
|
|
1298
|
+
items: WarehouseAvailabilityListDataSectionsValueItemsItem[];
|
|
1299
|
+
[key: string]: unknown;
|
|
1300
|
+
}
|
|
1301
|
+
/**
|
|
1302
|
+
* List inventory availability
|
|
1303
|
+
* Response data for GET /warehouse/{warehouseUid}/availability — MINIMUM fields, extras pass
|
|
1304
|
+
* through
|
|
1305
|
+
*
|
|
1306
|
+
* Returned by: api.vmi.warehouse.availability.list(warehouseUid, params)
|
|
1307
|
+
*/
|
|
1308
|
+
export interface WarehouseAvailabilityListData {
|
|
1309
|
+
/** Warehouse ID */
|
|
1310
|
+
warehouseUid: number;
|
|
1311
|
+
/** Sections keyed by sectionsId; an empty list when the warehouse has no profile items */
|
|
1312
|
+
sections: Record<string, WarehouseAvailabilityListDataSectionsValue>;
|
|
1313
|
+
/** Inventory profile stocked in the warehouse */
|
|
1314
|
+
invProfileHdrUid: number;
|
|
1315
|
+
[key: string]: unknown;
|
|
1316
|
+
}
|
|
1317
|
+
/**
|
|
1318
|
+
* Enable/Disable/Delete Warehouse
|
|
1319
|
+
* Response data for PUT /warehouse/{warehouseUid}/enable — MINIMUM fields, extras pass through
|
|
1320
|
+
*
|
|
1321
|
+
* Returned by: api.vmi.warehouse.enable.update(warehouseUid, data)
|
|
1322
|
+
*/
|
|
1323
|
+
export type WarehouseEnableUpdateData = DistributorsEnableUpdateData;
|
|
1324
|
+
/**
|
|
1325
|
+
* Enable/Disable/Delete Warehouse
|
|
1326
|
+
* Request body for PUT /warehouse/{warehouseUid}/enable — MINIMUM fields, extras pass through
|
|
1327
|
+
*
|
|
1328
|
+
* Request body of: api.vmi.warehouse.enable.update(warehouseUid, data)
|
|
1329
|
+
*/
|
|
1330
|
+
export type WarehouseEnableUpdateBody = DistributorsEnableUpdateBody;
|
|
1331
|
+
/**
|
|
1332
|
+
* Receive Inventory
|
|
1333
|
+
* Response data for POST /warehouse/{warehouseUid}/receive — MINIMUM fields, extras pass through
|
|
1334
|
+
*
|
|
1335
|
+
* Returned by: api.vmi.warehouse.receive.create(warehouseUid, data) (array items)
|
|
1336
|
+
*/
|
|
1337
|
+
export interface WarehouseReceiveCreateItem {
|
|
1338
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1339
|
+
invMastUid: number;
|
|
1340
|
+
/** Item source: products or prophet21 */
|
|
1341
|
+
invProfileLineType: string;
|
|
1342
|
+
/** Quantity added to on hand */
|
|
1343
|
+
qtyReceived: number;
|
|
1344
|
+
/** Warehouse that received the item */
|
|
1345
|
+
warehouseUid: number;
|
|
1346
|
+
[key: string]: unknown;
|
|
1347
|
+
}
|
|
1348
|
+
/** Returned by: api.vmi.warehouse.receive.create(warehouseUid, data) */
|
|
1349
|
+
export type WarehouseReceiveCreateData = WarehouseReceiveCreateItem[];
|
|
1350
|
+
/**
|
|
1351
|
+
* Shape of `items` (MINIMUM fields; reused wherever the same shape appears)
|
|
1352
|
+
* Items received; at least one is required
|
|
1353
|
+
*
|
|
1354
|
+
* Field `items` of WarehouseReceiveCreateBody
|
|
1355
|
+
*/
|
|
1356
|
+
export interface WarehouseReceiveCreateBodyItemsItem {
|
|
1357
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1358
|
+
invMastUid: number | null;
|
|
1359
|
+
/** Item source: products or prophet21 */
|
|
1360
|
+
invProfileLineType: string | null;
|
|
1361
|
+
/** Quantity received; added to the quantity on hand */
|
|
1362
|
+
qtyReceived: number | null;
|
|
1363
|
+
[key: string]: unknown;
|
|
1364
|
+
}
|
|
1365
|
+
/**
|
|
1366
|
+
* Receive Inventory
|
|
1367
|
+
* Request body for POST /warehouse/{warehouseUid}/receive — MINIMUM fields, extras pass through
|
|
1368
|
+
*
|
|
1369
|
+
* Request body of: api.vmi.warehouse.receive.create(warehouseUid, data)
|
|
1370
|
+
*/
|
|
1371
|
+
export interface WarehouseReceiveCreateBody {
|
|
1372
|
+
/** Items received; at least one is required */
|
|
1373
|
+
items: WarehouseReceiveCreateBodyItemsItem[];
|
|
1374
|
+
[key: string]: unknown;
|
|
1375
|
+
}
|
|
1376
|
+
/**
|
|
1377
|
+
* Shape of `lines` (MINIMUM fields; reused wherever the same shape appears)
|
|
1378
|
+
* Profile items, limited to the distributor filter
|
|
1379
|
+
*
|
|
1380
|
+
* Field `lines` of WarehouseReplenishListData
|
|
1381
|
+
*/
|
|
1382
|
+
export interface WarehouseReplenishListDataLinesItem {
|
|
1383
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1384
|
+
invMastUid: number;
|
|
1385
|
+
/** Item source: products or prophet21 */
|
|
1386
|
+
invProfileLineType: string;
|
|
1387
|
+
/** Supplying distributor; 0 for a Prophet 21 item */
|
|
1388
|
+
distributorsUid: number;
|
|
1389
|
+
/** Supplying distributor's name; Duncan Supply for a Prophet 21 item */
|
|
1390
|
+
distributorName: string;
|
|
1391
|
+
/** Inventory profile the item belongs to */
|
|
1392
|
+
invProfileHdrUid: number;
|
|
1393
|
+
/** Quantity on hand in the warehouse */
|
|
1394
|
+
qtyOnHand: number;
|
|
1395
|
+
/** Minimum quantity to keep on hand */
|
|
1396
|
+
minQty: number;
|
|
1397
|
+
/** Maximum quantity to keep on hand; -1 for no maximum */
|
|
1398
|
+
maxQty: number;
|
|
1399
|
+
/** Quantity to reorder */
|
|
1400
|
+
reorderQty: number;
|
|
1401
|
+
[key: string]: unknown;
|
|
1402
|
+
}
|
|
1403
|
+
/**
|
|
1404
|
+
* Shape of `params` (MINIMUM fields; reused wherever the same shape appears)
|
|
1405
|
+
* The filters the report was built with
|
|
1406
|
+
*
|
|
1407
|
+
* Field `params` of WarehouseReplenishListData
|
|
1408
|
+
*/
|
|
1409
|
+
export interface WarehouseReplenishListDataParams {
|
|
1410
|
+
/** Warehouse from the path */
|
|
1411
|
+
warehouseUid: number;
|
|
1412
|
+
/** Distributor filter; -1 when every distributor was included */
|
|
1413
|
+
distributorsUid: number;
|
|
1414
|
+
[key: string]: unknown;
|
|
1415
|
+
}
|
|
1416
|
+
/**
|
|
1417
|
+
* Get Replenish Information
|
|
1418
|
+
* Response data for GET /warehouse/{warehouseUid}/replenish — MINIMUM fields, extras pass through
|
|
1419
|
+
*
|
|
1420
|
+
* Returned by: api.vmi.warehouse.replenish.list(warehouseUid, params)
|
|
1421
|
+
*/
|
|
1422
|
+
export interface WarehouseReplenishListData {
|
|
1423
|
+
/** Warehouse ID */
|
|
1424
|
+
warehouseUid: number;
|
|
1425
|
+
/** Distributor filter; -1 when every distributor is included */
|
|
1426
|
+
distributorsUid: number;
|
|
1427
|
+
/** Warehouse name */
|
|
1428
|
+
warehouseName: string;
|
|
1429
|
+
/** Inventory profile stocked in the warehouse */
|
|
1430
|
+
invProfileHdrUid: number;
|
|
1431
|
+
/** Profile items, limited to the distributor filter */
|
|
1432
|
+
lines: WarehouseReplenishListDataLinesItem[];
|
|
1433
|
+
/** The filters the report was built with */
|
|
1434
|
+
params: WarehouseReplenishListDataParams;
|
|
1435
|
+
[key: string]: unknown;
|
|
1436
|
+
}
|
|
1437
|
+
/**
|
|
1438
|
+
* Shape of `warranty` (MINIMUM fields; reused wherever the same shape appears)
|
|
1439
|
+
* Warranty claim; the key is absent when none was sent
|
|
1440
|
+
*
|
|
1441
|
+
* Field `warranty` of WarehouseUsageCreateDataUsageItemsItem
|
|
1442
|
+
*/
|
|
1443
|
+
export interface WarehouseUsageCreateDataUsageItemsItemWarranty {
|
|
1444
|
+
/** When the item failed (Y-m-d H:i:s) */
|
|
1445
|
+
dateFailed: string | null;
|
|
1446
|
+
/** Model number of the failed item */
|
|
1447
|
+
modelNo: string;
|
|
1448
|
+
/** Warranty notes */
|
|
1449
|
+
notes: string | null;
|
|
1450
|
+
/** Serial number of the failed item */
|
|
1451
|
+
serialNo: string | null;
|
|
1452
|
+
/** Usage line the claim belongs to */
|
|
1453
|
+
usageLineUid: number;
|
|
1454
|
+
/** Warranty claim ID */
|
|
1455
|
+
usageLineWarrantyUid: number;
|
|
1456
|
+
/** Warranty type */
|
|
1457
|
+
warrantyType: string | null;
|
|
1458
|
+
[key: string]: unknown;
|
|
1459
|
+
}
|
|
1460
|
+
/**
|
|
1461
|
+
* Shape of `usageItems` (MINIMUM fields; reused wherever the same shape appears)
|
|
1462
|
+
* Lines recorded; an item skipped for a missing invMastUid or quantity is absent
|
|
1463
|
+
*
|
|
1464
|
+
* Field `usageItems` of WarehouseUsageCreateData
|
|
1465
|
+
*/
|
|
1466
|
+
export interface WarehouseUsageCreateDataUsageItemsItem {
|
|
1467
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1468
|
+
invMastUid: number;
|
|
1469
|
+
/** Item source: products or prophet21 (max 255 chars) */
|
|
1470
|
+
invProfileLineType: string;
|
|
1471
|
+
/** Line number, starting at 1 */
|
|
1472
|
+
lineNo: number;
|
|
1473
|
+
/** Quantity left on hand after the usage, never below zero */
|
|
1474
|
+
qtyOnHand: number;
|
|
1475
|
+
/** Quantity used */
|
|
1476
|
+
qtyUsed: number;
|
|
1477
|
+
/** Usage record the line belongs to */
|
|
1478
|
+
usageHdrUid: number;
|
|
1479
|
+
/** Usage line ID */
|
|
1480
|
+
usageLineUid: number;
|
|
1481
|
+
/** Warranty claim; the key is absent when none was sent */
|
|
1482
|
+
warranty?: WarehouseUsageCreateDataUsageItemsItemWarranty | null;
|
|
1483
|
+
[key: string]: unknown;
|
|
1484
|
+
}
|
|
1485
|
+
/**
|
|
1486
|
+
* Use Inventory
|
|
1487
|
+
* Response data for POST /warehouse/{warehouseUid}/usage — MINIMUM fields, extras pass through
|
|
1488
|
+
*
|
|
1489
|
+
* Returned by: api.vmi.warehouse.usage.create(warehouseUid, data)
|
|
1490
|
+
*/
|
|
1491
|
+
export interface WarehouseUsageCreateData {
|
|
1492
|
+
/** Department the usage is charged to */
|
|
1493
|
+
department: string | null;
|
|
1494
|
+
/** Job or purpose the items were used for */
|
|
1495
|
+
jobDescription: string;
|
|
1496
|
+
/** Usage record ID */
|
|
1497
|
+
usageHdrUid: number;
|
|
1498
|
+
/** Lines recorded; an item skipped for a missing invMastUid or quantity is absent */
|
|
1499
|
+
usageItems: WarehouseUsageCreateDataUsageItemsItem[];
|
|
1500
|
+
/** Warehouse the items were used from */
|
|
1501
|
+
warehouseUid: number;
|
|
1502
|
+
[key: string]: unknown;
|
|
1503
|
+
}
|
|
1504
|
+
/**
|
|
1505
|
+
* Shape of `warranty` (MINIMUM fields; reused wherever the same shape appears)
|
|
1506
|
+
* Warranty claim for the item
|
|
1507
|
+
*
|
|
1508
|
+
* Field `warranty` of WarehouseUsageCreateBodyUsageItemsItem
|
|
1509
|
+
*/
|
|
1510
|
+
export interface WarehouseUsageCreateBodyUsageItemsItemWarranty {
|
|
1511
|
+
/** Model number of the failed item */
|
|
1512
|
+
modelNo: string | null;
|
|
1513
|
+
/** Serial number of the failed item */
|
|
1514
|
+
serialNo?: string | null;
|
|
1515
|
+
/** Warranty type */
|
|
1516
|
+
warrantyType?: string | null;
|
|
1517
|
+
/** When the item failed (Y-m-d H:i:s) */
|
|
1518
|
+
dateFailed?: string | null;
|
|
1519
|
+
/** Warranty notes */
|
|
1520
|
+
notes?: string | null;
|
|
1521
|
+
[key: string]: unknown;
|
|
1522
|
+
}
|
|
1523
|
+
/**
|
|
1524
|
+
* Shape of `usageItems` (MINIMUM fields; reused wherever the same shape appears)
|
|
1525
|
+
* Items used
|
|
1526
|
+
*
|
|
1527
|
+
* Field `usageItems` of WarehouseUsageCreateBody
|
|
1528
|
+
*/
|
|
1529
|
+
export interface WarehouseUsageCreateBodyUsageItemsItem {
|
|
1530
|
+
/** products_uid for a VMI product, inv_mast_uid for a Prophet 21 item */
|
|
1531
|
+
invMastUid: number | null;
|
|
1532
|
+
/** Quantity used; subtracted from on hand, never below zero */
|
|
1533
|
+
qtyUsed: number | null;
|
|
1534
|
+
/** Item source: products or prophet21; defaults to prophet21 (max 255 chars) */
|
|
1535
|
+
invProfileLineType?: string | null;
|
|
1536
|
+
/** Warranty claim for the item */
|
|
1537
|
+
warranty?: WarehouseUsageCreateBodyUsageItemsItemWarranty | null;
|
|
1538
|
+
[key: string]: unknown;
|
|
1539
|
+
}
|
|
1540
|
+
/**
|
|
1541
|
+
* Use Inventory
|
|
1542
|
+
* Request body for POST /warehouse/{warehouseUid}/usage — MINIMUM fields, extras pass through
|
|
1543
|
+
*
|
|
1544
|
+
* Request body of: api.vmi.warehouse.usage.create(warehouseUid, data)
|
|
1545
|
+
*/
|
|
1546
|
+
export interface WarehouseUsageCreateBody {
|
|
1547
|
+
/** Job or purpose the items were used for */
|
|
1548
|
+
jobDescription: string;
|
|
1549
|
+
/** Items used */
|
|
1550
|
+
usageItems: WarehouseUsageCreateBodyUsageItemsItem[];
|
|
1551
|
+
/** Department the usage is charged to */
|
|
1552
|
+
department?: string | null;
|
|
1553
|
+
[key: string]: unknown;
|
|
1554
|
+
}
|
|
1555
|
+
/**
|
|
1556
|
+
* List Warehouses Users
|
|
1557
|
+
* Response data for GET /warehouse/{warehouseUid}/users — MINIMUM fields, extras pass through
|
|
1558
|
+
*
|
|
1559
|
+
* Field `users` of WarehouseListItem
|
|
1560
|
+
* Returned by: api.vmi.warehouse.users.list(warehouseUid, params) (array items)
|
|
1561
|
+
* Returned by: api.vmi.warehouse.users.get(warehouseUid, usersId)
|
|
1562
|
+
*/
|
|
1563
|
+
export interface WarehouseUsersListItem {
|
|
1564
|
+
/** Assignment ID */
|
|
1565
|
+
warehouseXUsersUid: number;
|
|
1566
|
+
/** Warehouse the user is assigned to */
|
|
1567
|
+
warehouseUid: number;
|
|
1568
|
+
/** joomla.users.id of the assigned user */
|
|
1569
|
+
usersId: number;
|
|
1570
|
+
/** false when no Joomla user has this ID; the name fields then read invalid */
|
|
1571
|
+
isValidUser: boolean;
|
|
1572
|
+
/** Joomla username */
|
|
1573
|
+
username: string;
|
|
1574
|
+
/** Joomla display name */
|
|
1575
|
+
name: string;
|
|
1576
|
+
/** Prophet 21 customer ID from the user's profile */
|
|
1577
|
+
customerId: string;
|
|
1578
|
+
/** Prophet 21 contact ID from the user's profile */
|
|
1579
|
+
contactId: string;
|
|
1580
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1581
|
+
statusCd: number;
|
|
1582
|
+
/** When the assignment was created (Y-m-d H:i:s) */
|
|
1583
|
+
dateCreated: string;
|
|
1584
|
+
/** When the assignment last changed (Y-m-d H:i:s) */
|
|
1585
|
+
dateLastModified: string;
|
|
1586
|
+
[key: string]: unknown;
|
|
1587
|
+
}
|
|
1588
|
+
/** Returned by: api.vmi.warehouse.users.list(warehouseUid, params) */
|
|
1589
|
+
export type WarehouseUsersListData = WarehouseUsersListItem[];
|
|
1590
|
+
/**
|
|
1591
|
+
* Create/update Warehouse User
|
|
1592
|
+
* Response data for POST /warehouse/{warehouseUid}/users — MINIMUM fields, extras pass through
|
|
1593
|
+
*
|
|
1594
|
+
* Returned by: api.vmi.warehouse.users.create(warehouseUid, data, params)
|
|
1595
|
+
* Returned by: api.vmi.warehouse.users.update(warehouseUid, usersId, data)
|
|
1596
|
+
* Returned by: api.vmi.warehouse.users.delete(warehouseUid, usersId)
|
|
1597
|
+
*/
|
|
1598
|
+
export interface WarehouseUsersCreateData {
|
|
1599
|
+
/** Assignment ID */
|
|
1600
|
+
warehouseXUsersUid: number;
|
|
1601
|
+
/** Warehouse the user is assigned to */
|
|
1602
|
+
warehouseUid: number;
|
|
1603
|
+
/** joomla.users.id */
|
|
1604
|
+
usersId: number;
|
|
1605
|
+
/** When the record was created (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1606
|
+
dateCreated: string;
|
|
1607
|
+
/** When the record last changed (mysql-datetime, e.g. 2025-07-30 15:50:49) */
|
|
1608
|
+
dateLastModified: string;
|
|
1609
|
+
/** Update code (1185 = Import Complete) */
|
|
1610
|
+
updateCd: number;
|
|
1611
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1612
|
+
statusCd: number;
|
|
1613
|
+
/** Process code (704 = Active, 1185 = Import Complete) */
|
|
1614
|
+
processCd: number;
|
|
1615
|
+
[key: string]: unknown;
|
|
1616
|
+
}
|
|
1617
|
+
/**
|
|
1618
|
+
* Create/update Warehouse User
|
|
1619
|
+
* Request body for POST /warehouse/{warehouseUid}/users — MINIMUM fields, extras pass through
|
|
1620
|
+
*
|
|
1621
|
+
* Request body of: api.vmi.warehouse.users.create(warehouseUid, data, params)
|
|
1622
|
+
*/
|
|
1623
|
+
export interface WarehouseUsersCreateBody {
|
|
1624
|
+
/** joomla.users.id to assign */
|
|
1625
|
+
usersId: number | null;
|
|
1626
|
+
/**
|
|
1627
|
+
* true makes this the warehouse's only active user; when absent the makePrimaryUser=Y query param
|
|
1628
|
+
* decides
|
|
1629
|
+
*/
|
|
1630
|
+
makePrimaryUser?: boolean | null;
|
|
1631
|
+
[key: string]: unknown;
|
|
1632
|
+
}
|
|
1633
|
+
/**
|
|
1634
|
+
* Get Warehouse User Assignment
|
|
1635
|
+
* Response data for GET /warehouse/{warehouseUid}/users/{usersId} — MINIMUM fields, extras pass
|
|
1636
|
+
* through
|
|
1637
|
+
*
|
|
1638
|
+
* Returned by: api.vmi.warehouse.users.get(warehouseUid, usersId)
|
|
1639
|
+
*/
|
|
1640
|
+
export type WarehouseUsersGetData = WarehouseUsersListItem;
|
|
1641
|
+
/**
|
|
1642
|
+
* Update Warehouse User Assignment
|
|
1643
|
+
* Response data for PUT /warehouse/{warehouseUid}/users/{usersId} — MINIMUM fields, extras pass
|
|
1644
|
+
* through
|
|
1645
|
+
*
|
|
1646
|
+
* Returned by: api.vmi.warehouse.users.update(warehouseUid, usersId, data)
|
|
1647
|
+
*/
|
|
1648
|
+
export type WarehouseUsersUpdateData = WarehouseUsersCreateData;
|
|
1649
|
+
/**
|
|
1650
|
+
* Update Warehouse User Assignment
|
|
1651
|
+
* Request body for PUT /warehouse/{warehouseUid}/users/{usersId} — MINIMUM fields, extras pass
|
|
1652
|
+
* through
|
|
1653
|
+
*
|
|
1654
|
+
* Request body of: api.vmi.warehouse.users.update(warehouseUid, usersId, data)
|
|
1655
|
+
*/
|
|
1656
|
+
export interface WarehouseUsersUpdateBody {
|
|
1657
|
+
/** Status code (704 = Active, 705 = Inactive, 700 = Deleted) */
|
|
1658
|
+
statusCd?: number | null;
|
|
1659
|
+
/** Process code (700, 704, 705, or 1185) */
|
|
1660
|
+
processCd?: number | null;
|
|
1661
|
+
[key: string]: unknown;
|
|
1662
|
+
}
|
|
1663
|
+
/**
|
|
1664
|
+
* Remove User from Warehouse
|
|
1665
|
+
* Response data for DELETE /warehouse/{warehouseUid}/users/{usersId} — MINIMUM fields, extras pass
|
|
1666
|
+
* through
|
|
1667
|
+
*
|
|
1668
|
+
* Returned by: api.vmi.warehouse.users.delete(warehouseUid, usersId)
|
|
1669
|
+
*/
|
|
1670
|
+
export type WarehouseUsersDeleteData = WarehouseUsersCreateData;
|
|
1671
|
+
export interface VMIClientSpec {
|
|
1672
|
+
distributors: {
|
|
1673
|
+
/**
|
|
1674
|
+
* List distributors
|
|
1675
|
+
* Call: api.vmi.distributors.list(params)
|
|
1676
|
+
*
|
|
1677
|
+
* Errors:
|
|
1678
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1679
|
+
*
|
|
1680
|
+
* GET https://vmi.augur-api.com/distributors
|
|
1681
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1distributors/get
|
|
1682
|
+
*
|
|
1683
|
+
* @param params DistributorsListParams (query string)
|
|
1684
|
+
* @returns BaseResponse whose `data` is DistributorsListData
|
|
1685
|
+
*/
|
|
1686
|
+
list: (params?: DistributorsListParams) => Promise<BaseResponse<DistributorsListData>>;
|
|
1687
|
+
/**
|
|
1688
|
+
* Create distributor
|
|
1689
|
+
* Call: api.vmi.distributors.create(data)
|
|
1690
|
+
*
|
|
1691
|
+
* Request body: Create a distributor for a customer, or return the one whose derived
|
|
1692
|
+
* distributors_id already exists
|
|
1693
|
+
*
|
|
1694
|
+
* Errors:
|
|
1695
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1696
|
+
*
|
|
1697
|
+
* POST https://vmi.augur-api.com/distributors
|
|
1698
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1distributors/post
|
|
1699
|
+
*
|
|
1700
|
+
* @param data DistributorsCreateBody (request body)
|
|
1701
|
+
* @returns BaseResponse whose `data` is DistributorsCreateData
|
|
1702
|
+
*/
|
|
1703
|
+
create: (data: DistributorsCreateBody) => Promise<BaseResponse<DistributorsCreateData>>;
|
|
1704
|
+
/**
|
|
1705
|
+
* Get distributor Details
|
|
1706
|
+
* Call: api.vmi.distributors.get(distributorsUid)
|
|
1707
|
+
*
|
|
1708
|
+
* Errors:
|
|
1709
|
+
* 404: No distributor with this distributorsUid.
|
|
1710
|
+
*
|
|
1711
|
+
* GET https://vmi.augur-api.com/distributors/{distributorsUid}
|
|
1712
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}/get
|
|
1713
|
+
*
|
|
1714
|
+
* @param distributorsUid Distributor ID
|
|
1715
|
+
* @param params DistributorsGetParams (query string)
|
|
1716
|
+
* @returns BaseResponse whose `data` is DistributorsGetData
|
|
1717
|
+
*/
|
|
1718
|
+
get: (distributorsUid: number, params?: DistributorsGetParams) => Promise<BaseResponse<DistributorsGetData>>;
|
|
1719
|
+
/**
|
|
1720
|
+
* Update distributor
|
|
1721
|
+
* Call: api.vmi.distributors.update(distributorsUid, data)
|
|
1722
|
+
*
|
|
1723
|
+
* Request body: Change a distributor; an absent field keeps its current value
|
|
1724
|
+
*
|
|
1725
|
+
* Errors:
|
|
1726
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1727
|
+
* 404: No row exists with this ID.
|
|
1728
|
+
*
|
|
1729
|
+
* PUT https://vmi.augur-api.com/distributors/{distributorsUid}
|
|
1730
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}/put
|
|
1731
|
+
*
|
|
1732
|
+
* @param distributorsUid Distributor ID
|
|
1733
|
+
* @param data DistributorsUpdateBody (request body)
|
|
1734
|
+
* @returns BaseResponse whose `data` is DistributorsUpdateData
|
|
1735
|
+
*/
|
|
1736
|
+
update: (distributorsUid: number, data: DistributorsUpdateBody) => Promise<BaseResponse<DistributorsUpdateData>>;
|
|
1737
|
+
/**
|
|
1738
|
+
* DELETE distributor
|
|
1739
|
+
* Call: api.vmi.distributors.delete(distributorsUid)
|
|
1740
|
+
*
|
|
1741
|
+
* Errors:
|
|
1742
|
+
* 404: No row exists with this ID.
|
|
1743
|
+
*
|
|
1744
|
+
* DELETE https://vmi.augur-api.com/distributors/{distributorsUid}
|
|
1745
|
+
* Contract:
|
|
1746
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}/delete
|
|
1747
|
+
*
|
|
1748
|
+
* @param distributorsUid Distributor ID
|
|
1749
|
+
* @returns BaseResponse whose `data` is DistributorsDeleteData
|
|
1750
|
+
*/
|
|
1751
|
+
delete: (distributorsUid: number) => Promise<BaseResponse<DistributorsDeleteData>>;
|
|
1752
|
+
enable: {
|
|
1753
|
+
/**
|
|
1754
|
+
* Enable/Disable/Delete distributor
|
|
1755
|
+
* Call: api.vmi.distributors.enable.update(distributorsUid, data)
|
|
1756
|
+
*
|
|
1757
|
+
* Request body: Enable, disable, or delete a record; with neither field the record is enabled
|
|
1758
|
+
* Response data: Outcome of an enable, disable, or delete request
|
|
1759
|
+
*
|
|
1760
|
+
* Errors:
|
|
1761
|
+
* 400: distributorsUid is below 1.
|
|
1762
|
+
* 404: No row exists with this ID.
|
|
1763
|
+
*
|
|
1764
|
+
* PUT https://vmi.augur-api.com/distributors/{distributorsUid}/enable
|
|
1765
|
+
* Contract:
|
|
1766
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}~1enable/put
|
|
1767
|
+
*
|
|
1768
|
+
* @param distributorsUid Distributor ID
|
|
1769
|
+
* @param data DistributorsEnableUpdateBody (request body)
|
|
1770
|
+
* @returns BaseResponse whose `data` is DistributorsEnableUpdateData
|
|
1771
|
+
*/
|
|
1772
|
+
update: (distributorsUid: number, data: DistributorsEnableUpdateBody) => Promise<BaseResponse<DistributorsEnableUpdateData>>;
|
|
1773
|
+
};
|
|
1774
|
+
products: {
|
|
1775
|
+
/**
|
|
1776
|
+
* Create Product
|
|
1777
|
+
* Call: api.vmi.distributors.products.create(distributorsUid, data)
|
|
1778
|
+
*
|
|
1779
|
+
* Request body: Create a distributor product, or return the one with the same products_id;
|
|
1780
|
+
* the distributor comes from the path
|
|
1781
|
+
*
|
|
1782
|
+
* Errors:
|
|
1783
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1784
|
+
* 404: No distributor with this distributorsUid.
|
|
1785
|
+
*
|
|
1786
|
+
* POST https://vmi.augur-api.com/distributors/{distributorsUid}/products
|
|
1787
|
+
* Contract:
|
|
1788
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1distributors~1{distributorsUid}~1products/post
|
|
1789
|
+
*
|
|
1790
|
+
* @param distributorsUid Distributor ID
|
|
1791
|
+
* @param data DistributorsProductsCreateBody (request body)
|
|
1792
|
+
* @returns BaseResponse whose `data` is DistributorsProductsCreateData
|
|
1793
|
+
*/
|
|
1794
|
+
create: (distributorsUid: number, data: DistributorsProductsCreateBody) => Promise<BaseResponse<DistributorsProductsCreateData>>;
|
|
1795
|
+
};
|
|
1796
|
+
};
|
|
1797
|
+
invProfileHdr: {
|
|
1798
|
+
/**
|
|
1799
|
+
* List Inventory Profile Headers
|
|
1800
|
+
* Call: api.vmi.invProfileHdr.list(params)
|
|
1801
|
+
*
|
|
1802
|
+
* Response data, each item: An inventory profile with the active warehouses that stock it
|
|
1803
|
+
*
|
|
1804
|
+
* Errors:
|
|
1805
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1806
|
+
*
|
|
1807
|
+
* GET https://vmi.augur-api.com/inv-profile-hdr
|
|
1808
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr/get
|
|
1809
|
+
*
|
|
1810
|
+
* @param params InvProfileHdrListParams (query string)
|
|
1811
|
+
* @returns BaseResponse whose `data` is InvProfileHdrListData
|
|
1812
|
+
*/
|
|
1813
|
+
list: (params?: InvProfileHdrListParams) => Promise<BaseResponse<InvProfileHdrListData>>;
|
|
1814
|
+
/**
|
|
1815
|
+
* Create Inventory Profile Header
|
|
1816
|
+
* Call: api.vmi.invProfileHdr.create(data)
|
|
1817
|
+
*
|
|
1818
|
+
* Request body: Create an inventory profile for a customer, or return the one whose derived
|
|
1819
|
+
* inv_profile_hdr_id already exists
|
|
1820
|
+
*
|
|
1821
|
+
* Errors:
|
|
1822
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1823
|
+
*
|
|
1824
|
+
* POST https://vmi.augur-api.com/inv-profile-hdr
|
|
1825
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr/post
|
|
1826
|
+
*
|
|
1827
|
+
* @param data InvProfileHdrCreateBody (request body)
|
|
1828
|
+
* @returns BaseResponse whose `data` is InvProfileHdrCreateData
|
|
1829
|
+
*/
|
|
1830
|
+
create: (data: InvProfileHdrCreateBody) => Promise<BaseResponse<InvProfileHdrCreateData>>;
|
|
1831
|
+
/**
|
|
1832
|
+
* Get Inventory Profile Header Details
|
|
1833
|
+
* Call: api.vmi.invProfileHdr.get(invProfileHdrUid)
|
|
1834
|
+
*
|
|
1835
|
+
* Response data: An inventory profile with the active warehouses that stock it
|
|
1836
|
+
*
|
|
1837
|
+
* Errors:
|
|
1838
|
+
* 404: No inventory profile with this invProfileHdrUid.
|
|
1839
|
+
*
|
|
1840
|
+
* GET https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
|
|
1841
|
+
* Contract:
|
|
1842
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}/get
|
|
1843
|
+
*
|
|
1844
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1845
|
+
* @param params InvProfileHdrGetParams (query string)
|
|
1846
|
+
* @returns BaseResponse whose `data` is InvProfileHdrGetData
|
|
1847
|
+
*/
|
|
1848
|
+
get: (invProfileHdrUid: number, params?: InvProfileHdrGetParams) => Promise<BaseResponse<InvProfileHdrGetData>>;
|
|
1849
|
+
/**
|
|
1850
|
+
* Update Inventory Profile Header
|
|
1851
|
+
* Call: api.vmi.invProfileHdr.update(invProfileHdrUid, data)
|
|
1852
|
+
*
|
|
1853
|
+
* Request body: Change an inventory profile; an absent field keeps its current value
|
|
1854
|
+
*
|
|
1855
|
+
* Errors:
|
|
1856
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1857
|
+
* 404: No row exists with this ID.
|
|
1858
|
+
*
|
|
1859
|
+
* PUT https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
|
|
1860
|
+
* Contract:
|
|
1861
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}/put
|
|
1862
|
+
*
|
|
1863
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1864
|
+
* @param data InvProfileHdrUpdateBody (request body)
|
|
1865
|
+
* @returns BaseResponse whose `data` is InvProfileHdrUpdateData
|
|
1866
|
+
*/
|
|
1867
|
+
update: (invProfileHdrUid: number, data: InvProfileHdrUpdateBody) => Promise<BaseResponse<InvProfileHdrUpdateData>>;
|
|
1868
|
+
/**
|
|
1869
|
+
* DELETE Inventory Profile Header
|
|
1870
|
+
* Call: api.vmi.invProfileHdr.delete(invProfileHdrUid)
|
|
1871
|
+
*
|
|
1872
|
+
* Errors:
|
|
1873
|
+
* 404: No row exists with this ID.
|
|
1874
|
+
*
|
|
1875
|
+
* DELETE https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}
|
|
1876
|
+
* Contract:
|
|
1877
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}/delete
|
|
1878
|
+
*
|
|
1879
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1880
|
+
* @returns BaseResponse whose `data` is InvProfileHdrDeleteData
|
|
1881
|
+
*/
|
|
1882
|
+
delete: (invProfileHdrUid: number) => Promise<BaseResponse<InvProfileHdrDeleteData>>;
|
|
1883
|
+
invProfileLine: {
|
|
1884
|
+
/**
|
|
1885
|
+
* List Inventory Profile Lines
|
|
1886
|
+
* Call: api.vmi.invProfileHdr.invProfileLine.list(invProfileHdrUid, params)
|
|
1887
|
+
*
|
|
1888
|
+
* Errors:
|
|
1889
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1890
|
+
* 404: No inventory profile with this invProfileHdrUid.
|
|
1891
|
+
*
|
|
1892
|
+
* GET https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line
|
|
1893
|
+
* Contract:
|
|
1894
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}~1inv-profile-line/get
|
|
1895
|
+
*
|
|
1896
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1897
|
+
* @param params InvProfileHdrInvProfileLineListParams (query string)
|
|
1898
|
+
* @returns BaseResponse whose `data` is InvProfileHdrInvProfileLineListData
|
|
1899
|
+
*/
|
|
1900
|
+
list: (invProfileHdrUid: number, params?: InvProfileHdrInvProfileLineListParams) => Promise<BaseResponse<InvProfileHdrInvProfileLineListData>>;
|
|
1901
|
+
/**
|
|
1902
|
+
* Create Inventory Profile Lines
|
|
1903
|
+
* Call: api.vmi.invProfileHdr.invProfileLine.create(invProfileHdrUid, data)
|
|
1904
|
+
*
|
|
1905
|
+
* Request body, each item: One line to add to an inventory profile, which comes from the
|
|
1906
|
+
* path; an existing line with the same item is returned
|
|
1907
|
+
*
|
|
1908
|
+
* Errors:
|
|
1909
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1910
|
+
* 404: No inventory profile with this invProfileHdrUid.
|
|
1911
|
+
*
|
|
1912
|
+
* POST https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line
|
|
1913
|
+
* Contract:
|
|
1914
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}~1inv-profile-line/post
|
|
1915
|
+
*
|
|
1916
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1917
|
+
* @param data InvProfileHdrInvProfileLineCreateBody (request body)
|
|
1918
|
+
* @returns BaseResponse whose `data` is InvProfileHdrInvProfileLineCreateData
|
|
1919
|
+
*/
|
|
1920
|
+
create: (invProfileHdrUid: number, data: InvProfileHdrInvProfileLineCreateBody) => Promise<BaseResponse<InvProfileHdrInvProfileLineCreateData>>;
|
|
1921
|
+
/**
|
|
1922
|
+
* Get Inventory Profile line Details
|
|
1923
|
+
* Call: api.vmi.invProfileHdr.invProfileLine.get(invProfileHdrUid, invProfileLineUid)
|
|
1924
|
+
*
|
|
1925
|
+
* Errors:
|
|
1926
|
+
* 404: No inventory profile with this invProfileHdrUid, or no line with this
|
|
1927
|
+
* invProfileLineUid on that profile.
|
|
1928
|
+
*
|
|
1929
|
+
* GET
|
|
1930
|
+
* https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}
|
|
1931
|
+
* Contract:
|
|
1932
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}~1inv-profile-line~1{invProfileLineUid}/get
|
|
1933
|
+
*
|
|
1934
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1935
|
+
* @param invProfileLineUid Inventory profile line ID
|
|
1936
|
+
* @param params InvProfileHdrInvProfileLineGetParams (query string)
|
|
1937
|
+
* @returns BaseResponse whose `data` is InvProfileHdrInvProfileLineGetData
|
|
1938
|
+
*/
|
|
1939
|
+
get: (invProfileHdrUid: number, invProfileLineUid: number, params?: InvProfileHdrInvProfileLineGetParams) => Promise<BaseResponse<InvProfileHdrInvProfileLineGetData>>;
|
|
1940
|
+
/**
|
|
1941
|
+
* Update Inventory Profile Line
|
|
1942
|
+
* Call:
|
|
1943
|
+
* api.vmi.invProfileHdr.invProfileLine.update(invProfileHdrUid, invProfileLineUid, data)
|
|
1944
|
+
*
|
|
1945
|
+
* Update Inventory Profile line
|
|
1946
|
+
*
|
|
1947
|
+
* Request body: Change an inventory profile line; an absent field keeps its current value,
|
|
1948
|
+
* and an invalid code is ignored
|
|
1949
|
+
*
|
|
1950
|
+
* Errors:
|
|
1951
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1952
|
+
* 404: No row exists with this ID.
|
|
1953
|
+
*
|
|
1954
|
+
* PUT
|
|
1955
|
+
* https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}
|
|
1956
|
+
* Contract:
|
|
1957
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}~1inv-profile-line~1{invProfileLineUid}/put
|
|
1958
|
+
*
|
|
1959
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1960
|
+
* @param invProfileLineUid Inventory profile line ID
|
|
1961
|
+
* @param data InvProfileHdrInvProfileLineUpdateBody (request body)
|
|
1962
|
+
* @returns BaseResponse whose `data` is InvProfileHdrInvProfileLineUpdateData
|
|
1963
|
+
*/
|
|
1964
|
+
update: (invProfileHdrUid: number, invProfileLineUid: number, data: InvProfileHdrInvProfileLineUpdateBody) => Promise<BaseResponse<InvProfileHdrInvProfileLineUpdateData>>;
|
|
1965
|
+
/**
|
|
1966
|
+
* DELETE Inventory Profile line
|
|
1967
|
+
* Call: api.vmi.invProfileHdr.invProfileLine.delete(invProfileHdrUid, invProfileLineUid)
|
|
1968
|
+
*
|
|
1969
|
+
* DELETE Inventory Profile Line
|
|
1970
|
+
*
|
|
1971
|
+
* Errors:
|
|
1972
|
+
* 404: No row exists with this ID.
|
|
1973
|
+
*
|
|
1974
|
+
* DELETE
|
|
1975
|
+
* https://vmi.augur-api.com/inv-profile-hdr/{invProfileHdrUid}/inv-profile-line/{invProfileLineUid}
|
|
1976
|
+
* Contract:
|
|
1977
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{invProfileHdrUid}~1inv-profile-line~1{invProfileLineUid}/delete
|
|
1978
|
+
*
|
|
1979
|
+
* @param invProfileHdrUid Inventory profile ID
|
|
1980
|
+
* @param invProfileLineUid Inventory profile line ID
|
|
1981
|
+
* @returns BaseResponse whose `data` is InvProfileHdrInvProfileLineDeleteData
|
|
1982
|
+
*/
|
|
1983
|
+
delete: (invProfileHdrUid: number, invProfileLineUid: number) => Promise<BaseResponse<InvProfileHdrInvProfileLineDeleteData>>;
|
|
1984
|
+
};
|
|
1985
|
+
upload: {
|
|
1986
|
+
/**
|
|
1987
|
+
* Upload Excel file to create inventory profile headers
|
|
1988
|
+
* Call: api.vmi.invProfileHdr.upload.create(customerId, data)
|
|
1989
|
+
*
|
|
1990
|
+
* Request body: Upload an inventory profile spreadsheet for the customer in the path; it is
|
|
1991
|
+
* saved for processing later
|
|
1992
|
+
* Response data: Outcome of an inventory profile spreadsheet upload; the file fields are null
|
|
1993
|
+
* when the upload failed
|
|
1994
|
+
*
|
|
1995
|
+
* Errors:
|
|
1996
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
1997
|
+
* 404: No customer with this customerId.
|
|
1998
|
+
*
|
|
1999
|
+
* POST https://vmi.augur-api.com/inv-profile-hdr/{customerId}/upload
|
|
2000
|
+
* Contract:
|
|
2001
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1inv-profile-hdr~1{customerId}~1upload/post
|
|
2002
|
+
*
|
|
2003
|
+
* @param customerId Prophet 21 customer the uploaded profile spreadsheet is for
|
|
2004
|
+
* @param data InvProfileHdrUploadCreateBody (request body)
|
|
2005
|
+
* @returns BaseResponse whose `data` is InvProfileHdrUploadCreateData
|
|
2006
|
+
*/
|
|
2007
|
+
create: (customerId: number, data: InvProfileHdrUploadCreateBody) => Promise<BaseResponse<InvProfileHdrUploadCreateData>>;
|
|
2008
|
+
};
|
|
2009
|
+
};
|
|
2010
|
+
products: {
|
|
2011
|
+
/**
|
|
2012
|
+
* List Products
|
|
2013
|
+
* Call: api.vmi.products.list(params)
|
|
2014
|
+
*
|
|
2015
|
+
* List products
|
|
2016
|
+
*
|
|
2017
|
+
* Errors:
|
|
2018
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2019
|
+
*
|
|
2020
|
+
* GET https://vmi.augur-api.com/products
|
|
2021
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products/get
|
|
2022
|
+
*
|
|
2023
|
+
* @param params ProductsListParams (query string)
|
|
2024
|
+
* @returns BaseResponse whose `data` is ProductsListData
|
|
2025
|
+
*/
|
|
2026
|
+
list: (params?: ProductsListParams) => Promise<BaseResponse<ProductsListData>>;
|
|
2027
|
+
/**
|
|
2028
|
+
* Get Product Details
|
|
2029
|
+
* Call: api.vmi.products.get(productsUid)
|
|
2030
|
+
*
|
|
2031
|
+
* Errors:
|
|
2032
|
+
* 404: No product with this productsUid.
|
|
2033
|
+
*
|
|
2034
|
+
* GET https://vmi.augur-api.com/products/{productsUid}
|
|
2035
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products~1{productsUid}/get
|
|
2036
|
+
*
|
|
2037
|
+
* @param productsUid Product ID
|
|
2038
|
+
* @param params ProductsGetParams (query string)
|
|
2039
|
+
* @returns BaseResponse whose `data` is ProductsGetData
|
|
2040
|
+
*/
|
|
2041
|
+
get: (productsUid: number, params?: ProductsGetParams) => Promise<BaseResponse<ProductsGetData>>;
|
|
2042
|
+
/**
|
|
2043
|
+
* Update Product
|
|
2044
|
+
* Call: api.vmi.products.update(productsUid, data)
|
|
2045
|
+
*
|
|
2046
|
+
* Request body: Change a distributor product; an absent field keeps its current value
|
|
2047
|
+
*
|
|
2048
|
+
* Errors:
|
|
2049
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2050
|
+
* 404: No row exists with this ID.
|
|
2051
|
+
*
|
|
2052
|
+
* PUT https://vmi.augur-api.com/products/{productsUid}
|
|
2053
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products~1{productsUid}/put
|
|
2054
|
+
*
|
|
2055
|
+
* @param productsUid Product ID
|
|
2056
|
+
* @param data ProductsUpdateBody (request body)
|
|
2057
|
+
* @returns BaseResponse whose `data` is ProductsUpdateData
|
|
2058
|
+
*/
|
|
2059
|
+
update: (productsUid: number, data: ProductsUpdateBody) => Promise<BaseResponse<ProductsUpdateData>>;
|
|
2060
|
+
/**
|
|
2061
|
+
* DELETE Product
|
|
2062
|
+
* Call: api.vmi.products.delete(productsUid)
|
|
2063
|
+
*
|
|
2064
|
+
* Errors:
|
|
2065
|
+
* 404: No row exists with this ID.
|
|
2066
|
+
*
|
|
2067
|
+
* DELETE https://vmi.augur-api.com/products/{productsUid}
|
|
2068
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products~1{productsUid}/delete
|
|
2069
|
+
*
|
|
2070
|
+
* @param productsUid Product ID
|
|
2071
|
+
* @returns BaseResponse whose `data` is ProductsDeleteData
|
|
2072
|
+
*/
|
|
2073
|
+
delete: (productsUid: number) => Promise<BaseResponse<ProductsDeleteData>>;
|
|
2074
|
+
enable: {
|
|
2075
|
+
/**
|
|
2076
|
+
* Enable/Disable/Delete Product
|
|
2077
|
+
* Call: api.vmi.products.enable.update(productsUid, data)
|
|
2078
|
+
*
|
|
2079
|
+
* Request body: Enable, disable, or delete a record; with neither field the record is enabled
|
|
2080
|
+
* Response data: Outcome of an enable, disable, or delete request
|
|
2081
|
+
*
|
|
2082
|
+
* Errors:
|
|
2083
|
+
* 400: productsUid is below 1.
|
|
2084
|
+
* 404: No row exists with this ID.
|
|
2085
|
+
*
|
|
2086
|
+
* PUT https://vmi.augur-api.com/products/{productsUid}/enable
|
|
2087
|
+
* Contract:
|
|
2088
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1products~1{productsUid}~1enable/put
|
|
2089
|
+
*
|
|
2090
|
+
* @param productsUid Product ID
|
|
2091
|
+
* @param data ProductsEnableUpdateBody (request body)
|
|
2092
|
+
* @returns BaseResponse whose `data` is ProductsEnableUpdateData
|
|
2093
|
+
*/
|
|
2094
|
+
update: (productsUid: number, data: ProductsEnableUpdateBody) => Promise<BaseResponse<ProductsEnableUpdateData>>;
|
|
2095
|
+
};
|
|
2096
|
+
find: {
|
|
2097
|
+
/**
|
|
2098
|
+
* Find Products
|
|
2099
|
+
* Call: api.vmi.products.find.list(params)
|
|
2100
|
+
*
|
|
2101
|
+
* Find products and items
|
|
2102
|
+
*
|
|
2103
|
+
* Response data, each item: One product search match, from VMI products or Prophet 21 items
|
|
2104
|
+
*
|
|
2105
|
+
* GET https://vmi.augur-api.com/products/find
|
|
2106
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1products~1find/get
|
|
2107
|
+
*
|
|
2108
|
+
* @param params ProductsFindListParams (query string)
|
|
2109
|
+
* @returns BaseResponse whose `data` is ProductsFindListData
|
|
2110
|
+
*/
|
|
2111
|
+
list: (params?: ProductsFindListParams) => Promise<BaseResponse<ProductsFindListData>>;
|
|
2112
|
+
};
|
|
2113
|
+
};
|
|
2114
|
+
restockHdr: {
|
|
2115
|
+
/**
|
|
2116
|
+
* List Restock Headers
|
|
2117
|
+
* Call: api.vmi.restockHdr.list(params)
|
|
2118
|
+
*
|
|
2119
|
+
* Errors:
|
|
2120
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2121
|
+
*
|
|
2122
|
+
* GET https://vmi.augur-api.com/restock-hdr
|
|
2123
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr/get
|
|
2124
|
+
*
|
|
2125
|
+
* @param params RestockHdrListParams (query string)
|
|
2126
|
+
* @returns BaseResponse whose `data` is RestockHdrListData
|
|
2127
|
+
*/
|
|
2128
|
+
list: (params?: RestockHdrListParams) => Promise<BaseResponse<RestockHdrListData>>;
|
|
2129
|
+
/**
|
|
2130
|
+
* Create Restock Header
|
|
2131
|
+
* Call: api.vmi.restockHdr.create(data)
|
|
2132
|
+
*
|
|
2133
|
+
* Request body: Create a restock request for a warehouse and distributor; a missing required
|
|
2134
|
+
* field creates nothing
|
|
2135
|
+
* Response data: A newly created restock request with its items
|
|
2136
|
+
*
|
|
2137
|
+
* Errors:
|
|
2138
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2139
|
+
*
|
|
2140
|
+
* POST https://vmi.augur-api.com/restock-hdr
|
|
2141
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr/post
|
|
2142
|
+
*
|
|
2143
|
+
* @param data RestockHdrCreateBody (request body)
|
|
2144
|
+
* @returns BaseResponse whose `data` is RestockHdrCreateData
|
|
2145
|
+
*/
|
|
2146
|
+
create: (data: RestockHdrCreateBody) => Promise<BaseResponse<RestockHdrCreateData>>;
|
|
2147
|
+
/**
|
|
2148
|
+
* Get Restock Header Details
|
|
2149
|
+
* Call: api.vmi.restockHdr.get(restockHdrUid)
|
|
2150
|
+
*
|
|
2151
|
+
* Errors:
|
|
2152
|
+
* 404: No restock with this restockHdrUid.
|
|
2153
|
+
*
|
|
2154
|
+
* GET https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
|
|
2155
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr~1{restockHdrUid}/get
|
|
2156
|
+
*
|
|
2157
|
+
* @param restockHdrUid Restock request ID
|
|
2158
|
+
* @param params RestockHdrGetParams (query string)
|
|
2159
|
+
* @returns BaseResponse whose `data` is RestockHdrGetData
|
|
2160
|
+
*/
|
|
2161
|
+
get: (restockHdrUid: number, params?: RestockHdrGetParams) => Promise<BaseResponse<RestockHdrGetData>>;
|
|
2162
|
+
/**
|
|
2163
|
+
* Update Restock Header
|
|
2164
|
+
* Call: api.vmi.restockHdr.update(restockHdrUid, data)
|
|
2165
|
+
*
|
|
2166
|
+
* Request body: Change a restock request's codes or delivery instructions; an absent field
|
|
2167
|
+
* keeps its value, an invalid code is ignored
|
|
2168
|
+
*
|
|
2169
|
+
* Errors:
|
|
2170
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2171
|
+
* 404: No row exists with this ID.
|
|
2172
|
+
*
|
|
2173
|
+
* PUT https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
|
|
2174
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr~1{restockHdrUid}/put
|
|
2175
|
+
*
|
|
2176
|
+
* @param restockHdrUid Restock request ID
|
|
2177
|
+
* @param data RestockHdrUpdateBody (request body)
|
|
2178
|
+
* @returns BaseResponse whose `data` is RestockHdrUpdateData
|
|
2179
|
+
*/
|
|
2180
|
+
update: (restockHdrUid: number, data: RestockHdrUpdateBody) => Promise<BaseResponse<RestockHdrUpdateData>>;
|
|
2181
|
+
/**
|
|
2182
|
+
* DELETE Restock Header
|
|
2183
|
+
* Call: api.vmi.restockHdr.delete(restockHdrUid)
|
|
2184
|
+
*
|
|
2185
|
+
* Errors:
|
|
2186
|
+
* 404: No row exists with this ID.
|
|
2187
|
+
*
|
|
2188
|
+
* DELETE https://vmi.augur-api.com/restock-hdr/{restockHdrUid}
|
|
2189
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1restock-hdr~1{restockHdrUid}/delete
|
|
2190
|
+
*
|
|
2191
|
+
* @param restockHdrUid Restock request ID
|
|
2192
|
+
* @returns BaseResponse whose `data` is RestockHdrDeleteData
|
|
2193
|
+
*/
|
|
2194
|
+
delete: (restockHdrUid: number) => Promise<BaseResponse<RestockHdrDeleteData>>;
|
|
2195
|
+
};
|
|
2196
|
+
sections: {
|
|
2197
|
+
/**
|
|
2198
|
+
* List sections
|
|
2199
|
+
* Call: api.vmi.sections.list(params)
|
|
2200
|
+
*
|
|
2201
|
+
* Errors:
|
|
2202
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2203
|
+
*
|
|
2204
|
+
* GET https://vmi.augur-api.com/sections
|
|
2205
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections/get
|
|
2206
|
+
*
|
|
2207
|
+
* @param params SectionsListParams (query string)
|
|
2208
|
+
* @returns BaseResponse whose `data` is SectionsListData
|
|
2209
|
+
*/
|
|
2210
|
+
list: (params?: SectionsListParams) => Promise<BaseResponse<SectionsListData>>;
|
|
2211
|
+
/**
|
|
2212
|
+
* Create section
|
|
2213
|
+
* Call: api.vmi.sections.create(data)
|
|
2214
|
+
*
|
|
2215
|
+
* Request body: Create a warehouse section for a customer, or return the one whose derived
|
|
2216
|
+
* sections_id already exists
|
|
2217
|
+
*
|
|
2218
|
+
* Errors:
|
|
2219
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2220
|
+
*
|
|
2221
|
+
* POST https://vmi.augur-api.com/sections
|
|
2222
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections/post
|
|
2223
|
+
*
|
|
2224
|
+
* @param data SectionsCreateBody (request body)
|
|
2225
|
+
* @returns BaseResponse whose `data` is SectionsCreateData
|
|
2226
|
+
*/
|
|
2227
|
+
create: (data: SectionsCreateBody) => Promise<BaseResponse<SectionsCreateData>>;
|
|
2228
|
+
/**
|
|
2229
|
+
* Get section Details
|
|
2230
|
+
* Call: api.vmi.sections.get(sectionsUid)
|
|
2231
|
+
*
|
|
2232
|
+
* Errors:
|
|
2233
|
+
* 404: No section with this sectionsUid.
|
|
2234
|
+
*
|
|
2235
|
+
* GET https://vmi.augur-api.com/sections/{sectionsUid}
|
|
2236
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections~1{sectionsUid}/get
|
|
2237
|
+
*
|
|
2238
|
+
* @param sectionsUid Section ID
|
|
2239
|
+
* @param params SectionsGetParams (query string)
|
|
2240
|
+
* @returns BaseResponse whose `data` is SectionsGetData
|
|
2241
|
+
*/
|
|
2242
|
+
get: (sectionsUid: number, params?: SectionsGetParams) => Promise<BaseResponse<SectionsGetData>>;
|
|
2243
|
+
/**
|
|
2244
|
+
* Update section
|
|
2245
|
+
* Call: api.vmi.sections.update(sectionsUid, data)
|
|
2246
|
+
*
|
|
2247
|
+
* Request body: Rename or redescribe a warehouse section; an absent field keeps its current
|
|
2248
|
+
* value
|
|
2249
|
+
*
|
|
2250
|
+
* Errors:
|
|
2251
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2252
|
+
* 404: No row exists with this ID.
|
|
2253
|
+
*
|
|
2254
|
+
* PUT https://vmi.augur-api.com/sections/{sectionsUid}
|
|
2255
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections~1{sectionsUid}/put
|
|
2256
|
+
*
|
|
2257
|
+
* @param sectionsUid Section ID
|
|
2258
|
+
* @param data SectionsUpdateBody (request body)
|
|
2259
|
+
* @returns BaseResponse whose `data` is SectionsUpdateData
|
|
2260
|
+
*/
|
|
2261
|
+
update: (sectionsUid: number, data: SectionsUpdateBody) => Promise<BaseResponse<SectionsUpdateData>>;
|
|
2262
|
+
/**
|
|
2263
|
+
* DELETE section
|
|
2264
|
+
* Call: api.vmi.sections.delete(sectionsUid)
|
|
2265
|
+
*
|
|
2266
|
+
* Errors:
|
|
2267
|
+
* 404: No row exists with this ID.
|
|
2268
|
+
*
|
|
2269
|
+
* DELETE https://vmi.augur-api.com/sections/{sectionsUid}
|
|
2270
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1sections~1{sectionsUid}/delete
|
|
2271
|
+
*
|
|
2272
|
+
* @param sectionsUid Section ID
|
|
2273
|
+
* @returns BaseResponse whose `data` is SectionsDeleteData
|
|
2274
|
+
*/
|
|
2275
|
+
delete: (sectionsUid: number) => Promise<BaseResponse<SectionsDeleteData>>;
|
|
2276
|
+
enable: {
|
|
2277
|
+
/**
|
|
2278
|
+
* Enable/Disable/Delete section
|
|
2279
|
+
* Call: api.vmi.sections.enable.update(sectionsUid, data)
|
|
2280
|
+
*
|
|
2281
|
+
* Request body: Enable, disable, or delete a record; with neither field the record is enabled
|
|
2282
|
+
* Response data: Outcome of an enable, disable, or delete request
|
|
2283
|
+
*
|
|
2284
|
+
* Errors:
|
|
2285
|
+
* 400: sectionsUid is below 1.
|
|
2286
|
+
* 404: No row exists with this ID.
|
|
2287
|
+
*
|
|
2288
|
+
* PUT https://vmi.augur-api.com/sections/{sectionsUid}/enable
|
|
2289
|
+
* Contract:
|
|
2290
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1sections~1{sectionsUid}~1enable/put
|
|
2291
|
+
*
|
|
2292
|
+
* @param sectionsUid Section ID
|
|
2293
|
+
* @param data SectionsEnableUpdateBody (request body)
|
|
2294
|
+
* @returns BaseResponse whose `data` is SectionsEnableUpdateData
|
|
2295
|
+
*/
|
|
2296
|
+
update: (sectionsUid: number, data: SectionsEnableUpdateBody) => Promise<BaseResponse<SectionsEnableUpdateData>>;
|
|
2297
|
+
};
|
|
2298
|
+
};
|
|
2299
|
+
warehouse: {
|
|
2300
|
+
/**
|
|
2301
|
+
* List Warehouses
|
|
2302
|
+
* Call: api.vmi.warehouse.list(params)
|
|
2303
|
+
*
|
|
2304
|
+
* Response data, each item: A warehouse with its active assigned users
|
|
2305
|
+
*
|
|
2306
|
+
* Errors:
|
|
2307
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2308
|
+
*
|
|
2309
|
+
* GET https://vmi.augur-api.com/warehouse
|
|
2310
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse/get
|
|
2311
|
+
*
|
|
2312
|
+
* @param params WarehouseListParams (query string)
|
|
2313
|
+
* @returns BaseResponse whose `data` is WarehouseListData
|
|
2314
|
+
*/
|
|
2315
|
+
list: (params?: WarehouseListParams) => Promise<BaseResponse<WarehouseListData>>;
|
|
2316
|
+
/**
|
|
2317
|
+
* Create Warehouse
|
|
2318
|
+
* Call: api.vmi.warehouse.create(data)
|
|
2319
|
+
*
|
|
2320
|
+
* Request body: Create a warehouse for a customer, or reactivate the one whose derived
|
|
2321
|
+
* warehouse_id already exists
|
|
2322
|
+
*
|
|
2323
|
+
* Errors:
|
|
2324
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2325
|
+
*
|
|
2326
|
+
* POST https://vmi.augur-api.com/warehouse
|
|
2327
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse/post
|
|
2328
|
+
*
|
|
2329
|
+
* @param data WarehouseCreateBody (request body)
|
|
2330
|
+
* @returns BaseResponse whose `data` is WarehouseCreateData
|
|
2331
|
+
*/
|
|
2332
|
+
create: (data: WarehouseCreateBody) => Promise<BaseResponse<WarehouseCreateData>>;
|
|
2333
|
+
/**
|
|
2334
|
+
* Get Warehouse Details
|
|
2335
|
+
* Call: api.vmi.warehouse.get(warehouseUid)
|
|
2336
|
+
*
|
|
2337
|
+
* Response data: A warehouse with its active assigned users
|
|
2338
|
+
*
|
|
2339
|
+
* Errors:
|
|
2340
|
+
* 404: No warehouse with this warehouseUid.
|
|
2341
|
+
*
|
|
2342
|
+
* GET https://vmi.augur-api.com/warehouse/{warehouseUid}
|
|
2343
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}/get
|
|
2344
|
+
*
|
|
2345
|
+
* @param warehouseUid Warehouse ID
|
|
2346
|
+
* @param params WarehouseGetParams (query string)
|
|
2347
|
+
* @returns BaseResponse whose `data` is WarehouseGetData
|
|
2348
|
+
*/
|
|
2349
|
+
get: (warehouseUid: number, params?: WarehouseGetParams) => Promise<BaseResponse<WarehouseGetData>>;
|
|
2350
|
+
/**
|
|
2351
|
+
* Update Warehouse
|
|
2352
|
+
* Call: api.vmi.warehouse.update(warehouseUid, data)
|
|
2353
|
+
*
|
|
2354
|
+
* Request body: Change a warehouse; an absent field keeps its current value
|
|
2355
|
+
*
|
|
2356
|
+
* Errors:
|
|
2357
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2358
|
+
* 404: No row exists with this ID.
|
|
2359
|
+
*
|
|
2360
|
+
* PUT https://vmi.augur-api.com/warehouse/{warehouseUid}
|
|
2361
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}/put
|
|
2362
|
+
*
|
|
2363
|
+
* @param warehouseUid Warehouse ID
|
|
2364
|
+
* @param data WarehouseUpdateBody (request body)
|
|
2365
|
+
* @returns BaseResponse whose `data` is WarehouseUpdateData
|
|
2366
|
+
*/
|
|
2367
|
+
update: (warehouseUid: number, data: WarehouseUpdateBody) => Promise<BaseResponse<WarehouseUpdateData>>;
|
|
2368
|
+
/**
|
|
2369
|
+
* DELETE Warehouse
|
|
2370
|
+
* Call: api.vmi.warehouse.delete(warehouseUid)
|
|
2371
|
+
*
|
|
2372
|
+
* Errors:
|
|
2373
|
+
* 404: No row exists with this ID.
|
|
2374
|
+
*
|
|
2375
|
+
* DELETE https://vmi.augur-api.com/warehouse/{warehouseUid}
|
|
2376
|
+
* Contract: https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}/delete
|
|
2377
|
+
*
|
|
2378
|
+
* @param warehouseUid Warehouse ID
|
|
2379
|
+
* @returns BaseResponse whose `data` is WarehouseDeleteData
|
|
2380
|
+
*/
|
|
2381
|
+
delete: (warehouseUid: number) => Promise<BaseResponse<WarehouseDeleteData>>;
|
|
2382
|
+
adjust: {
|
|
2383
|
+
/**
|
|
2384
|
+
* Adjust Inventory
|
|
2385
|
+
* Call: api.vmi.warehouse.adjust.create(warehouseUid, data)
|
|
2386
|
+
*
|
|
2387
|
+
* Request body: Set the on-hand count of items in the warehouse from the path
|
|
2388
|
+
* Response data, each item: One item whose on-hand count was set
|
|
2389
|
+
*
|
|
2390
|
+
* Errors:
|
|
2391
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2392
|
+
* 404: No warehouse with this warehouseUid.
|
|
2393
|
+
*
|
|
2394
|
+
* POST https://vmi.augur-api.com/warehouse/{warehouseUid}/adjust
|
|
2395
|
+
* Contract:
|
|
2396
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1adjust/post
|
|
2397
|
+
*
|
|
2398
|
+
* @param warehouseUid Warehouse ID
|
|
2399
|
+
* @param data WarehouseAdjustCreateBody (request body)
|
|
2400
|
+
* @returns BaseResponse whose `data` is WarehouseAdjustCreateData
|
|
2401
|
+
*/
|
|
2402
|
+
create: (warehouseUid: number, data: WarehouseAdjustCreateBody) => Promise<BaseResponse<WarehouseAdjustCreateData>>;
|
|
2403
|
+
};
|
|
2404
|
+
availability: {
|
|
2405
|
+
/**
|
|
2406
|
+
* List inventory availability
|
|
2407
|
+
* Call: api.vmi.warehouse.availability.list(warehouseUid, params)
|
|
2408
|
+
*
|
|
2409
|
+
* Response data: On-hand quantities of a warehouse's profile items, grouped by section
|
|
2410
|
+
*
|
|
2411
|
+
* Errors:
|
|
2412
|
+
* 400: warehouseUid is below 1.
|
|
2413
|
+
* 404: No warehouse with this warehouseUid.
|
|
2414
|
+
*
|
|
2415
|
+
* GET https://vmi.augur-api.com/warehouse/{warehouseUid}/availability
|
|
2416
|
+
* Contract:
|
|
2417
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1availability/get
|
|
2418
|
+
*
|
|
2419
|
+
* @param warehouseUid Warehouse ID
|
|
2420
|
+
* @param params WarehouseAvailabilityListParams (query string)
|
|
2421
|
+
* @returns BaseResponse whose `data` is WarehouseAvailabilityListData
|
|
2422
|
+
*/
|
|
2423
|
+
list: (warehouseUid: number, params?: WarehouseAvailabilityListParams) => Promise<BaseResponse<WarehouseAvailabilityListData>>;
|
|
2424
|
+
};
|
|
2425
|
+
enable: {
|
|
2426
|
+
/**
|
|
2427
|
+
* Enable/Disable/Delete Warehouse
|
|
2428
|
+
* Call: api.vmi.warehouse.enable.update(warehouseUid, data)
|
|
2429
|
+
*
|
|
2430
|
+
* Request body: Enable, disable, or delete a record; with neither field the record is enabled
|
|
2431
|
+
* Response data: Outcome of an enable, disable, or delete request
|
|
2432
|
+
*
|
|
2433
|
+
* Errors:
|
|
2434
|
+
* 400: warehouseUid is below 1.
|
|
2435
|
+
* 404: No row exists with this ID.
|
|
2436
|
+
*
|
|
2437
|
+
* PUT https://vmi.augur-api.com/warehouse/{warehouseUid}/enable
|
|
2438
|
+
* Contract:
|
|
2439
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1enable/put
|
|
2440
|
+
*
|
|
2441
|
+
* @param warehouseUid Warehouse ID
|
|
2442
|
+
* @param data WarehouseEnableUpdateBody (request body)
|
|
2443
|
+
* @returns BaseResponse whose `data` is WarehouseEnableUpdateData
|
|
2444
|
+
*/
|
|
2445
|
+
update: (warehouseUid: number, data: WarehouseEnableUpdateBody) => Promise<BaseResponse<WarehouseEnableUpdateData>>;
|
|
2446
|
+
};
|
|
2447
|
+
receive: {
|
|
2448
|
+
/**
|
|
2449
|
+
* Receive Inventory
|
|
2450
|
+
* Call: api.vmi.warehouse.receive.create(warehouseUid, data)
|
|
2451
|
+
*
|
|
2452
|
+
* Request body: Receive items into the warehouse from the path
|
|
2453
|
+
* Response data, each item: One item received into a warehouse
|
|
2454
|
+
*
|
|
2455
|
+
* Errors:
|
|
2456
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2457
|
+
* 404: No warehouse with this warehouseUid.
|
|
2458
|
+
*
|
|
2459
|
+
* POST https://vmi.augur-api.com/warehouse/{warehouseUid}/receive
|
|
2460
|
+
* Contract:
|
|
2461
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1receive/post
|
|
2462
|
+
*
|
|
2463
|
+
* @param warehouseUid Warehouse ID
|
|
2464
|
+
* @param data WarehouseReceiveCreateBody (request body)
|
|
2465
|
+
* @returns BaseResponse whose `data` is WarehouseReceiveCreateData
|
|
2466
|
+
*/
|
|
2467
|
+
create: (warehouseUid: number, data: WarehouseReceiveCreateBody) => Promise<BaseResponse<WarehouseReceiveCreateData>>;
|
|
2468
|
+
};
|
|
2469
|
+
replenish: {
|
|
2470
|
+
/**
|
|
2471
|
+
* Get Replenish Information
|
|
2472
|
+
* Call: api.vmi.warehouse.replenish.list(warehouseUid, params)
|
|
2473
|
+
*
|
|
2474
|
+
* Response data: A warehouse's profile items with stock levels, for building a restock
|
|
2475
|
+
* request
|
|
2476
|
+
*
|
|
2477
|
+
* Errors:
|
|
2478
|
+
* 400: warehouseUid is below 1.
|
|
2479
|
+
* 404: No warehouse with this warehouseUid.
|
|
2480
|
+
*
|
|
2481
|
+
* GET https://vmi.augur-api.com/warehouse/{warehouseUid}/replenish
|
|
2482
|
+
* Contract:
|
|
2483
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1replenish/get
|
|
2484
|
+
*
|
|
2485
|
+
* @param warehouseUid Warehouse ID
|
|
2486
|
+
* @param params WarehouseReplenishListParams (query string)
|
|
2487
|
+
* @returns BaseResponse whose `data` is WarehouseReplenishListData
|
|
2488
|
+
*/
|
|
2489
|
+
list: (warehouseUid: number, params?: WarehouseReplenishListParams) => Promise<BaseResponse<WarehouseReplenishListData>>;
|
|
2490
|
+
};
|
|
2491
|
+
usage: {
|
|
2492
|
+
/**
|
|
2493
|
+
* Use Inventory
|
|
2494
|
+
* Call: api.vmi.warehouse.usage.create(warehouseUid, data)
|
|
2495
|
+
*
|
|
2496
|
+
* Request body: Record items used from the warehouse in the path
|
|
2497
|
+
* Response data: A recorded warehouse usage with its lines
|
|
2498
|
+
*
|
|
2499
|
+
* Errors:
|
|
2500
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2501
|
+
* 404: No warehouse with this warehouseUid.
|
|
2502
|
+
*
|
|
2503
|
+
* POST https://vmi.augur-api.com/warehouse/{warehouseUid}/usage
|
|
2504
|
+
* Contract:
|
|
2505
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1usage/post
|
|
2506
|
+
*
|
|
2507
|
+
* @param warehouseUid Warehouse ID
|
|
2508
|
+
* @param data WarehouseUsageCreateBody (request body)
|
|
2509
|
+
* @returns BaseResponse whose `data` is WarehouseUsageCreateData
|
|
2510
|
+
*/
|
|
2511
|
+
create: (warehouseUid: number, data: WarehouseUsageCreateBody) => Promise<BaseResponse<WarehouseUsageCreateData>>;
|
|
2512
|
+
};
|
|
2513
|
+
users: {
|
|
2514
|
+
/**
|
|
2515
|
+
* List Warehouses Users
|
|
2516
|
+
* Call: api.vmi.warehouse.users.list(warehouseUid, params)
|
|
2517
|
+
*
|
|
2518
|
+
* Response data, each item: A user assigned to a warehouse, with the user's Joomla name and
|
|
2519
|
+
* Prophet 21 ids
|
|
2520
|
+
*
|
|
2521
|
+
* Errors:
|
|
2522
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2523
|
+
* 404: No warehouse with this warehouseUid.
|
|
2524
|
+
*
|
|
2525
|
+
* GET https://vmi.augur-api.com/warehouse/{warehouseUid}/users
|
|
2526
|
+
* Contract:
|
|
2527
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1users/get
|
|
2528
|
+
*
|
|
2529
|
+
* @param warehouseUid Warehouse ID
|
|
2530
|
+
* @param params WarehouseUsersListParams (query string)
|
|
2531
|
+
* @returns BaseResponse whose `data` is WarehouseUsersListData
|
|
2532
|
+
*/
|
|
2533
|
+
list: (warehouseUid: number, params?: WarehouseUsersListParams) => Promise<BaseResponse<WarehouseUsersListData>>;
|
|
2534
|
+
/**
|
|
2535
|
+
* Create/update Warehouse User
|
|
2536
|
+
* Call: api.vmi.warehouse.users.create(warehouseUid, data, params)
|
|
2537
|
+
*
|
|
2538
|
+
* Create/Update Warehouse User
|
|
2539
|
+
*
|
|
2540
|
+
* Request body: Assign a user to a warehouse, which comes from the path; an existing
|
|
2541
|
+
* assignment is kept
|
|
2542
|
+
*
|
|
2543
|
+
* Errors:
|
|
2544
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2545
|
+
* 404: No warehouse with this warehouseUid.
|
|
2546
|
+
*
|
|
2547
|
+
* POST https://vmi.augur-api.com/warehouse/{warehouseUid}/users
|
|
2548
|
+
* Contract:
|
|
2549
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1users/post
|
|
2550
|
+
*
|
|
2551
|
+
* @param warehouseUid Warehouse ID
|
|
2552
|
+
* @param data WarehouseUsersCreateBody (request body)
|
|
2553
|
+
* @param params WarehouseUsersCreateParams (query string)
|
|
2554
|
+
* @returns BaseResponse whose `data` is WarehouseUsersCreateData
|
|
2555
|
+
*/
|
|
2556
|
+
create: (warehouseUid: number, data: WarehouseUsersCreateBody, params?: WarehouseUsersCreateParams) => Promise<BaseResponse<WarehouseUsersCreateData>>;
|
|
2557
|
+
/**
|
|
2558
|
+
* Get Warehouse User Assignment
|
|
2559
|
+
* Call: api.vmi.warehouse.users.get(warehouseUid, usersId)
|
|
2560
|
+
*
|
|
2561
|
+
* Response data: A user assigned to a warehouse, with the user's Joomla name and Prophet 21
|
|
2562
|
+
* ids
|
|
2563
|
+
*
|
|
2564
|
+
* Errors:
|
|
2565
|
+
* 404: No row exists with this ID.
|
|
2566
|
+
*
|
|
2567
|
+
* GET https://vmi.augur-api.com/warehouse/{warehouseUid}/users/{usersId}
|
|
2568
|
+
* Contract:
|
|
2569
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1users~1{usersId}/get
|
|
2570
|
+
*
|
|
2571
|
+
* @param warehouseUid Warehouse ID
|
|
2572
|
+
* @param usersId User ID from joomla.users
|
|
2573
|
+
* @param params WarehouseUsersGetParams (query string)
|
|
2574
|
+
* @returns BaseResponse whose `data` is WarehouseUsersGetData
|
|
2575
|
+
*/
|
|
2576
|
+
get: (warehouseUid: number, usersId: number, params?: WarehouseUsersGetParams) => Promise<BaseResponse<WarehouseUsersGetData>>;
|
|
2577
|
+
/**
|
|
2578
|
+
* Update Warehouse User Assignment
|
|
2579
|
+
* Call: api.vmi.warehouse.users.update(warehouseUid, usersId, data)
|
|
2580
|
+
*
|
|
2581
|
+
* Request body: Change a warehouse user assignment's codes; an absent field keeps its value,
|
|
2582
|
+
* an invalid code is ignored
|
|
2583
|
+
*
|
|
2584
|
+
* Errors:
|
|
2585
|
+
* 400: Bad request: the body is missing or a parameter is invalid; message says which.
|
|
2586
|
+
* 404: No row exists with this ID.
|
|
2587
|
+
*
|
|
2588
|
+
* PUT https://vmi.augur-api.com/warehouse/{warehouseUid}/users/{usersId}
|
|
2589
|
+
* Contract:
|
|
2590
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1users~1{usersId}/put
|
|
2591
|
+
*
|
|
2592
|
+
* @param warehouseUid Warehouse ID
|
|
2593
|
+
* @param usersId User ID from joomla.users
|
|
2594
|
+
* @param data WarehouseUsersUpdateBody (request body)
|
|
2595
|
+
* @returns BaseResponse whose `data` is WarehouseUsersUpdateData
|
|
2596
|
+
*/
|
|
2597
|
+
update: (warehouseUid: number, usersId: number, data: WarehouseUsersUpdateBody) => Promise<BaseResponse<WarehouseUsersUpdateData>>;
|
|
2598
|
+
/**
|
|
2599
|
+
* Remove User from Warehouse
|
|
2600
|
+
* Call: api.vmi.warehouse.users.delete(warehouseUid, usersId)
|
|
2601
|
+
*
|
|
2602
|
+
* Remove User from Warehouse (sets status_cd to 700)
|
|
2603
|
+
*
|
|
2604
|
+
* Errors:
|
|
2605
|
+
* 400: warehouseUid or usersId is below 1.
|
|
2606
|
+
* 404: No row exists with this ID.
|
|
2607
|
+
*
|
|
2608
|
+
* DELETE https://vmi.augur-api.com/warehouse/{warehouseUid}/users/{usersId}
|
|
2609
|
+
* Contract:
|
|
2610
|
+
* https://vmi.augur-api.com/openapi.json#/paths/~1warehouse~1{warehouseUid}~1users~1{usersId}/delete
|
|
2611
|
+
*
|
|
2612
|
+
* @param warehouseUid Warehouse ID
|
|
2613
|
+
* @param usersId User ID from joomla.users
|
|
2614
|
+
* @returns BaseResponse whose `data` is WarehouseUsersDeleteData
|
|
2615
|
+
*/
|
|
2616
|
+
delete: (warehouseUid: number, usersId: number) => Promise<BaseResponse<WarehouseUsersDeleteData>>;
|
|
2617
|
+
};
|
|
2618
|
+
};
|
|
2619
|
+
}
|
|
2620
|
+
//# sourceMappingURL=types.d.ts.map
|