@gradientedge/commercetools-utils 5.27.2 → 5.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/cjs/api/types.d.ts +0 -1
- package/dist/cjs/api/types.d.ts.map +1 -1
- package/dist/cjs/auth/scopes.js +2 -3
- package/dist/cjs/auth/scopes.js.map +1 -1
- package/dist/cjs/auth/types.d.ts +0 -1
- package/dist/cjs/auth/types.d.ts.map +1 -1
- package/dist/cjs/auth/utils.js +1 -2
- package/dist/cjs/auth/utils.js.map +1 -1
- package/dist/cjs/error/CommercetoolsError.d.ts.map +1 -1
- package/dist/cjs/error/CommercetoolsError.js +2 -0
- package/dist/cjs/error/CommercetoolsError.js.map +1 -1
- package/dist/cjs/request/is-retryable-error.js +1 -2
- package/dist/cjs/request/is-retryable-error.js.map +1 -1
- package/dist/cjs/request/request-executor.d.ts +0 -1
- package/dist/cjs/request/request-executor.d.ts.map +1 -1
- package/dist/cjs/request/request-executor.js +1 -2
- package/dist/cjs/request/request-executor.js.map +1 -1
- package/dist/cjs/request/request.js +1 -2
- package/dist/cjs/request/request.js.map +1 -1
- package/dist/cjs/request/transform-error.js +1 -2
- package/dist/cjs/request/transform-error.js.map +1 -1
- package/dist/cjs/tsconfig-cjs.tsbuildinfo +1 -0
- package/dist/cjs/types/models/approval-flow.d.ts +264 -0
- package/dist/cjs/types/models/approval-flow.d.ts.map +1 -0
- package/dist/cjs/types/models/approval-flow.js +8 -0
- package/dist/cjs/types/models/approval-flow.js.map +1 -0
- package/dist/cjs/types/models/approval-rule.d.ts +415 -0
- package/dist/cjs/types/models/approval-rule.d.ts.map +1 -0
- package/dist/cjs/types/models/approval-rule.js +8 -0
- package/dist/cjs/types/models/approval-rule.js.map +1 -0
- package/dist/cjs/types/models/associate-role.d.ts +319 -0
- package/dist/cjs/types/models/associate-role.d.ts.map +1 -0
- package/dist/cjs/types/models/associate-role.js +8 -0
- package/dist/cjs/types/models/associate-role.js.map +1 -0
- package/dist/cjs/types/models/attribute-group.d.ts +254 -0
- package/dist/cjs/types/models/attribute-group.d.ts.map +1 -0
- package/dist/cjs/types/models/attribute-group.js +8 -0
- package/dist/cjs/types/models/attribute-group.js.map +1 -0
- package/dist/cjs/types/models/business-unit.d.ts +1244 -0
- package/dist/cjs/types/models/business-unit.d.ts.map +1 -0
- package/dist/cjs/types/models/business-unit.js +8 -0
- package/dist/cjs/types/models/business-unit.js.map +1 -0
- package/dist/cjs/types/models/cart-discount.d.ts +848 -0
- package/dist/cjs/types/models/cart-discount.d.ts.map +1 -0
- package/dist/cjs/types/models/cart-discount.js +8 -0
- package/dist/cjs/types/models/cart-discount.js.map +1 -0
- package/dist/cjs/types/models/cart.d.ts +3593 -0
- package/dist/cjs/types/models/cart.d.ts.map +1 -0
- package/dist/cjs/types/models/cart.js +8 -0
- package/dist/cjs/types/models/cart.js.map +1 -0
- package/dist/cjs/types/models/category.d.ts +636 -0
- package/dist/cjs/types/models/category.d.ts.map +1 -0
- package/dist/cjs/types/models/category.js +8 -0
- package/dist/cjs/types/models/category.js.map +1 -0
- package/dist/cjs/types/models/channel.d.ts +380 -0
- package/dist/cjs/types/models/channel.d.ts.map +1 -0
- package/dist/cjs/types/models/channel.js +8 -0
- package/dist/cjs/types/models/channel.js.map +1 -0
- package/dist/cjs/types/models/common.d.ts +1163 -0
- package/dist/cjs/types/models/common.d.ts.map +1 -0
- package/dist/cjs/types/models/common.js +8 -0
- package/dist/cjs/types/models/common.js.map +1 -0
- package/dist/cjs/types/models/custom-object.d.ts +152 -0
- package/dist/cjs/types/models/custom-object.d.ts.map +1 -0
- package/dist/cjs/types/models/custom-object.js +8 -0
- package/dist/cjs/types/models/custom-object.js.map +1 -0
- package/dist/cjs/types/models/customer-group.d.ts +235 -0
- package/dist/cjs/types/models/customer-group.d.ts.map +1 -0
- package/dist/cjs/types/models/customer-group.js +8 -0
- package/dist/cjs/types/models/customer-group.js.map +1 -0
- package/dist/cjs/types/models/customer-search.d.ts +114 -0
- package/dist/cjs/types/models/customer-search.d.ts.map +1 -0
- package/dist/cjs/types/models/customer-search.js +8 -0
- package/dist/cjs/types/models/customer-search.js.map +1 -0
- package/dist/cjs/types/models/customer.d.ts +1270 -0
- package/dist/cjs/types/models/customer.d.ts.map +1 -0
- package/dist/cjs/types/models/customer.js +8 -0
- package/dist/cjs/types/models/customer.js.map +1 -0
- package/dist/cjs/types/models/discount-code.d.ts +473 -0
- package/dist/cjs/types/models/discount-code.d.ts.map +1 -0
- package/dist/cjs/types/models/discount-code.js +8 -0
- package/dist/cjs/types/models/discount-code.js.map +1 -0
- package/dist/cjs/types/models/error.d.ts +3330 -0
- package/dist/cjs/types/models/error.d.ts.map +1 -0
- package/dist/cjs/types/models/error.js +8 -0
- package/dist/cjs/types/models/error.js.map +1 -0
- package/dist/cjs/types/models/extension.d.ts +336 -0
- package/dist/cjs/types/models/extension.d.ts.map +1 -0
- package/dist/cjs/types/models/extension.js +8 -0
- package/dist/cjs/types/models/extension.js.map +1 -0
- package/dist/cjs/types/models/index.d.ts +48 -0
- package/dist/cjs/types/models/index.d.ts.map +1 -0
- package/dist/cjs/types/models/index.js +64 -0
- package/dist/cjs/types/models/index.js.map +1 -0
- package/dist/cjs/types/models/inventory.d.ts +330 -0
- package/dist/cjs/types/models/inventory.d.ts.map +1 -0
- package/dist/cjs/types/models/inventory.js +8 -0
- package/dist/cjs/types/models/inventory.js.map +1 -0
- package/dist/cjs/types/models/me.d.ts +2636 -0
- package/dist/cjs/types/models/me.d.ts.map +1 -0
- package/dist/cjs/types/models/me.js +8 -0
- package/dist/cjs/types/models/me.js.map +1 -0
- package/dist/cjs/types/models/message.d.ts +23707 -0
- package/dist/cjs/types/models/message.d.ts.map +1 -0
- package/dist/cjs/types/models/message.js +8 -0
- package/dist/cjs/types/models/message.js.map +1 -0
- package/dist/cjs/types/models/order-edit.d.ts +2725 -0
- package/dist/cjs/types/models/order-edit.d.ts.map +1 -0
- package/dist/cjs/types/models/order-edit.js +8 -0
- package/dist/cjs/types/models/order-edit.js.map +1 -0
- package/dist/cjs/types/models/order.d.ts +3187 -0
- package/dist/cjs/types/models/order.d.ts.map +1 -0
- package/dist/cjs/types/models/order.js +8 -0
- package/dist/cjs/types/models/order.js.map +1 -0
- package/dist/cjs/types/models/payment.d.ts +680 -0
- package/dist/cjs/types/models/payment.d.ts.map +1 -0
- package/dist/cjs/types/models/payment.js +8 -0
- package/dist/cjs/types/models/payment.js.map +1 -0
- package/dist/cjs/types/models/product-discount.d.ts +465 -0
- package/dist/cjs/types/models/product-discount.d.ts.map +1 -0
- package/dist/cjs/types/models/product-discount.js +8 -0
- package/dist/cjs/types/models/product-discount.js.map +1 -0
- package/dist/cjs/types/models/product-search.d.ts +437 -0
- package/dist/cjs/types/models/product-search.d.ts.map +1 -0
- package/dist/cjs/types/models/product-search.js +8 -0
- package/dist/cjs/types/models/product-search.js.map +1 -0
- package/dist/cjs/types/models/product-selection.d.ts +579 -0
- package/dist/cjs/types/models/product-selection.d.ts.map +1 -0
- package/dist/cjs/types/models/product-selection.js +8 -0
- package/dist/cjs/types/models/product-selection.js.map +1 -0
- package/dist/cjs/types/models/product-tailoring.d.ts +1368 -0
- package/dist/cjs/types/models/product-tailoring.d.ts.map +1 -0
- package/dist/cjs/types/models/product-tailoring.js +8 -0
- package/dist/cjs/types/models/product-tailoring.js.map +1 -0
- package/dist/cjs/types/models/product-type.d.ts +775 -0
- package/dist/cjs/types/models/product-type.d.ts.map +1 -0
- package/dist/cjs/types/models/product-type.js +8 -0
- package/dist/cjs/types/models/product-type.js.map +1 -0
- package/dist/cjs/types/models/product.d.ts +2314 -0
- package/dist/cjs/types/models/product.d.ts.map +1 -0
- package/dist/cjs/types/models/product.js +8 -0
- package/dist/cjs/types/models/product.js.map +1 -0
- package/dist/cjs/types/models/project.d.ts +418 -0
- package/dist/cjs/types/models/project.d.ts.map +1 -0
- package/dist/cjs/types/models/project.js +8 -0
- package/dist/cjs/types/models/project.js.map +1 -0
- package/dist/cjs/types/models/quote-request.d.ts +452 -0
- package/dist/cjs/types/models/quote-request.d.ts.map +1 -0
- package/dist/cjs/types/models/quote-request.js +8 -0
- package/dist/cjs/types/models/quote-request.js.map +1 -0
- package/dist/cjs/types/models/quote.d.ts +473 -0
- package/dist/cjs/types/models/quote.d.ts.map +1 -0
- package/dist/cjs/types/models/quote.js +8 -0
- package/dist/cjs/types/models/quote.js.map +1 -0
- package/dist/cjs/types/models/review.d.ts +435 -0
- package/dist/cjs/types/models/review.d.ts.map +1 -0
- package/dist/cjs/types/models/review.js +8 -0
- package/dist/cjs/types/models/review.js.map +1 -0
- package/dist/cjs/types/models/scalar-types.d.ts +10 -0
- package/dist/cjs/types/models/scalar-types.d.ts.map +1 -0
- package/dist/cjs/types/models/scalar-types.js +8 -0
- package/dist/cjs/types/models/scalar-types.js.map +1 -0
- package/dist/cjs/types/models/search.d.ts +334 -0
- package/dist/cjs/types/models/search.d.ts.map +1 -0
- package/dist/cjs/types/models/search.js +8 -0
- package/dist/cjs/types/models/search.js.map +1 -0
- package/dist/cjs/types/models/shipping-method.d.ts +595 -0
- package/dist/cjs/types/models/shipping-method.d.ts.map +1 -0
- package/dist/cjs/types/models/shipping-method.js +8 -0
- package/dist/cjs/types/models/shipping-method.js.map +1 -0
- package/dist/cjs/types/models/shopping-list.d.ts +941 -0
- package/dist/cjs/types/models/shopping-list.d.ts.map +1 -0
- package/dist/cjs/types/models/shopping-list.js +8 -0
- package/dist/cjs/types/models/shopping-list.js.map +1 -0
- package/dist/cjs/types/models/staged-quote.d.ts +345 -0
- package/dist/cjs/types/models/staged-quote.d.ts.map +1 -0
- package/dist/cjs/types/models/staged-quote.js +8 -0
- package/dist/cjs/types/models/staged-quote.js.map +1 -0
- package/dist/cjs/types/models/standalone-price.d.ts +546 -0
- package/dist/cjs/types/models/standalone-price.d.ts.map +1 -0
- package/dist/cjs/types/models/standalone-price.js +8 -0
- package/dist/cjs/types/models/standalone-price.js.map +1 -0
- package/dist/cjs/types/models/state.d.ts +342 -0
- package/dist/cjs/types/models/state.d.ts.map +1 -0
- package/dist/cjs/types/models/state.js +8 -0
- package/dist/cjs/types/models/state.js.map +1 -0
- package/dist/cjs/types/models/store-country.d.ts +14 -0
- package/dist/cjs/types/models/store-country.d.ts.map +1 -0
- package/dist/cjs/types/models/store-country.js +8 -0
- package/dist/cjs/types/models/store-country.js.map +1 -0
- package/dist/cjs/types/models/store.d.ts +548 -0
- package/dist/cjs/types/models/store.d.ts.map +1 -0
- package/dist/cjs/types/models/store.js +8 -0
- package/dist/cjs/types/models/store.js.map +1 -0
- package/dist/cjs/types/models/subscription.d.ts +772 -0
- package/dist/cjs/types/models/subscription.d.ts.map +1 -0
- package/dist/cjs/types/models/subscription.js +8 -0
- package/dist/cjs/types/models/subscription.js.map +1 -0
- package/dist/cjs/types/models/tax-category.d.ts +379 -0
- package/dist/cjs/types/models/tax-category.d.ts.map +1 -0
- package/dist/cjs/types/models/tax-category.js +8 -0
- package/dist/cjs/types/models/tax-category.js.map +1 -0
- package/dist/cjs/types/models/type.d.ts +646 -0
- package/dist/cjs/types/models/type.d.ts.map +1 -0
- package/dist/cjs/types/models/type.js +8 -0
- package/dist/cjs/types/models/type.js.map +1 -0
- package/dist/cjs/types/models/warning.d.ts +24 -0
- package/dist/cjs/types/models/warning.d.ts.map +1 -0
- package/dist/cjs/types/models/warning.js +8 -0
- package/dist/cjs/types/models/warning.js.map +1 -0
- package/dist/cjs/types/models/zone.d.ts +235 -0
- package/dist/cjs/types/models/zone.d.ts.map +1 -0
- package/dist/cjs/types/models/zone.js +8 -0
- package/dist/cjs/types/models/zone.js.map +1 -0
- package/dist/cjs/types.d.ts +1 -1
- package/dist/cjs/types.d.ts.map +1 -1
- package/dist/cjs/types.js +15 -0
- package/dist/cjs/types.js.map +1 -1
- package/dist/cjs/utils/axios/convert-error.js +1 -2
- package/dist/cjs/utils/axios/convert-error.js.map +1 -1
- package/dist/cjs/utils/axios/convert-response.js +1 -2
- package/dist/cjs/utils/axios/convert-response.js.map +1 -1
- package/dist/cjs/utils/axios/create-instance.d.ts +0 -1
- package/dist/cjs/utils/axios/create-instance.d.ts.map +1 -1
- package/dist/cjs/utils/axios/create-instance.js +3 -2
- package/dist/cjs/utils/axios/create-instance.js.map +1 -1
- package/dist/cjs/utils/axios/extract-headers.js +1 -2
- package/dist/cjs/utils/axios/extract-headers.js.map +1 -1
- package/dist/cjs/utils/calculate-delay.js +1 -2
- package/dist/cjs/utils/calculate-delay.js.map +1 -1
- package/dist/cjs/utils/ensure-non-empty-string.js +1 -2
- package/dist/cjs/utils/ensure-non-empty-string.js.map +1 -1
- package/dist/cjs/utils/format.js +1 -2
- package/dist/cjs/utils/format.js.map +1 -1
- package/dist/cjs/utils/get-attribute-value.js +1 -2
- package/dist/cjs/utils/get-attribute-value.js.map +1 -1
- package/dist/cjs/utils/mask.js +4 -4
- package/dist/cjs/utils/mask.js.map +1 -1
- package/dist/cjs/utils/plain-clone.js +1 -2
- package/dist/cjs/utils/plain-clone.js.map +1 -1
- package/dist/cjs/utils/retry-on-conflict.js +1 -2
- package/dist/cjs/utils/retry-on-conflict.js.map +1 -1
- package/dist/cjs/utils/useragent.js +1 -2
- package/dist/cjs/utils/useragent.js.map +1 -1
- package/dist/mjs/api/types.d.ts +0 -1
- package/dist/mjs/api/types.d.ts.map +1 -1
- package/dist/mjs/auth/types.d.ts +0 -1
- package/dist/mjs/auth/types.d.ts.map +1 -1
- package/dist/mjs/error/CommercetoolsError.d.ts.map +1 -1
- package/dist/mjs/error/CommercetoolsError.js +2 -0
- package/dist/mjs/error/CommercetoolsError.js.map +1 -1
- package/dist/mjs/request/request-executor.d.ts +0 -1
- package/dist/mjs/request/request-executor.d.ts.map +1 -1
- package/dist/mjs/tsconfig.tsbuildinfo +1 -0
- package/dist/mjs/types/models/approval-flow.d.ts +264 -0
- package/dist/mjs/types/models/approval-flow.d.ts.map +1 -0
- package/dist/mjs/types/models/approval-flow.js +7 -0
- package/dist/mjs/types/models/approval-flow.js.map +1 -0
- package/dist/mjs/types/models/approval-rule.d.ts +415 -0
- package/dist/mjs/types/models/approval-rule.d.ts.map +1 -0
- package/dist/mjs/types/models/approval-rule.js +7 -0
- package/dist/mjs/types/models/approval-rule.js.map +1 -0
- package/dist/mjs/types/models/associate-role.d.ts +319 -0
- package/dist/mjs/types/models/associate-role.d.ts.map +1 -0
- package/dist/mjs/types/models/associate-role.js +7 -0
- package/dist/mjs/types/models/associate-role.js.map +1 -0
- package/dist/mjs/types/models/attribute-group.d.ts +254 -0
- package/dist/mjs/types/models/attribute-group.d.ts.map +1 -0
- package/dist/mjs/types/models/attribute-group.js +7 -0
- package/dist/mjs/types/models/attribute-group.js.map +1 -0
- package/dist/mjs/types/models/business-unit.d.ts +1244 -0
- package/dist/mjs/types/models/business-unit.d.ts.map +1 -0
- package/dist/mjs/types/models/business-unit.js +7 -0
- package/dist/mjs/types/models/business-unit.js.map +1 -0
- package/dist/mjs/types/models/cart-discount.d.ts +848 -0
- package/dist/mjs/types/models/cart-discount.d.ts.map +1 -0
- package/dist/mjs/types/models/cart-discount.js +7 -0
- package/dist/mjs/types/models/cart-discount.js.map +1 -0
- package/dist/mjs/types/models/cart.d.ts +3593 -0
- package/dist/mjs/types/models/cart.d.ts.map +1 -0
- package/dist/mjs/types/models/cart.js +7 -0
- package/dist/mjs/types/models/cart.js.map +1 -0
- package/dist/mjs/types/models/category.d.ts +636 -0
- package/dist/mjs/types/models/category.d.ts.map +1 -0
- package/dist/mjs/types/models/category.js +7 -0
- package/dist/mjs/types/models/category.js.map +1 -0
- package/dist/mjs/types/models/channel.d.ts +380 -0
- package/dist/mjs/types/models/channel.d.ts.map +1 -0
- package/dist/mjs/types/models/channel.js +7 -0
- package/dist/mjs/types/models/channel.js.map +1 -0
- package/dist/mjs/types/models/common.d.ts +1163 -0
- package/dist/mjs/types/models/common.d.ts.map +1 -0
- package/dist/mjs/types/models/common.js +7 -0
- package/dist/mjs/types/models/common.js.map +1 -0
- package/dist/mjs/types/models/custom-object.d.ts +152 -0
- package/dist/mjs/types/models/custom-object.d.ts.map +1 -0
- package/dist/mjs/types/models/custom-object.js +7 -0
- package/dist/mjs/types/models/custom-object.js.map +1 -0
- package/dist/mjs/types/models/customer-group.d.ts +235 -0
- package/dist/mjs/types/models/customer-group.d.ts.map +1 -0
- package/dist/mjs/types/models/customer-group.js +7 -0
- package/dist/mjs/types/models/customer-group.js.map +1 -0
- package/dist/mjs/types/models/customer-search.d.ts +114 -0
- package/dist/mjs/types/models/customer-search.d.ts.map +1 -0
- package/dist/mjs/types/models/customer-search.js +7 -0
- package/dist/mjs/types/models/customer-search.js.map +1 -0
- package/dist/mjs/types/models/customer.d.ts +1270 -0
- package/dist/mjs/types/models/customer.d.ts.map +1 -0
- package/dist/mjs/types/models/customer.js +7 -0
- package/dist/mjs/types/models/customer.js.map +1 -0
- package/dist/mjs/types/models/discount-code.d.ts +473 -0
- package/dist/mjs/types/models/discount-code.d.ts.map +1 -0
- package/dist/mjs/types/models/discount-code.js +7 -0
- package/dist/mjs/types/models/discount-code.js.map +1 -0
- package/dist/mjs/types/models/error.d.ts +3330 -0
- package/dist/mjs/types/models/error.d.ts.map +1 -0
- package/dist/mjs/types/models/error.js +7 -0
- package/dist/mjs/types/models/error.js.map +1 -0
- package/dist/mjs/types/models/extension.d.ts +336 -0
- package/dist/mjs/types/models/extension.d.ts.map +1 -0
- package/dist/mjs/types/models/extension.js +7 -0
- package/dist/mjs/types/models/extension.js.map +1 -0
- package/dist/mjs/types/models/index.d.ts +48 -0
- package/dist/mjs/types/models/index.d.ts.map +1 -0
- package/dist/mjs/types/models/index.js +48 -0
- package/dist/mjs/types/models/index.js.map +1 -0
- package/dist/mjs/types/models/inventory.d.ts +330 -0
- package/dist/mjs/types/models/inventory.d.ts.map +1 -0
- package/dist/mjs/types/models/inventory.js +7 -0
- package/dist/mjs/types/models/inventory.js.map +1 -0
- package/dist/mjs/types/models/me.d.ts +2636 -0
- package/dist/mjs/types/models/me.d.ts.map +1 -0
- package/dist/mjs/types/models/me.js +7 -0
- package/dist/mjs/types/models/me.js.map +1 -0
- package/dist/mjs/types/models/message.d.ts +23707 -0
- package/dist/mjs/types/models/message.d.ts.map +1 -0
- package/dist/mjs/types/models/message.js +7 -0
- package/dist/mjs/types/models/message.js.map +1 -0
- package/dist/mjs/types/models/order-edit.d.ts +2725 -0
- package/dist/mjs/types/models/order-edit.d.ts.map +1 -0
- package/dist/mjs/types/models/order-edit.js +7 -0
- package/dist/mjs/types/models/order-edit.js.map +1 -0
- package/dist/mjs/types/models/order.d.ts +3187 -0
- package/dist/mjs/types/models/order.d.ts.map +1 -0
- package/dist/mjs/types/models/order.js +7 -0
- package/dist/mjs/types/models/order.js.map +1 -0
- package/dist/mjs/types/models/payment.d.ts +680 -0
- package/dist/mjs/types/models/payment.d.ts.map +1 -0
- package/dist/mjs/types/models/payment.js +7 -0
- package/dist/mjs/types/models/payment.js.map +1 -0
- package/dist/mjs/types/models/product-discount.d.ts +465 -0
- package/dist/mjs/types/models/product-discount.d.ts.map +1 -0
- package/dist/mjs/types/models/product-discount.js +7 -0
- package/dist/mjs/types/models/product-discount.js.map +1 -0
- package/dist/mjs/types/models/product-search.d.ts +437 -0
- package/dist/mjs/types/models/product-search.d.ts.map +1 -0
- package/dist/mjs/types/models/product-search.js +7 -0
- package/dist/mjs/types/models/product-search.js.map +1 -0
- package/dist/mjs/types/models/product-selection.d.ts +579 -0
- package/dist/mjs/types/models/product-selection.d.ts.map +1 -0
- package/dist/mjs/types/models/product-selection.js +7 -0
- package/dist/mjs/types/models/product-selection.js.map +1 -0
- package/dist/mjs/types/models/product-tailoring.d.ts +1368 -0
- package/dist/mjs/types/models/product-tailoring.d.ts.map +1 -0
- package/dist/mjs/types/models/product-tailoring.js +7 -0
- package/dist/mjs/types/models/product-tailoring.js.map +1 -0
- package/dist/mjs/types/models/product-type.d.ts +775 -0
- package/dist/mjs/types/models/product-type.d.ts.map +1 -0
- package/dist/mjs/types/models/product-type.js +7 -0
- package/dist/mjs/types/models/product-type.js.map +1 -0
- package/dist/mjs/types/models/product.d.ts +2314 -0
- package/dist/mjs/types/models/product.d.ts.map +1 -0
- package/dist/mjs/types/models/product.js +7 -0
- package/dist/mjs/types/models/product.js.map +1 -0
- package/dist/mjs/types/models/project.d.ts +418 -0
- package/dist/mjs/types/models/project.d.ts.map +1 -0
- package/dist/mjs/types/models/project.js +7 -0
- package/dist/mjs/types/models/project.js.map +1 -0
- package/dist/mjs/types/models/quote-request.d.ts +452 -0
- package/dist/mjs/types/models/quote-request.d.ts.map +1 -0
- package/dist/mjs/types/models/quote-request.js +7 -0
- package/dist/mjs/types/models/quote-request.js.map +1 -0
- package/dist/mjs/types/models/quote.d.ts +473 -0
- package/dist/mjs/types/models/quote.d.ts.map +1 -0
- package/dist/mjs/types/models/quote.js +7 -0
- package/dist/mjs/types/models/quote.js.map +1 -0
- package/dist/mjs/types/models/review.d.ts +435 -0
- package/dist/mjs/types/models/review.d.ts.map +1 -0
- package/dist/mjs/types/models/review.js +7 -0
- package/dist/mjs/types/models/review.js.map +1 -0
- package/dist/mjs/types/models/scalar-types.d.ts +10 -0
- package/dist/mjs/types/models/scalar-types.d.ts.map +1 -0
- package/dist/mjs/types/models/scalar-types.js +7 -0
- package/dist/mjs/types/models/scalar-types.js.map +1 -0
- package/dist/mjs/types/models/search.d.ts +334 -0
- package/dist/mjs/types/models/search.d.ts.map +1 -0
- package/dist/mjs/types/models/search.js +7 -0
- package/dist/mjs/types/models/search.js.map +1 -0
- package/dist/mjs/types/models/shipping-method.d.ts +595 -0
- package/dist/mjs/types/models/shipping-method.d.ts.map +1 -0
- package/dist/mjs/types/models/shipping-method.js +7 -0
- package/dist/mjs/types/models/shipping-method.js.map +1 -0
- package/dist/mjs/types/models/shopping-list.d.ts +941 -0
- package/dist/mjs/types/models/shopping-list.d.ts.map +1 -0
- package/dist/mjs/types/models/shopping-list.js +7 -0
- package/dist/mjs/types/models/shopping-list.js.map +1 -0
- package/dist/mjs/types/models/staged-quote.d.ts +345 -0
- package/dist/mjs/types/models/staged-quote.d.ts.map +1 -0
- package/dist/mjs/types/models/staged-quote.js +7 -0
- package/dist/mjs/types/models/staged-quote.js.map +1 -0
- package/dist/mjs/types/models/standalone-price.d.ts +546 -0
- package/dist/mjs/types/models/standalone-price.d.ts.map +1 -0
- package/dist/mjs/types/models/standalone-price.js +7 -0
- package/dist/mjs/types/models/standalone-price.js.map +1 -0
- package/dist/mjs/types/models/state.d.ts +342 -0
- package/dist/mjs/types/models/state.d.ts.map +1 -0
- package/dist/mjs/types/models/state.js +7 -0
- package/dist/mjs/types/models/state.js.map +1 -0
- package/dist/mjs/types/models/store-country.d.ts +14 -0
- package/dist/mjs/types/models/store-country.d.ts.map +1 -0
- package/dist/mjs/types/models/store-country.js +7 -0
- package/dist/mjs/types/models/store-country.js.map +1 -0
- package/dist/mjs/types/models/store.d.ts +548 -0
- package/dist/mjs/types/models/store.d.ts.map +1 -0
- package/dist/mjs/types/models/store.js +7 -0
- package/dist/mjs/types/models/store.js.map +1 -0
- package/dist/mjs/types/models/subscription.d.ts +772 -0
- package/dist/mjs/types/models/subscription.d.ts.map +1 -0
- package/dist/mjs/types/models/subscription.js +7 -0
- package/dist/mjs/types/models/subscription.js.map +1 -0
- package/dist/mjs/types/models/tax-category.d.ts +379 -0
- package/dist/mjs/types/models/tax-category.d.ts.map +1 -0
- package/dist/mjs/types/models/tax-category.js +7 -0
- package/dist/mjs/types/models/tax-category.js.map +1 -0
- package/dist/mjs/types/models/type.d.ts +646 -0
- package/dist/mjs/types/models/type.d.ts.map +1 -0
- package/dist/mjs/types/models/type.js +7 -0
- package/dist/mjs/types/models/type.js.map +1 -0
- package/dist/mjs/types/models/warning.d.ts +24 -0
- package/dist/mjs/types/models/warning.d.ts.map +1 -0
- package/dist/mjs/types/models/warning.js +7 -0
- package/dist/mjs/types/models/warning.js.map +1 -0
- package/dist/mjs/types/models/zone.d.ts +235 -0
- package/dist/mjs/types/models/zone.d.ts.map +1 -0
- package/dist/mjs/types/models/zone.js +7 -0
- package/dist/mjs/types/models/zone.js.map +1 -0
- package/dist/mjs/types.d.ts +1 -1
- package/dist/mjs/types.d.ts.map +1 -1
- package/dist/mjs/types.js +1 -0
- package/dist/mjs/types.js.map +1 -1
- package/dist/mjs/utils/axios/create-instance.d.ts +0 -1
- package/dist/mjs/utils/axios/create-instance.d.ts.map +1 -1
- package/dist/mjs/utils/axios/create-instance.js +2 -0
- package/dist/mjs/utils/axios/create-instance.js.map +1 -1
- package/package.json +27 -26
|
@@ -0,0 +1,3330 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Code generated by [commercetools RMF-Codegen](https://github.com/commercetools/rmf-codegen). DO NOT EDIT.
|
|
3
|
+
* Please don't change this file manually but run `rmf-codegen generate raml_file_path -o output_path -t typescript_client` to update it.
|
|
4
|
+
* For more information about the commercetools platform APIs, visit https://docs.commercetools.com/.
|
|
5
|
+
*/
|
|
6
|
+
import { Permission } from './associate-role.js';
|
|
7
|
+
import { BusinessUnitResourceIdentifier } from './business-unit.js';
|
|
8
|
+
import { ChannelReference, ChannelResourceIdentifier, ChannelRoleEnum } from './channel.js';
|
|
9
|
+
import { LocalizedString, Price, PriceDraft, Reference, ReferenceTypeId } from './common.js';
|
|
10
|
+
import { CustomerResourceIdentifier } from './customer.js';
|
|
11
|
+
import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group.js';
|
|
12
|
+
import { OrderEditPreviewFailure } from './order-edit.js';
|
|
13
|
+
import { Attribute, ProductReference } from './product.js';
|
|
14
|
+
import { ProductSearchErrorResponse } from './product-search.js';
|
|
15
|
+
import { ProductVariantSelection } from './product-selection.js';
|
|
16
|
+
import { StandalonePriceReference } from './standalone-price.js';
|
|
17
|
+
import { StoreKeyReference } from './store.js';
|
|
18
|
+
export interface ErrorByExtension {
|
|
19
|
+
/**
|
|
20
|
+
* Unique identifier of the Extension.
|
|
21
|
+
*
|
|
22
|
+
*/
|
|
23
|
+
readonly id: string;
|
|
24
|
+
/**
|
|
25
|
+
* User-defined unique identifier of the Extension.
|
|
26
|
+
*
|
|
27
|
+
*/
|
|
28
|
+
readonly key?: string;
|
|
29
|
+
}
|
|
30
|
+
/**
|
|
31
|
+
* Represents a single error. Multiple errors may be included in an [ErrorResponse](ctp:api:type:ErrorResponse).
|
|
32
|
+
*/
|
|
33
|
+
export type ErrorObject = AnonymousIdAlreadyInUseError | AssociateMissingPermissionError | AttributeDefinitionAlreadyExistsError | AttributeDefinitionTypeConflictError | AttributeNameDoesNotExistError | BadGatewayError | ConcurrentModificationError | ContentTooLargeError | CountryNotConfiguredInStoreError | DiscountCodeNonApplicableError | DuplicateAttributeValueError | DuplicateAttributeValuesError | DuplicateEnumValuesError | DuplicateFieldError | DuplicateFieldWithConflictingResourceError | DuplicatePriceKeyError | DuplicatePriceScopeError | DuplicateStandalonePriceScopeError | DuplicateVariantValuesError | EditPreviewFailedError | EnumKeyAlreadyExistsError | EnumKeyDoesNotExistError | EnumValueIsUsedError | EnumValuesMustMatchError | ExtensionBadResponseError | ExtensionNoResponseError | ExtensionPredicateEvaluationFailedError | ExtensionUpdateActionsFailedError | ExternalOAuthFailedError | FeatureRemovedError | GeneralError | InsufficientScopeError | InternalConstraintViolatedError | InvalidCredentialsError | InvalidCurrentPasswordError | InvalidFieldError | InvalidInputError | InvalidItemShippingDetailsError | InvalidJsonInputError | InvalidOperationError | InvalidSubjectError | InvalidTokenError | LanguageUsedInStoresError | LockedFieldError | MatchingPriceNotFoundError | MaxCartDiscountsReachedError | MaxResourceLimitExceededError | MaxStoreReferencesReachedError | MissingRoleOnChannelError | MissingTaxRateForCountryError | MoneyOverflowError | NoMatchingProductDiscountFoundError | ObjectNotFoundError | OutOfStockError | OverCapacityError | OverlappingStandalonePriceValidityError | PendingOperationError | PriceChangedError | ProductAssignmentMissingError | ProductPresentWithDifferentVariantSelectionError | ProjectNotConfiguredForLanguagesError | QueryComplexityLimitExceededError | QueryTimedOutError | ReferenceExistsError | ReferencedResourceNotFoundError | RequiredFieldError | ResourceNotFoundError | ResourceSizeLimitExceededError | SearchDeactivatedError | SearchExecutionFailureError | SearchFacetPathNotFoundError | SearchIndexingInProgressError | SearchNotReadyError | SemanticErrorError | ShippingMethodDoesNotMatchCartError | StoreCartDiscountsLimitReachedError | SyntaxErrorError;
|
|
34
|
+
/**
|
|
35
|
+
* Returned when the anonymous ID is being used by another resource.
|
|
36
|
+
*
|
|
37
|
+
* The client application should choose another anonymous ID or retrieve an automatically generated one.
|
|
38
|
+
*
|
|
39
|
+
*/
|
|
40
|
+
export interface AnonymousIdAlreadyInUseError {
|
|
41
|
+
readonly code: 'AnonymousIdAlreadyInUse';
|
|
42
|
+
[key: string]: any;
|
|
43
|
+
/**
|
|
44
|
+
* `"The given anonymous ID is already in use."`
|
|
45
|
+
*
|
|
46
|
+
*
|
|
47
|
+
*/
|
|
48
|
+
readonly message: string;
|
|
49
|
+
}
|
|
50
|
+
/**
|
|
51
|
+
* Returned when an [Associate](/projects/business-units#associate) is missing a [Permission](/projects/associate-roles#ctp:api:type:Permission) on a [B2B resource](/associates-overview#b2b-resources).
|
|
52
|
+
*
|
|
53
|
+
*/
|
|
54
|
+
export interface AssociateMissingPermissionError {
|
|
55
|
+
readonly code: 'AssociateMissingPermission';
|
|
56
|
+
[key: string]: any;
|
|
57
|
+
/**
|
|
58
|
+
* - When an action is performed by an Associate: `"Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."`
|
|
59
|
+
* - When an action is performed for another Associate, like [viewing their Cart](/projects/associate-carts#get-cart-in-businessunit): `"Associate '$idOfAssociate' has no rights to $action for customer '$idOfCustomer' in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredPermission'."`
|
|
60
|
+
* - When viewing an entity: `"Associate '$idOfAssociate' has no rights to $action in business-unit '$idOrKeyOfBusinessUnit'. Needs '$requiredViewMyPermission' or '$requiredViewOthersPermission'."`
|
|
61
|
+
*
|
|
62
|
+
*
|
|
63
|
+
*/
|
|
64
|
+
readonly message: string;
|
|
65
|
+
/**
|
|
66
|
+
* [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) to the [Associate](ctp:api:type:Associate) that tried to perform the action.
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
*/
|
|
70
|
+
readonly associate: CustomerResourceIdentifier;
|
|
71
|
+
/**
|
|
72
|
+
* [ResourceIdentifier](ctp:api:type:BusinessUnitResourceIdentifier) to the [BusinessUnit](ctp:api:type:BusinessUnit).
|
|
73
|
+
*
|
|
74
|
+
*
|
|
75
|
+
*/
|
|
76
|
+
readonly businessUnit: BusinessUnitResourceIdentifier;
|
|
77
|
+
/**
|
|
78
|
+
* [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) of the [Associate](ctp:api:type:Associate) on whose behalf the action is performed.
|
|
79
|
+
*
|
|
80
|
+
*
|
|
81
|
+
*/
|
|
82
|
+
readonly associateOnBehalf?: CustomerResourceIdentifier;
|
|
83
|
+
/**
|
|
84
|
+
* The Permissions that the [Associate](ctp:api:type:Associate) performing the action lacks. At least one of these Permissions is needed.
|
|
85
|
+
*
|
|
86
|
+
*
|
|
87
|
+
*/
|
|
88
|
+
readonly permissions: Permission[];
|
|
89
|
+
}
|
|
90
|
+
/**
|
|
91
|
+
* Returned when the `name` of the [AttributeDefinition](ctp:api:type:AttributeDefinition) conflicts with an existing Attribute.
|
|
92
|
+
*
|
|
93
|
+
* The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request or [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action.
|
|
94
|
+
*
|
|
95
|
+
*/
|
|
96
|
+
export interface AttributeDefinitionAlreadyExistsError {
|
|
97
|
+
readonly code: 'AttributeDefinitionAlreadyExists';
|
|
98
|
+
[key: string]: any;
|
|
99
|
+
/**
|
|
100
|
+
* `"An attribute definition with name $attributeName already exists on product type $productTypeName."`
|
|
101
|
+
*
|
|
102
|
+
*
|
|
103
|
+
*/
|
|
104
|
+
readonly message: string;
|
|
105
|
+
/**
|
|
106
|
+
* Unique identifier of the Product Type containing the conflicting name.
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
*/
|
|
110
|
+
readonly conflictingProductTypeId: string;
|
|
111
|
+
/**
|
|
112
|
+
* Name of the Product Type containing the conflicting name.
|
|
113
|
+
*
|
|
114
|
+
*
|
|
115
|
+
*/
|
|
116
|
+
readonly conflictingProductTypeName: string;
|
|
117
|
+
/**
|
|
118
|
+
* Name of the conflicting Attribute.
|
|
119
|
+
*
|
|
120
|
+
*
|
|
121
|
+
*/
|
|
122
|
+
readonly conflictingAttributeName: string;
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Returned when the `type` is different for an AttributeDefinition using the same `name` in multiple Product Types.
|
|
126
|
+
*
|
|
127
|
+
* The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request.
|
|
128
|
+
*
|
|
129
|
+
*/
|
|
130
|
+
export interface AttributeDefinitionTypeConflictError {
|
|
131
|
+
readonly code: 'AttributeDefinitionTypeConflict';
|
|
132
|
+
[key: string]: any;
|
|
133
|
+
/**
|
|
134
|
+
* `"The attribute with name $attributeName has a different type on product type $productTypeName."`
|
|
135
|
+
*
|
|
136
|
+
*
|
|
137
|
+
*/
|
|
138
|
+
readonly message: string;
|
|
139
|
+
/**
|
|
140
|
+
* Unique identifier of the Product Type containing the conflicting name.
|
|
141
|
+
*
|
|
142
|
+
*
|
|
143
|
+
*/
|
|
144
|
+
readonly conflictingProductTypeId: string;
|
|
145
|
+
/**
|
|
146
|
+
* Name of the Product Type containing the conflicting name.
|
|
147
|
+
*
|
|
148
|
+
*
|
|
149
|
+
*/
|
|
150
|
+
readonly conflictingProductTypeName: string;
|
|
151
|
+
/**
|
|
152
|
+
* Name of the conflicting Attribute.
|
|
153
|
+
*
|
|
154
|
+
*
|
|
155
|
+
*/
|
|
156
|
+
readonly conflictingAttributeName: string;
|
|
157
|
+
}
|
|
158
|
+
/**
|
|
159
|
+
* Returned when an [AttributeDefinition](ctp:api:type:AttributeDefinition) does not exist for an Attribute `name`.
|
|
160
|
+
*
|
|
161
|
+
* The error is returned as a failed response to the [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action.
|
|
162
|
+
*
|
|
163
|
+
*/
|
|
164
|
+
export interface AttributeNameDoesNotExistError {
|
|
165
|
+
readonly code: 'AttributeNameDoesNotExist';
|
|
166
|
+
[key: string]: any;
|
|
167
|
+
/**
|
|
168
|
+
* `"Attribute definition for $attributeName does not exist on type $typeName."`
|
|
169
|
+
*
|
|
170
|
+
*
|
|
171
|
+
*/
|
|
172
|
+
readonly message: string;
|
|
173
|
+
/**
|
|
174
|
+
* Non-existent Attribute name.
|
|
175
|
+
*
|
|
176
|
+
*
|
|
177
|
+
*/
|
|
178
|
+
readonly invalidAttributeName: string;
|
|
179
|
+
}
|
|
180
|
+
/**
|
|
181
|
+
* Returned when a server-side problem is caused by scaling infrastructure resources.
|
|
182
|
+
*
|
|
183
|
+
* The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.
|
|
184
|
+
*
|
|
185
|
+
*/
|
|
186
|
+
export interface BadGatewayError {
|
|
187
|
+
readonly code: 'BadGateway';
|
|
188
|
+
[key: string]: any;
|
|
189
|
+
/**
|
|
190
|
+
* Plain text description of the error.
|
|
191
|
+
*
|
|
192
|
+
*/
|
|
193
|
+
readonly message: string;
|
|
194
|
+
}
|
|
195
|
+
/**
|
|
196
|
+
* Returned when the request conflicts with the current state of the involved resources. Typically, the request attempts to modify a resource that is out of date (that is modified by another client since it was last retrieved).
|
|
197
|
+
* The client application should resolve the conflict (with or without involving the end user) before retrying the request.
|
|
198
|
+
*
|
|
199
|
+
*/
|
|
200
|
+
export interface ConcurrentModificationError {
|
|
201
|
+
readonly code: 'ConcurrentModification';
|
|
202
|
+
[key: string]: any;
|
|
203
|
+
/**
|
|
204
|
+
* `"Object $resourceId has a different version than expected. Expected: $expectedVersion - Actual: $currentVersion."`
|
|
205
|
+
*
|
|
206
|
+
*
|
|
207
|
+
*/
|
|
208
|
+
readonly message: string;
|
|
209
|
+
/**
|
|
210
|
+
* Current version of the resource.
|
|
211
|
+
*
|
|
212
|
+
*
|
|
213
|
+
*/
|
|
214
|
+
readonly currentVersion?: number;
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* Returned when the request results in too much data being returned from the API. Adjust the request query to reduce the size of the data returned.
|
|
218
|
+
*
|
|
219
|
+
*/
|
|
220
|
+
export interface ContentTooLargeError {
|
|
221
|
+
readonly code: 'ContentTooLarge';
|
|
222
|
+
[key: string]: any;
|
|
223
|
+
/**
|
|
224
|
+
* `"Content too large."`
|
|
225
|
+
*
|
|
226
|
+
*
|
|
227
|
+
*/
|
|
228
|
+
readonly message: string;
|
|
229
|
+
}
|
|
230
|
+
/**
|
|
231
|
+
* Returned when a [Cart](ctp:api:type:Cart) or an [Order](ctp:api:type:Order) in a [Store](ctp:api:type:Store) references a country that is not included in the countries configured for the Store.
|
|
232
|
+
*
|
|
233
|
+
* The error is returned as a failed response to:
|
|
234
|
+
*
|
|
235
|
+
* - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST) request and [Set Country](ctp:api:type:CartSetCountryAction) update action on Carts.
|
|
236
|
+
* - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST) request and [Set Country](ctp:api:type:MyCartSetCountryAction) update action on My Carts.
|
|
237
|
+
* - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders.
|
|
238
|
+
* - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
239
|
+
* - [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) request on Order Import.
|
|
240
|
+
* - [Set Country](ctp:api:type:StagedOrderSetCountryAction) update action on Order Edits.
|
|
241
|
+
*
|
|
242
|
+
*/
|
|
243
|
+
export interface CountryNotConfiguredInStoreError {
|
|
244
|
+
readonly code: 'CountryNotConfiguredInStore';
|
|
245
|
+
[key: string]: any;
|
|
246
|
+
/**
|
|
247
|
+
* `"The country $country is not configured for the store $store."`
|
|
248
|
+
*
|
|
249
|
+
*
|
|
250
|
+
*/
|
|
251
|
+
readonly message: string;
|
|
252
|
+
/**
|
|
253
|
+
* Countries configured for the Store.
|
|
254
|
+
*
|
|
255
|
+
*
|
|
256
|
+
*/
|
|
257
|
+
readonly storeCountries: string[];
|
|
258
|
+
/**
|
|
259
|
+
* The country that is not configured for the Store but referenced on the Cart or Order.
|
|
260
|
+
*
|
|
261
|
+
*
|
|
262
|
+
*/
|
|
263
|
+
readonly country: string;
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Returned when the Cart contains a Discount Code with a [DiscountCodeState](ctp:api:type:DiscountCodeState) other than `MatchesCart`.
|
|
267
|
+
*
|
|
268
|
+
* The error is returned as a failed response to:
|
|
269
|
+
*
|
|
270
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update action on Carts.
|
|
271
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests and [Add DiscountCode](ctp:api:type:MyCartAddDiscountCodeAction) update action on My Carts.
|
|
272
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts.
|
|
273
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
274
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
275
|
+
* - [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action on Order Edits.
|
|
276
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
277
|
+
*
|
|
278
|
+
*/
|
|
279
|
+
export interface DiscountCodeNonApplicableError {
|
|
280
|
+
readonly code: 'DiscountCodeNonApplicable';
|
|
281
|
+
[key: string]: any;
|
|
282
|
+
/**
|
|
283
|
+
* `"The discountCode $discountCodeId cannot be applied to the cart."`
|
|
284
|
+
*
|
|
285
|
+
*
|
|
286
|
+
*/
|
|
287
|
+
readonly message: string;
|
|
288
|
+
/**
|
|
289
|
+
* Discount Code passed to the Cart.
|
|
290
|
+
*
|
|
291
|
+
*
|
|
292
|
+
*/
|
|
293
|
+
readonly discountCode?: string;
|
|
294
|
+
/**
|
|
295
|
+
* `"DoesNotExist"` or `"TimeRangeNonApplicable"`
|
|
296
|
+
*
|
|
297
|
+
*
|
|
298
|
+
*/
|
|
299
|
+
readonly reason?: string;
|
|
300
|
+
/**
|
|
301
|
+
* Unique identifier of the Discount Code.
|
|
302
|
+
*
|
|
303
|
+
*
|
|
304
|
+
*/
|
|
305
|
+
readonly discountCodeId?: string;
|
|
306
|
+
/**
|
|
307
|
+
* Date and time (UTC) from which the Discount Code is valid.
|
|
308
|
+
*
|
|
309
|
+
*
|
|
310
|
+
*/
|
|
311
|
+
readonly validFrom?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Date and time (UTC) until which the Discount Code is valid.
|
|
314
|
+
*
|
|
315
|
+
*
|
|
316
|
+
*/
|
|
317
|
+
readonly validUntil?: string;
|
|
318
|
+
/**
|
|
319
|
+
* Date and time (UTC) the Discount Code validity check was last performed.
|
|
320
|
+
*
|
|
321
|
+
*
|
|
322
|
+
*/
|
|
323
|
+
readonly validityCheckTime?: string;
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Returned when the `Unique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
|
|
327
|
+
*
|
|
328
|
+
*/
|
|
329
|
+
export interface DuplicateAttributeValueError {
|
|
330
|
+
readonly code: 'DuplicateAttributeValue';
|
|
331
|
+
[key: string]: any;
|
|
332
|
+
/**
|
|
333
|
+
* `"Attribute can't have the same value in a different variant."`
|
|
334
|
+
*
|
|
335
|
+
*
|
|
336
|
+
*/
|
|
337
|
+
readonly message: string;
|
|
338
|
+
/**
|
|
339
|
+
* Conflicting Attributes.
|
|
340
|
+
*
|
|
341
|
+
*
|
|
342
|
+
*/
|
|
343
|
+
readonly attribute: Attribute;
|
|
344
|
+
}
|
|
345
|
+
/**
|
|
346
|
+
* Returned when the `CombinationUnique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
|
|
347
|
+
*
|
|
348
|
+
*/
|
|
349
|
+
export interface DuplicateAttributeValuesError {
|
|
350
|
+
readonly code: 'DuplicateAttributeValues';
|
|
351
|
+
[key: string]: any;
|
|
352
|
+
/**
|
|
353
|
+
* `"The set of attributes must be unique across all variants."`
|
|
354
|
+
*
|
|
355
|
+
*
|
|
356
|
+
*/
|
|
357
|
+
readonly message: string;
|
|
358
|
+
/**
|
|
359
|
+
* Conflicting Attributes.
|
|
360
|
+
*
|
|
361
|
+
*
|
|
362
|
+
*/
|
|
363
|
+
readonly attributes: Attribute[];
|
|
364
|
+
}
|
|
365
|
+
/**
|
|
366
|
+
* Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains duplicate keys.
|
|
367
|
+
*
|
|
368
|
+
*/
|
|
369
|
+
export interface DuplicateEnumValuesError {
|
|
370
|
+
readonly code: 'DuplicateEnumValues';
|
|
371
|
+
[key: string]: any;
|
|
372
|
+
/**
|
|
373
|
+
* `"The enum values contain duplicate keys: $listOfDuplicateKeys."`
|
|
374
|
+
*
|
|
375
|
+
*
|
|
376
|
+
*/
|
|
377
|
+
readonly message: string;
|
|
378
|
+
/**
|
|
379
|
+
* Duplicate keys.
|
|
380
|
+
*
|
|
381
|
+
*
|
|
382
|
+
*/
|
|
383
|
+
readonly duplicates: string[];
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
* Returned when a field value conflicts with an existing value causing a duplicate.
|
|
387
|
+
*
|
|
388
|
+
*/
|
|
389
|
+
export interface DuplicateFieldError {
|
|
390
|
+
readonly code: 'DuplicateField';
|
|
391
|
+
[key: string]: any;
|
|
392
|
+
/**
|
|
393
|
+
* `"A duplicate value $duplicateValue exists for field $field."`
|
|
394
|
+
*
|
|
395
|
+
*
|
|
396
|
+
*/
|
|
397
|
+
readonly message: string;
|
|
398
|
+
/**
|
|
399
|
+
* Name of the conflicting field.
|
|
400
|
+
*
|
|
401
|
+
*
|
|
402
|
+
*/
|
|
403
|
+
readonly field: string;
|
|
404
|
+
/**
|
|
405
|
+
* Conflicting duplicate value.
|
|
406
|
+
*
|
|
407
|
+
*
|
|
408
|
+
*/
|
|
409
|
+
readonly duplicateValue: any;
|
|
410
|
+
}
|
|
411
|
+
/**
|
|
412
|
+
* Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
|
|
413
|
+
*
|
|
414
|
+
*/
|
|
415
|
+
export interface DuplicateFieldWithConflictingResourceError {
|
|
416
|
+
readonly code: 'DuplicateFieldWithConflictingResource';
|
|
417
|
+
[key: string]: any;
|
|
418
|
+
/**
|
|
419
|
+
* `"A duplicate value $duplicateValue exists for field $field on $conflictingResource."`
|
|
420
|
+
*
|
|
421
|
+
*
|
|
422
|
+
*/
|
|
423
|
+
readonly message: string;
|
|
424
|
+
/**
|
|
425
|
+
* Name of the conflicting field.
|
|
426
|
+
*
|
|
427
|
+
*
|
|
428
|
+
*/
|
|
429
|
+
readonly field: string;
|
|
430
|
+
/**
|
|
431
|
+
* Conflicting duplicate value.
|
|
432
|
+
*
|
|
433
|
+
*
|
|
434
|
+
*/
|
|
435
|
+
readonly duplicateValue: any;
|
|
436
|
+
/**
|
|
437
|
+
* Reference to the resource that has the conflicting value.
|
|
438
|
+
*
|
|
439
|
+
*
|
|
440
|
+
*/
|
|
441
|
+
readonly conflictingResource: Reference;
|
|
442
|
+
}
|
|
443
|
+
/**
|
|
444
|
+
* Returned when a Price key conflicts with an existing key.
|
|
445
|
+
*
|
|
446
|
+
* Keys of Embedded Prices must be unique per ProductVariant.
|
|
447
|
+
*
|
|
448
|
+
*/
|
|
449
|
+
export interface DuplicatePriceKeyError {
|
|
450
|
+
readonly code: 'DuplicatePriceKey';
|
|
451
|
+
[key: string]: any;
|
|
452
|
+
/**
|
|
453
|
+
* `"Duplicate price key: $priceKey. The price key must be unique per variant."`
|
|
454
|
+
*
|
|
455
|
+
*
|
|
456
|
+
*/
|
|
457
|
+
readonly message: string;
|
|
458
|
+
/**
|
|
459
|
+
* Conflicting Embedded Price.
|
|
460
|
+
*
|
|
461
|
+
*
|
|
462
|
+
*/
|
|
463
|
+
readonly conflictingPrice: Price;
|
|
464
|
+
}
|
|
465
|
+
/**
|
|
466
|
+
* Returned when a Price scope conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
|
|
467
|
+
*
|
|
468
|
+
* Every Price of a Product Variant must have a distinct combination of currency, Customer Group, country, and Channel that constitute the scope of a Price.
|
|
469
|
+
*
|
|
470
|
+
*/
|
|
471
|
+
export interface DuplicatePriceScopeError {
|
|
472
|
+
readonly code: 'DuplicatePriceScope';
|
|
473
|
+
[key: string]: any;
|
|
474
|
+
/**
|
|
475
|
+
* `"Duplicate price scope: $priceScope. The combination of currency, country, customerGroup and channel must be unique for each price of a product variant."`
|
|
476
|
+
*
|
|
477
|
+
*
|
|
478
|
+
*/
|
|
479
|
+
readonly message: string;
|
|
480
|
+
/**
|
|
481
|
+
* Conflicting Embedded Price.
|
|
482
|
+
*
|
|
483
|
+
*
|
|
484
|
+
*/
|
|
485
|
+
readonly conflictingPrice: Price;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
|
|
489
|
+
* Every Standalone Price associated with the same SKU must have a distinct combination of currency, country, Customer Group, Channel, and validity periods (`validFrom` and `validUntil`).
|
|
490
|
+
*
|
|
491
|
+
* The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
|
|
492
|
+
*
|
|
493
|
+
*/
|
|
494
|
+
export interface DuplicateStandalonePriceScopeError {
|
|
495
|
+
readonly code: 'DuplicateStandalonePriceScope';
|
|
496
|
+
[key: string]: any;
|
|
497
|
+
/**
|
|
498
|
+
* `"Duplicate standalone price scope for SKU: $sku. The combination of SKU, currency, country, customerGroup, channel, validFrom and validUntil must be unique for each standalone price."`
|
|
499
|
+
*
|
|
500
|
+
*
|
|
501
|
+
*/
|
|
502
|
+
readonly message: string;
|
|
503
|
+
/**
|
|
504
|
+
* Reference to the conflicting Standalone Price.
|
|
505
|
+
*
|
|
506
|
+
*
|
|
507
|
+
*/
|
|
508
|
+
readonly conflictingStandalonePrice: StandalonePriceReference;
|
|
509
|
+
/**
|
|
510
|
+
* SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
|
|
511
|
+
*
|
|
512
|
+
*
|
|
513
|
+
*/
|
|
514
|
+
readonly sku: string;
|
|
515
|
+
/**
|
|
516
|
+
* Currency code of the country.
|
|
517
|
+
*
|
|
518
|
+
*
|
|
519
|
+
*/
|
|
520
|
+
readonly currency: string;
|
|
521
|
+
/**
|
|
522
|
+
* Country code of the geographic location.
|
|
523
|
+
*
|
|
524
|
+
*
|
|
525
|
+
*/
|
|
526
|
+
readonly country?: string;
|
|
527
|
+
/**
|
|
528
|
+
* [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
|
|
529
|
+
*
|
|
530
|
+
*
|
|
531
|
+
*/
|
|
532
|
+
readonly customerGroup?: CustomerGroupResourceIdentifier;
|
|
533
|
+
/**
|
|
534
|
+
* [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
|
|
535
|
+
*
|
|
536
|
+
*
|
|
537
|
+
*/
|
|
538
|
+
readonly channel?: ChannelResourceIdentifier;
|
|
539
|
+
/**
|
|
540
|
+
* Date and time (UTC) from which the Standalone Price is valid.
|
|
541
|
+
*
|
|
542
|
+
*
|
|
543
|
+
*/
|
|
544
|
+
readonly validFrom?: string;
|
|
545
|
+
/**
|
|
546
|
+
* Date and time (UTC) until which the Standalone Price is valid.
|
|
547
|
+
*
|
|
548
|
+
*
|
|
549
|
+
*/
|
|
550
|
+
readonly validUntil?: string;
|
|
551
|
+
}
|
|
552
|
+
/**
|
|
553
|
+
* Returned when a [Product Variant](ctp:api:type:ProductVariant) value conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
|
|
554
|
+
*
|
|
555
|
+
*/
|
|
556
|
+
export interface DuplicateVariantValuesError {
|
|
557
|
+
readonly code: 'DuplicateVariantValues';
|
|
558
|
+
[key: string]: any;
|
|
559
|
+
/**
|
|
560
|
+
* `"A duplicate combination of the variant values (sku, key, images, prices, attributes) exists."`
|
|
561
|
+
*
|
|
562
|
+
*
|
|
563
|
+
*/
|
|
564
|
+
readonly message: string;
|
|
565
|
+
/**
|
|
566
|
+
* Every Product Variant must have a distinct combination of SKU, prices, and custom Attribute values.
|
|
567
|
+
*
|
|
568
|
+
*
|
|
569
|
+
*/
|
|
570
|
+
readonly variantValues: VariantValues;
|
|
571
|
+
}
|
|
572
|
+
/**
|
|
573
|
+
* Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
|
|
574
|
+
*
|
|
575
|
+
* The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-orderedit:GET) request.
|
|
576
|
+
*
|
|
577
|
+
*/
|
|
578
|
+
export interface EditPreviewFailedError {
|
|
579
|
+
readonly code: 'EditPreviewFailed';
|
|
580
|
+
[key: string]: any;
|
|
581
|
+
/**
|
|
582
|
+
* `"Error while applying staged actions. ShippingMethods could not be determined."`
|
|
583
|
+
*
|
|
584
|
+
*
|
|
585
|
+
*/
|
|
586
|
+
readonly message: string;
|
|
587
|
+
/**
|
|
588
|
+
* State of the OrderEdit where the `stagedActions` cannot be applied to the Order.
|
|
589
|
+
*
|
|
590
|
+
*
|
|
591
|
+
*/
|
|
592
|
+
readonly result: OrderEditPreviewFailure;
|
|
593
|
+
}
|
|
594
|
+
/**
|
|
595
|
+
* Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains a key that already exists.
|
|
596
|
+
*
|
|
597
|
+
*/
|
|
598
|
+
export interface EnumKeyAlreadyExistsError {
|
|
599
|
+
readonly code: 'EnumKeyAlreadyExists';
|
|
600
|
+
[key: string]: any;
|
|
601
|
+
/**
|
|
602
|
+
* `"The $attributeName attribute definition already contains an enum value with the key $enumKey."`
|
|
603
|
+
*
|
|
604
|
+
*
|
|
605
|
+
*/
|
|
606
|
+
readonly message: string;
|
|
607
|
+
/**
|
|
608
|
+
* Conflicting enum key.
|
|
609
|
+
*
|
|
610
|
+
*
|
|
611
|
+
*/
|
|
612
|
+
readonly conflictingEnumKey: string;
|
|
613
|
+
/**
|
|
614
|
+
* Name of the conflicting Attribute.
|
|
615
|
+
*
|
|
616
|
+
*
|
|
617
|
+
*/
|
|
618
|
+
readonly conflictingAttributeName: string;
|
|
619
|
+
}
|
|
620
|
+
/**
|
|
621
|
+
* Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) already contains a value with the given key.
|
|
622
|
+
*
|
|
623
|
+
* The error is returned as a failed response to the [Change the key of an EnumValue](ctp:api:type:ProductTypeChangeEnumKeyAction) update action.
|
|
624
|
+
*
|
|
625
|
+
*/
|
|
626
|
+
export interface EnumKeyDoesNotExistError {
|
|
627
|
+
readonly code: 'EnumKeyDoesNotExist';
|
|
628
|
+
[key: string]: any;
|
|
629
|
+
/**
|
|
630
|
+
* `"The $fieldName field definition does not contain an enum value with the key $enumKey."`
|
|
631
|
+
*
|
|
632
|
+
*
|
|
633
|
+
*/
|
|
634
|
+
readonly message: string;
|
|
635
|
+
/**
|
|
636
|
+
* Conflicting enum key.
|
|
637
|
+
*
|
|
638
|
+
*
|
|
639
|
+
*/
|
|
640
|
+
readonly conflictingEnumKey: string;
|
|
641
|
+
/**
|
|
642
|
+
* Name of the conflicting Attribute.
|
|
643
|
+
*
|
|
644
|
+
*
|
|
645
|
+
*/
|
|
646
|
+
readonly conflictingAttributeName: string;
|
|
647
|
+
}
|
|
648
|
+
/**
|
|
649
|
+
* Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
|
|
650
|
+
*
|
|
651
|
+
* The error is returned as a failed response to the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action.
|
|
652
|
+
*
|
|
653
|
+
*/
|
|
654
|
+
export interface EnumValueIsUsedError {
|
|
655
|
+
readonly code: 'EnumValueIsUsed';
|
|
656
|
+
[key: string]: any;
|
|
657
|
+
/**
|
|
658
|
+
* `"$enumKeysTranscript is used by some products and cannot be deleted because the $attributeName attribute is required."`
|
|
659
|
+
*
|
|
660
|
+
*
|
|
661
|
+
*/
|
|
662
|
+
readonly message: string;
|
|
663
|
+
}
|
|
664
|
+
/**
|
|
665
|
+
* Returned when during an order update of [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) the new enum values do not match the existing ones.
|
|
666
|
+
*
|
|
667
|
+
* The error is returned as a failed response to the [Change the order of EnumValues](ctp:api:type:ProductTypeChangePlainEnumValueOrderAction) and [Change the order of LocalizedEnumValues](ctp:api:type:ProductTypeChangeLocalizedEnumValueOrderAction) update actions.
|
|
668
|
+
*
|
|
669
|
+
*/
|
|
670
|
+
export interface EnumValuesMustMatchError {
|
|
671
|
+
readonly code: 'EnumValuesMustMatch';
|
|
672
|
+
[key: string]: any;
|
|
673
|
+
/**
|
|
674
|
+
* `"The given values must be equal to the existing enum values."`
|
|
675
|
+
*
|
|
676
|
+
*
|
|
677
|
+
*/
|
|
678
|
+
readonly message: string;
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* Base representation of an error response containing common fields to all errors.
|
|
682
|
+
*
|
|
683
|
+
*/
|
|
684
|
+
export interface ErrorResponse {
|
|
685
|
+
/**
|
|
686
|
+
* HTTP status code corresponding to the error.
|
|
687
|
+
*
|
|
688
|
+
*
|
|
689
|
+
*/
|
|
690
|
+
readonly statusCode: number;
|
|
691
|
+
/**
|
|
692
|
+
* First error message in the `errors` array.
|
|
693
|
+
*
|
|
694
|
+
*
|
|
695
|
+
*/
|
|
696
|
+
readonly message: string;
|
|
697
|
+
/**
|
|
698
|
+
* Errors returned for a request.
|
|
699
|
+
*
|
|
700
|
+
* A single error response can contain multiple errors if the errors are related to the same HTTP status code such as `400`.
|
|
701
|
+
*
|
|
702
|
+
*
|
|
703
|
+
*/
|
|
704
|
+
readonly errors?: ErrorObject[];
|
|
705
|
+
}
|
|
706
|
+
export type _ErrorResponse = ErrorResponse | AuthErrorResponse | ProductSearchErrorResponse;
|
|
707
|
+
/**
|
|
708
|
+
* Represents errors related to authentication and authorization in a format conforming to the [OAuth 2.0 specification](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2).
|
|
709
|
+
*
|
|
710
|
+
*/
|
|
711
|
+
export interface AuthErrorResponse extends ErrorResponse {
|
|
712
|
+
/**
|
|
713
|
+
* Error code as per the [OAuth 2.0 specification](https://datatracker.ietf.org/doc/html/rfc6749#section-5.2). For example: `"access_denied"`.
|
|
714
|
+
*
|
|
715
|
+
*
|
|
716
|
+
*/
|
|
717
|
+
readonly error: string;
|
|
718
|
+
/**
|
|
719
|
+
* Plain text description of the first error.
|
|
720
|
+
*
|
|
721
|
+
*
|
|
722
|
+
*/
|
|
723
|
+
readonly error_description?: string;
|
|
724
|
+
/**
|
|
725
|
+
* Authentication and authorization-related errors returned for a request.
|
|
726
|
+
*
|
|
727
|
+
*/
|
|
728
|
+
readonly errors: ErrorObject[];
|
|
729
|
+
}
|
|
730
|
+
/**
|
|
731
|
+
* Returned when the response from the API Extension could not be parsed successfully (such as a `500` HTTP status code, or an invalid JSON response).
|
|
732
|
+
*
|
|
733
|
+
*/
|
|
734
|
+
export interface ExtensionBadResponseError {
|
|
735
|
+
readonly code: 'ExtensionBadResponse';
|
|
736
|
+
[key: string]: any;
|
|
737
|
+
/**
|
|
738
|
+
* Description of the invalid Extension response. For example, `"The extension did not return the expected JSON."`.
|
|
739
|
+
*
|
|
740
|
+
*
|
|
741
|
+
*/
|
|
742
|
+
readonly message: string;
|
|
743
|
+
/**
|
|
744
|
+
* User-defined localized description of the error.
|
|
745
|
+
*
|
|
746
|
+
*
|
|
747
|
+
*/
|
|
748
|
+
readonly localizedMessage?: LocalizedString;
|
|
749
|
+
/**
|
|
750
|
+
* Any information that should be returned to the API caller.
|
|
751
|
+
*
|
|
752
|
+
*
|
|
753
|
+
*/
|
|
754
|
+
readonly extensionExtraInfo?: any;
|
|
755
|
+
/**
|
|
756
|
+
* Additional errors related to the API Extension.
|
|
757
|
+
*
|
|
758
|
+
*
|
|
759
|
+
*/
|
|
760
|
+
readonly extensionErrors: ExtensionError[];
|
|
761
|
+
/**
|
|
762
|
+
* The response body returned by the Extension.
|
|
763
|
+
*
|
|
764
|
+
*/
|
|
765
|
+
readonly extensionBody?: string;
|
|
766
|
+
/**
|
|
767
|
+
* Http status code returned by the Extension.
|
|
768
|
+
*
|
|
769
|
+
*/
|
|
770
|
+
readonly extensionStatusCode?: number;
|
|
771
|
+
/**
|
|
772
|
+
* Unique identifier of the Extension.
|
|
773
|
+
*
|
|
774
|
+
*/
|
|
775
|
+
readonly extensionId: string;
|
|
776
|
+
/**
|
|
777
|
+
* User-defined unique identifier of the Extension.
|
|
778
|
+
*
|
|
779
|
+
*/
|
|
780
|
+
readonly extensionKey?: string;
|
|
781
|
+
}
|
|
782
|
+
export interface ExtensionError {
|
|
783
|
+
[key: string]: any;
|
|
784
|
+
/**
|
|
785
|
+
* Error code caused by the Extension. For example, `InvalidField`.
|
|
786
|
+
*
|
|
787
|
+
*
|
|
788
|
+
*/
|
|
789
|
+
readonly code: string;
|
|
790
|
+
/**
|
|
791
|
+
* Plain text description of the error.
|
|
792
|
+
*
|
|
793
|
+
*
|
|
794
|
+
*/
|
|
795
|
+
readonly message: string;
|
|
796
|
+
/**
|
|
797
|
+
* Unique identifier of the Extension.
|
|
798
|
+
*
|
|
799
|
+
*/
|
|
800
|
+
readonly extensionId: string;
|
|
801
|
+
/**
|
|
802
|
+
* User-defined unique identifier of the Extension.
|
|
803
|
+
*
|
|
804
|
+
*/
|
|
805
|
+
readonly extensionKey?: string;
|
|
806
|
+
}
|
|
807
|
+
/**
|
|
808
|
+
* Returned when the API Extension does not respond within the [time limit](/../api/projects/api-extensions#time-limits), or could not be reached.
|
|
809
|
+
*
|
|
810
|
+
*/
|
|
811
|
+
export interface ExtensionNoResponseError {
|
|
812
|
+
readonly code: 'ExtensionNoResponse';
|
|
813
|
+
[key: string]: any;
|
|
814
|
+
/**
|
|
815
|
+
* `"Extension did not respond in time."`
|
|
816
|
+
*
|
|
817
|
+
*
|
|
818
|
+
*/
|
|
819
|
+
readonly message: string;
|
|
820
|
+
/**
|
|
821
|
+
* Unique identifier of the API Extension.
|
|
822
|
+
*
|
|
823
|
+
*
|
|
824
|
+
*/
|
|
825
|
+
readonly extensionId: string;
|
|
826
|
+
/**
|
|
827
|
+
* User-defined unique identifier of the API Extension, if available.
|
|
828
|
+
*
|
|
829
|
+
*
|
|
830
|
+
*/
|
|
831
|
+
readonly extensionKey?: string;
|
|
832
|
+
}
|
|
833
|
+
/**
|
|
834
|
+
* Returned when the predicate defined in the [ExtensionTrigger](ctp:api:type:ExtensionTrigger) could not be evaluated due to a missing field.
|
|
835
|
+
*
|
|
836
|
+
*/
|
|
837
|
+
export interface ExtensionPredicateEvaluationFailedError {
|
|
838
|
+
readonly code: 'ExtensionPredicateEvaluationFailed';
|
|
839
|
+
[key: string]: any;
|
|
840
|
+
/**
|
|
841
|
+
* `"The compared field $fieldName is not present."`
|
|
842
|
+
*
|
|
843
|
+
*
|
|
844
|
+
*/
|
|
845
|
+
readonly message: string;
|
|
846
|
+
/**
|
|
847
|
+
* Details about the API Extension that was involved in the error.
|
|
848
|
+
*
|
|
849
|
+
*
|
|
850
|
+
*/
|
|
851
|
+
readonly errorByExtension: ErrorByExtension;
|
|
852
|
+
}
|
|
853
|
+
/**
|
|
854
|
+
* Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
|
|
855
|
+
* This would result in a [400 Bad Request](#400-bad-request) response if the same update action was sent from a regular client.
|
|
856
|
+
*
|
|
857
|
+
*/
|
|
858
|
+
export interface ExtensionUpdateActionsFailedError {
|
|
859
|
+
readonly code: 'ExtensionUpdateActionsFailed';
|
|
860
|
+
[key: string]: any;
|
|
861
|
+
/**
|
|
862
|
+
* `"The extension returned update actions that could not be executed."`
|
|
863
|
+
*
|
|
864
|
+
*
|
|
865
|
+
*/
|
|
866
|
+
readonly message: string;
|
|
867
|
+
/**
|
|
868
|
+
* User-defined localized description of the error.
|
|
869
|
+
*
|
|
870
|
+
*
|
|
871
|
+
*/
|
|
872
|
+
readonly localizedMessage?: LocalizedString;
|
|
873
|
+
/**
|
|
874
|
+
* Any information that should be returned to the API caller.
|
|
875
|
+
*
|
|
876
|
+
*
|
|
877
|
+
*/
|
|
878
|
+
readonly extensionExtraInfo?: any;
|
|
879
|
+
/**
|
|
880
|
+
* Additional errors related to the API Extension.
|
|
881
|
+
*
|
|
882
|
+
*
|
|
883
|
+
*/
|
|
884
|
+
readonly extensionErrors: ExtensionError[];
|
|
885
|
+
}
|
|
886
|
+
/**
|
|
887
|
+
* Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
|
|
888
|
+
*
|
|
889
|
+
*/
|
|
890
|
+
export interface ExternalOAuthFailedError {
|
|
891
|
+
readonly code: 'ExternalOAuthFailed';
|
|
892
|
+
[key: string]: any;
|
|
893
|
+
/**
|
|
894
|
+
* Plain text description detailing the external OAuth error. For example, `"External OAuth did not respond in time."`.
|
|
895
|
+
*
|
|
896
|
+
*
|
|
897
|
+
*/
|
|
898
|
+
readonly message: string;
|
|
899
|
+
}
|
|
900
|
+
/**
|
|
901
|
+
* Returned when the requested feature was removed.
|
|
902
|
+
*
|
|
903
|
+
*/
|
|
904
|
+
export interface FeatureRemovedError {
|
|
905
|
+
readonly code: 'FeatureRemoved';
|
|
906
|
+
[key: string]: any;
|
|
907
|
+
/**
|
|
908
|
+
* Description of the feature that is removed.
|
|
909
|
+
*
|
|
910
|
+
*
|
|
911
|
+
*/
|
|
912
|
+
readonly message: string;
|
|
913
|
+
}
|
|
914
|
+
/**
|
|
915
|
+
* Returned when a server-side problem occurs before or after data persistence. In some cases, the requested action may successfully complete after the error is returned. Therefore, it is recommended to verify the status of the requested resource after receiving a 500 error.
|
|
916
|
+
*
|
|
917
|
+
* If you encounter this error, report it to the [Composable Commerce support team](https://support.commercetools.com).
|
|
918
|
+
*
|
|
919
|
+
*/
|
|
920
|
+
export interface GeneralError {
|
|
921
|
+
readonly code: 'General';
|
|
922
|
+
[key: string]: any;
|
|
923
|
+
/**
|
|
924
|
+
* Description about any known details of the problem, for example, `"Write operations are temporarily unavailable"`.
|
|
925
|
+
*
|
|
926
|
+
*
|
|
927
|
+
*/
|
|
928
|
+
readonly message: string;
|
|
929
|
+
}
|
|
930
|
+
export interface InsufficientScopeError {
|
|
931
|
+
readonly code: 'insufficient_scope';
|
|
932
|
+
[key: string]: any;
|
|
933
|
+
/**
|
|
934
|
+
* Plain text description of the cause of the error.
|
|
935
|
+
*
|
|
936
|
+
*
|
|
937
|
+
*/
|
|
938
|
+
readonly message: string;
|
|
939
|
+
}
|
|
940
|
+
/**
|
|
941
|
+
* Returned when certain API-specific constraints were not met. For example, the specified [Discount Code](ctp:api:type:DiscountCode) was never applied and cannot be updated.
|
|
942
|
+
*
|
|
943
|
+
*/
|
|
944
|
+
export interface InternalConstraintViolatedError {
|
|
945
|
+
readonly code: 'InternalConstraintViolated';
|
|
946
|
+
[key: string]: any;
|
|
947
|
+
/**
|
|
948
|
+
* Plain text description of the constraints that were violated.
|
|
949
|
+
*
|
|
950
|
+
*/
|
|
951
|
+
readonly message: string;
|
|
952
|
+
}
|
|
953
|
+
/**
|
|
954
|
+
* Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
|
|
955
|
+
*
|
|
956
|
+
* The error is returned as a failed response to:
|
|
957
|
+
*
|
|
958
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers.
|
|
959
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile.
|
|
960
|
+
*
|
|
961
|
+
*/
|
|
962
|
+
export interface InvalidCredentialsError {
|
|
963
|
+
readonly code: 'InvalidCredentials';
|
|
964
|
+
[key: string]: any;
|
|
965
|
+
/**
|
|
966
|
+
* `"Account with the given credentials not found."`
|
|
967
|
+
*
|
|
968
|
+
*
|
|
969
|
+
*/
|
|
970
|
+
readonly message: string;
|
|
971
|
+
}
|
|
972
|
+
/**
|
|
973
|
+
* Returned when the current password of the Customer does not match.
|
|
974
|
+
*
|
|
975
|
+
* The error is returned as a failed response to:
|
|
976
|
+
*
|
|
977
|
+
* - [Change Customer Password](ctp:api:endpoint:/{projectKey}/customers/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) requests on Customers.
|
|
978
|
+
* - [Change Customer Password](ctp:api:endpoint:/{projectKey}/me/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/password:POST) requests on My Customer Profile.
|
|
979
|
+
*
|
|
980
|
+
*/
|
|
981
|
+
export interface InvalidCurrentPasswordError {
|
|
982
|
+
readonly code: 'InvalidCurrentPassword';
|
|
983
|
+
[key: string]: any;
|
|
984
|
+
/**
|
|
985
|
+
* `"The given current password does not match."`
|
|
986
|
+
*
|
|
987
|
+
*
|
|
988
|
+
*/
|
|
989
|
+
readonly message: string;
|
|
990
|
+
}
|
|
991
|
+
/**
|
|
992
|
+
* Returned when a field has an invalid value.
|
|
993
|
+
*
|
|
994
|
+
*/
|
|
995
|
+
export interface InvalidFieldError {
|
|
996
|
+
readonly code: 'InvalidField';
|
|
997
|
+
[key: string]: any;
|
|
998
|
+
/**
|
|
999
|
+
* `"The value $invalidValue is not valid for field $field."`
|
|
1000
|
+
*
|
|
1001
|
+
*
|
|
1002
|
+
*/
|
|
1003
|
+
readonly message: string;
|
|
1004
|
+
/**
|
|
1005
|
+
* Name of the field with the invalid value.
|
|
1006
|
+
*
|
|
1007
|
+
*
|
|
1008
|
+
*/
|
|
1009
|
+
readonly field: string;
|
|
1010
|
+
/**
|
|
1011
|
+
* Value invalid for the field.
|
|
1012
|
+
*
|
|
1013
|
+
*
|
|
1014
|
+
*/
|
|
1015
|
+
readonly invalidValue: any;
|
|
1016
|
+
/**
|
|
1017
|
+
* Fixed set of allowed values for the field, if any.
|
|
1018
|
+
*
|
|
1019
|
+
*
|
|
1020
|
+
*/
|
|
1021
|
+
readonly allowedValues?: any[];
|
|
1022
|
+
}
|
|
1023
|
+
/**
|
|
1024
|
+
* Returned when an invalid input has been sent.
|
|
1025
|
+
*
|
|
1026
|
+
*/
|
|
1027
|
+
export interface InvalidInputError {
|
|
1028
|
+
readonly code: 'InvalidInput';
|
|
1029
|
+
[key: string]: any;
|
|
1030
|
+
/**
|
|
1031
|
+
* Description of the constraints that are not met by the request. For example, `"Invalid $propertyName. It may be a non-empty string up to $maxLength"`.
|
|
1032
|
+
*
|
|
1033
|
+
*
|
|
1034
|
+
*/
|
|
1035
|
+
readonly message: string;
|
|
1036
|
+
}
|
|
1037
|
+
/**
|
|
1038
|
+
* Returned when Line Item or Custom Line Item quantities set under [ItemShippingDetails](ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details.
|
|
1039
|
+
*
|
|
1040
|
+
* When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction).
|
|
1041
|
+
*
|
|
1042
|
+
* The error is also returned as a failed response to:
|
|
1043
|
+
*
|
|
1044
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:CartAddShoppingListAction), and [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) update actions on Carts.
|
|
1045
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests, and [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction), and [Remove LineItem](ctp:api:type:MyCartRemoveLineItemAction) update actions on My Carts.
|
|
1046
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts.
|
|
1047
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders.
|
|
1048
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
1049
|
+
* - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:StagedOrderAddShoppingListAction), and [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update actions on Order Edits.
|
|
1050
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders.
|
|
1051
|
+
*
|
|
1052
|
+
*/
|
|
1053
|
+
export interface InvalidItemShippingDetailsError {
|
|
1054
|
+
readonly code: 'InvalidItemShippingDetails';
|
|
1055
|
+
[key: string]: any;
|
|
1056
|
+
/**
|
|
1057
|
+
* `"Inconsistent shipping details for $subject with ID $itemId. $subject quantity is $itemQuantity and shippingTargets quantity sum is $quantitySum."`
|
|
1058
|
+
*
|
|
1059
|
+
*
|
|
1060
|
+
*/
|
|
1061
|
+
readonly message: string;
|
|
1062
|
+
/**
|
|
1063
|
+
* `"LineItem"` or `"CustomLineItem"`
|
|
1064
|
+
*
|
|
1065
|
+
*
|
|
1066
|
+
*/
|
|
1067
|
+
readonly subject: string;
|
|
1068
|
+
/**
|
|
1069
|
+
* Unique identifier of the Line Item or Custom Line Item.
|
|
1070
|
+
*
|
|
1071
|
+
*
|
|
1072
|
+
*/
|
|
1073
|
+
readonly itemId: string;
|
|
1074
|
+
}
|
|
1075
|
+
/**
|
|
1076
|
+
* Returned when an invalid JSON input has been sent.
|
|
1077
|
+
* Either the JSON is syntactically incorrect or does not conform to the expected shape (for example is missing a required field).
|
|
1078
|
+
*
|
|
1079
|
+
* The client application should validate the input according to the constraints described in the error message before sending the request.
|
|
1080
|
+
*
|
|
1081
|
+
*/
|
|
1082
|
+
export interface InvalidJsonInputError {
|
|
1083
|
+
readonly code: 'InvalidJsonInput';
|
|
1084
|
+
[key: string]: any;
|
|
1085
|
+
/**
|
|
1086
|
+
* `"Request body does not contain valid JSON."`
|
|
1087
|
+
*
|
|
1088
|
+
*
|
|
1089
|
+
*/
|
|
1090
|
+
readonly message: string;
|
|
1091
|
+
/**
|
|
1092
|
+
* Further explanation about why the JSON is invalid.
|
|
1093
|
+
*
|
|
1094
|
+
*/
|
|
1095
|
+
readonly detailedErrorMessage: string;
|
|
1096
|
+
}
|
|
1097
|
+
/**
|
|
1098
|
+
* Returned when the resources involved in the request are not in a valid state for the operation.
|
|
1099
|
+
*
|
|
1100
|
+
* The client application should validate the constraints described in the error message before sending the request.
|
|
1101
|
+
*
|
|
1102
|
+
*/
|
|
1103
|
+
export interface InvalidOperationError {
|
|
1104
|
+
readonly code: 'InvalidOperation';
|
|
1105
|
+
[key: string]: any;
|
|
1106
|
+
/**
|
|
1107
|
+
* Plain text description of the error.
|
|
1108
|
+
*
|
|
1109
|
+
*
|
|
1110
|
+
*/
|
|
1111
|
+
readonly message: string;
|
|
1112
|
+
}
|
|
1113
|
+
export interface InvalidSubjectError {
|
|
1114
|
+
readonly code: 'InvalidSubject';
|
|
1115
|
+
[key: string]: any;
|
|
1116
|
+
/**
|
|
1117
|
+
* Plain text description of the cause of the error.
|
|
1118
|
+
*
|
|
1119
|
+
*
|
|
1120
|
+
*/
|
|
1121
|
+
readonly message: string;
|
|
1122
|
+
}
|
|
1123
|
+
export interface InvalidTokenError {
|
|
1124
|
+
readonly code: 'invalid_token';
|
|
1125
|
+
[key: string]: any;
|
|
1126
|
+
/**
|
|
1127
|
+
* Plain text description of the cause of the error.
|
|
1128
|
+
*
|
|
1129
|
+
*
|
|
1130
|
+
*/
|
|
1131
|
+
readonly message: string;
|
|
1132
|
+
}
|
|
1133
|
+
/**
|
|
1134
|
+
* Returned when a language cannot be removed from a Project as it is being used by a Store.
|
|
1135
|
+
*
|
|
1136
|
+
* The error is returned as a failed response to the [Change Languages](ctp:api:type:ProjectChangeLanguagesAction) update action.
|
|
1137
|
+
*
|
|
1138
|
+
*/
|
|
1139
|
+
export interface LanguageUsedInStoresError {
|
|
1140
|
+
readonly code: 'LanguageUsedInStores';
|
|
1141
|
+
[key: string]: any;
|
|
1142
|
+
/**
|
|
1143
|
+
* `"Language(s) in use by a store cannot be deleted. Remove them in all the stores of this project first."`
|
|
1144
|
+
*
|
|
1145
|
+
*
|
|
1146
|
+
*/
|
|
1147
|
+
readonly message: string;
|
|
1148
|
+
}
|
|
1149
|
+
/**
|
|
1150
|
+
* Returned when two [Customers](ctp:api:type:Customer) are simultaneously created or updated with the same email address.
|
|
1151
|
+
*
|
|
1152
|
+
* To confirm if the operation was successful, repeat the request.
|
|
1153
|
+
*
|
|
1154
|
+
*/
|
|
1155
|
+
export interface LockedFieldError {
|
|
1156
|
+
readonly code: 'LockedField';
|
|
1157
|
+
[key: string]: any;
|
|
1158
|
+
/**
|
|
1159
|
+
* `"'$field' is locked by another request. Please try again later."`
|
|
1160
|
+
*
|
|
1161
|
+
*
|
|
1162
|
+
*/
|
|
1163
|
+
readonly message: string;
|
|
1164
|
+
/**
|
|
1165
|
+
* Field that is currently locked.
|
|
1166
|
+
*
|
|
1167
|
+
*
|
|
1168
|
+
*/
|
|
1169
|
+
readonly field: string;
|
|
1170
|
+
}
|
|
1171
|
+
/**
|
|
1172
|
+
* Returned when the Product Variant does not have a Price according to the [Product](ctp:api:type:Product) `priceMode` value for a selected currency, country, Customer Group, or Channel.
|
|
1173
|
+
*
|
|
1174
|
+
* The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction).
|
|
1175
|
+
*
|
|
1176
|
+
* The error is also returned as a failed response to:
|
|
1177
|
+
*
|
|
1178
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers.
|
|
1179
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile.
|
|
1180
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts.
|
|
1181
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts.
|
|
1182
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts.
|
|
1183
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
1184
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
1185
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
1186
|
+
*
|
|
1187
|
+
*/
|
|
1188
|
+
export interface MatchingPriceNotFoundError {
|
|
1189
|
+
readonly code: 'MatchingPriceNotFound';
|
|
1190
|
+
[key: string]: any;
|
|
1191
|
+
/**
|
|
1192
|
+
* `"The variant $variantId of product $productId does not contain a price for currency $currencyCode, $country, $customerGroup, $channel."`
|
|
1193
|
+
*
|
|
1194
|
+
*
|
|
1195
|
+
*/
|
|
1196
|
+
readonly message: string;
|
|
1197
|
+
/**
|
|
1198
|
+
* Unique identifier of a [Product](ctp:api:type:Product).
|
|
1199
|
+
*
|
|
1200
|
+
*
|
|
1201
|
+
*/
|
|
1202
|
+
readonly productId: string;
|
|
1203
|
+
/**
|
|
1204
|
+
* Unique identifier of a [ProductVariant](ctp:api:type:ProductVariant) in the Product.
|
|
1205
|
+
*
|
|
1206
|
+
*
|
|
1207
|
+
*/
|
|
1208
|
+
readonly variantId: number;
|
|
1209
|
+
/**
|
|
1210
|
+
* Currency code of the country.
|
|
1211
|
+
*
|
|
1212
|
+
*
|
|
1213
|
+
*/
|
|
1214
|
+
readonly currency?: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* Country code of the geographic location.
|
|
1217
|
+
*
|
|
1218
|
+
*
|
|
1219
|
+
*/
|
|
1220
|
+
readonly country?: string;
|
|
1221
|
+
/**
|
|
1222
|
+
* Customer Group associated with the Price.
|
|
1223
|
+
*
|
|
1224
|
+
*
|
|
1225
|
+
*/
|
|
1226
|
+
readonly customerGroup?: CustomerGroupReference;
|
|
1227
|
+
/**
|
|
1228
|
+
* Channel associated with the Price.
|
|
1229
|
+
*
|
|
1230
|
+
*
|
|
1231
|
+
*/
|
|
1232
|
+
readonly channel?: ChannelReference;
|
|
1233
|
+
}
|
|
1234
|
+
/**
|
|
1235
|
+
* Returned when a Cart Discount cannot be created or activated as the [limit](/../api/limits#cart-discounts) for active Cart Discounts has been reached.
|
|
1236
|
+
*
|
|
1237
|
+
* The error is returned as a failed response to:
|
|
1238
|
+
*
|
|
1239
|
+
* - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests
|
|
1240
|
+
* - [Change IsActive](ctp:api:type:CartDiscountChangeIsActiveAction) update action
|
|
1241
|
+
*
|
|
1242
|
+
*/
|
|
1243
|
+
export interface MaxCartDiscountsReachedError {
|
|
1244
|
+
readonly code: 'MaxCartDiscountsReached';
|
|
1245
|
+
[key: string]: any;
|
|
1246
|
+
/**
|
|
1247
|
+
* `"Maximum number of active cart discounts reached ($max)."`
|
|
1248
|
+
*
|
|
1249
|
+
*
|
|
1250
|
+
*/
|
|
1251
|
+
readonly message: string;
|
|
1252
|
+
}
|
|
1253
|
+
/**
|
|
1254
|
+
* Returned when a resource type cannot be created as it has reached its [limits](/../api/limits).
|
|
1255
|
+
*
|
|
1256
|
+
* The limits must be adjusted for this resource before sending the request again.
|
|
1257
|
+
*
|
|
1258
|
+
*/
|
|
1259
|
+
export interface MaxResourceLimitExceededError {
|
|
1260
|
+
readonly code: 'MaxResourceLimitExceeded';
|
|
1261
|
+
[key: string]: any;
|
|
1262
|
+
/**
|
|
1263
|
+
* `"You have exceeded the limit of $limit resources of type $resourceTypeId."`
|
|
1264
|
+
*
|
|
1265
|
+
*
|
|
1266
|
+
*/
|
|
1267
|
+
readonly message: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).
|
|
1270
|
+
*
|
|
1271
|
+
*
|
|
1272
|
+
*/
|
|
1273
|
+
readonly exceededResource: ReferenceTypeId;
|
|
1274
|
+
}
|
|
1275
|
+
/**
|
|
1276
|
+
* Returned when a Store cannot be added to a Cart Discount as the [limit](/../api/limits#cart-discounts-stores) for Stores configured for a Cart Discount has been reached.
|
|
1277
|
+
*
|
|
1278
|
+
* The error is returned as a failed response to:
|
|
1279
|
+
*
|
|
1280
|
+
* - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests
|
|
1281
|
+
* - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions
|
|
1282
|
+
*
|
|
1283
|
+
*/
|
|
1284
|
+
export interface MaxStoreReferencesReachedError {
|
|
1285
|
+
readonly code: 'MaxStoreReferencesReached';
|
|
1286
|
+
[key: string]: any;
|
|
1287
|
+
/**
|
|
1288
|
+
* `"Maximum number of store discounts on a single cart discount reached $max".`
|
|
1289
|
+
*
|
|
1290
|
+
*
|
|
1291
|
+
*/
|
|
1292
|
+
readonly message: string;
|
|
1293
|
+
}
|
|
1294
|
+
/**
|
|
1295
|
+
* Returned when one of the following states occur:
|
|
1296
|
+
*
|
|
1297
|
+
* - [Channel](ctp:api:type:Channel) is added or set on a [Store](ctp:api:type:Store) with missing Channel `roles`.
|
|
1298
|
+
* - [Standalone Price](ctp:api:type:StandalonePrice) references a Channel that does not contain the `ProductDistribution` role.
|
|
1299
|
+
*
|
|
1300
|
+
* The error is returned as a failed response to:
|
|
1301
|
+
*
|
|
1302
|
+
* - [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), [Set Distribution Channel](ctp:api:type:StoreSetDistributionChannelsAction), [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), and [Set Supply Channel](ctp:api:type:StoreSetSupplyChannelsAction) update actions.
|
|
1303
|
+
* - [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
|
|
1304
|
+
*
|
|
1305
|
+
*/
|
|
1306
|
+
export interface MissingRoleOnChannelError {
|
|
1307
|
+
readonly code: 'MissingRoleOnChannel';
|
|
1308
|
+
[key: string]: any;
|
|
1309
|
+
/**
|
|
1310
|
+
* `"Given channel with $idOrKeyOfChannel does not have the required role $role."`
|
|
1311
|
+
*
|
|
1312
|
+
*
|
|
1313
|
+
*/
|
|
1314
|
+
readonly message: string;
|
|
1315
|
+
/**
|
|
1316
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a given [Channel](ctp:api:type:Channel).
|
|
1317
|
+
*
|
|
1318
|
+
*
|
|
1319
|
+
*/
|
|
1320
|
+
readonly channel?: ChannelResourceIdentifier;
|
|
1321
|
+
/**
|
|
1322
|
+
* - `ProductDistribution` for Product Distribution Channels allowed for the Store. Also required for [Standalone Prices](ctp:api:type:StandalonePrice).
|
|
1323
|
+
* - `InventorySupply` for Inventory Supply Channels allowed for the Store.
|
|
1324
|
+
*
|
|
1325
|
+
*
|
|
1326
|
+
*/
|
|
1327
|
+
readonly missingRole: ChannelRoleEnum;
|
|
1328
|
+
}
|
|
1329
|
+
/**
|
|
1330
|
+
* Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the [Cart](ctp:api:type:Cart) is missing the [TaxRate](ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart.
|
|
1331
|
+
*
|
|
1332
|
+
* The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction).
|
|
1333
|
+
*
|
|
1334
|
+
* The error is also returned as a failed response to:
|
|
1335
|
+
*
|
|
1336
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers.
|
|
1337
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) on My Customer Profile.
|
|
1338
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts.
|
|
1339
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts.
|
|
1340
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts.
|
|
1341
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
1342
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
1343
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) requests on Associate Orders.
|
|
1344
|
+
*
|
|
1345
|
+
*/
|
|
1346
|
+
export interface MissingTaxRateForCountryError {
|
|
1347
|
+
readonly code: 'MissingTaxRateForCountry';
|
|
1348
|
+
[key: string]: any;
|
|
1349
|
+
/**
|
|
1350
|
+
* `"Tax category $taxCategoryId is missing a tax rate for country $countriesAndStates."`
|
|
1351
|
+
*
|
|
1352
|
+
*
|
|
1353
|
+
*/
|
|
1354
|
+
readonly message: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* Unique identifier of the [TaxCategory](ctp:api:type:TaxCategory).
|
|
1357
|
+
*
|
|
1358
|
+
*
|
|
1359
|
+
*/
|
|
1360
|
+
readonly taxCategoryId: string;
|
|
1361
|
+
/**
|
|
1362
|
+
* Country code of the geographic location.
|
|
1363
|
+
*
|
|
1364
|
+
*
|
|
1365
|
+
*/
|
|
1366
|
+
readonly country?: string;
|
|
1367
|
+
/**
|
|
1368
|
+
* State within the country, such as Texas in the United States.
|
|
1369
|
+
*
|
|
1370
|
+
*
|
|
1371
|
+
*/
|
|
1372
|
+
readonly state?: string;
|
|
1373
|
+
}
|
|
1374
|
+
/**
|
|
1375
|
+
* Returned when a [Money](ctp:api:type:Money) operation overflows the 64-bit integer range.
|
|
1376
|
+
* See [Money usage](/types#usage) for more information.
|
|
1377
|
+
*
|
|
1378
|
+
*/
|
|
1379
|
+
export interface MoneyOverflowError {
|
|
1380
|
+
readonly code: 'MoneyOverflow';
|
|
1381
|
+
[key: string]: any;
|
|
1382
|
+
/**
|
|
1383
|
+
* `"A Money operation resulted in an overflow."`
|
|
1384
|
+
*
|
|
1385
|
+
*
|
|
1386
|
+
*/
|
|
1387
|
+
readonly message: string;
|
|
1388
|
+
}
|
|
1389
|
+
/**
|
|
1390
|
+
* Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
|
|
1391
|
+
*
|
|
1392
|
+
* The error is returned as a failed response to the [Get Matching ProductDiscount](ctp:api:endpoint:/{projectKey}/product-discounts/matching:POST) request.
|
|
1393
|
+
*
|
|
1394
|
+
*/
|
|
1395
|
+
export interface NoMatchingProductDiscountFoundError {
|
|
1396
|
+
readonly code: 'NoMatchingProductDiscountFound';
|
|
1397
|
+
[key: string]: any;
|
|
1398
|
+
/**
|
|
1399
|
+
* `"Couldn't find a matching product discount for: productId=$productId, variantId=$variantId, price=$price."`
|
|
1400
|
+
*
|
|
1401
|
+
*
|
|
1402
|
+
*/
|
|
1403
|
+
readonly message: string;
|
|
1404
|
+
}
|
|
1405
|
+
/**
|
|
1406
|
+
* Returned when the requested resource was not found.
|
|
1407
|
+
*
|
|
1408
|
+
*/
|
|
1409
|
+
export interface ObjectNotFoundError {
|
|
1410
|
+
readonly code: 'ObjectNotFound';
|
|
1411
|
+
[key: string]: any;
|
|
1412
|
+
/**
|
|
1413
|
+
* `"A $resourceType with identifier $id was unexpectedly not found."`
|
|
1414
|
+
*
|
|
1415
|
+
*
|
|
1416
|
+
*/
|
|
1417
|
+
readonly message: string;
|
|
1418
|
+
}
|
|
1419
|
+
/**
|
|
1420
|
+
* Returned when some of the [Line Items](ctp:api:type:LineItem) are out of stock at the time of placing an [Order](ctp:api:type:Order).
|
|
1421
|
+
*
|
|
1422
|
+
* The error is returned as a failed response to:
|
|
1423
|
+
*
|
|
1424
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders.
|
|
1425
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
1426
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders.
|
|
1427
|
+
*
|
|
1428
|
+
*/
|
|
1429
|
+
export interface OutOfStockError {
|
|
1430
|
+
readonly code: 'OutOfStock';
|
|
1431
|
+
[key: string]: any;
|
|
1432
|
+
/**
|
|
1433
|
+
* `"Some line items are out of stock at the time of placing the order: $itemSku."`
|
|
1434
|
+
*
|
|
1435
|
+
*
|
|
1436
|
+
*/
|
|
1437
|
+
readonly message: string;
|
|
1438
|
+
/**
|
|
1439
|
+
* Unique identifiers of the Line Items that are out of stock.
|
|
1440
|
+
*
|
|
1441
|
+
*
|
|
1442
|
+
*/
|
|
1443
|
+
readonly lineItems: string[];
|
|
1444
|
+
/**
|
|
1445
|
+
* SKUs of the Line Items that are out of stock.
|
|
1446
|
+
*
|
|
1447
|
+
*
|
|
1448
|
+
*/
|
|
1449
|
+
readonly skus: string[];
|
|
1450
|
+
}
|
|
1451
|
+
/**
|
|
1452
|
+
* Returned when the service is having trouble handling the load.
|
|
1453
|
+
*
|
|
1454
|
+
* The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.
|
|
1455
|
+
*
|
|
1456
|
+
*/
|
|
1457
|
+
export interface OverCapacityError {
|
|
1458
|
+
readonly code: 'OverCapacity';
|
|
1459
|
+
[key: string]: any;
|
|
1460
|
+
/**
|
|
1461
|
+
* Plain text description of the error.
|
|
1462
|
+
*
|
|
1463
|
+
*/
|
|
1464
|
+
readonly message: string;
|
|
1465
|
+
}
|
|
1466
|
+
/**
|
|
1467
|
+
* Returned when a given Price validity period conflicts with an existing one.
|
|
1468
|
+
* Every Standalone Price associated with the same SKU and with the same combination of currency, country, Customer Group, and Channel, must have non-overlapping validity periods (`validFrom` and `validUntil`).
|
|
1469
|
+
*
|
|
1470
|
+
* The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
|
|
1471
|
+
*
|
|
1472
|
+
*/
|
|
1473
|
+
export interface OverlappingStandalonePriceValidityError {
|
|
1474
|
+
readonly code: 'OverlappingStandalonePriceValidity';
|
|
1475
|
+
[key: string]: any;
|
|
1476
|
+
/**
|
|
1477
|
+
* `Two standalone prices have overlapping validity periods."`
|
|
1478
|
+
*
|
|
1479
|
+
*
|
|
1480
|
+
*/
|
|
1481
|
+
readonly message: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* Reference to the conflicting Standalone Price.
|
|
1484
|
+
*
|
|
1485
|
+
*
|
|
1486
|
+
*/
|
|
1487
|
+
readonly conflictingStandalonePrice: StandalonePriceReference;
|
|
1488
|
+
/**
|
|
1489
|
+
* SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
|
|
1490
|
+
*
|
|
1491
|
+
*
|
|
1492
|
+
*/
|
|
1493
|
+
readonly sku: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Currency code of the country.
|
|
1496
|
+
*
|
|
1497
|
+
*
|
|
1498
|
+
*/
|
|
1499
|
+
readonly currency: string;
|
|
1500
|
+
/**
|
|
1501
|
+
* Country code of the geographic location.
|
|
1502
|
+
*
|
|
1503
|
+
*
|
|
1504
|
+
*/
|
|
1505
|
+
readonly country?: string;
|
|
1506
|
+
/**
|
|
1507
|
+
* [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
|
|
1508
|
+
*
|
|
1509
|
+
*
|
|
1510
|
+
*/
|
|
1511
|
+
readonly customerGroup?: CustomerGroupResourceIdentifier;
|
|
1512
|
+
/**
|
|
1513
|
+
* [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
|
|
1514
|
+
*
|
|
1515
|
+
*
|
|
1516
|
+
*/
|
|
1517
|
+
readonly channel?: ChannelResourceIdentifier;
|
|
1518
|
+
/**
|
|
1519
|
+
* Date and time (UTC) from which the Standalone Price is valid.
|
|
1520
|
+
*
|
|
1521
|
+
*
|
|
1522
|
+
*/
|
|
1523
|
+
readonly validFrom?: string;
|
|
1524
|
+
/**
|
|
1525
|
+
* Date and time (UTC) until which the Standalone Price is valid.
|
|
1526
|
+
*
|
|
1527
|
+
*
|
|
1528
|
+
*/
|
|
1529
|
+
readonly validUntil?: string;
|
|
1530
|
+
/**
|
|
1531
|
+
* Date and time (UTC) from which the conflicting Standalone Price is valid.
|
|
1532
|
+
*
|
|
1533
|
+
*
|
|
1534
|
+
*/
|
|
1535
|
+
readonly conflictingValidFrom?: string;
|
|
1536
|
+
/**
|
|
1537
|
+
* Date and time (UTC) until which the conflicting Standalone Price is valid.
|
|
1538
|
+
*
|
|
1539
|
+
*
|
|
1540
|
+
*/
|
|
1541
|
+
readonly conflictingValidUntil?: string;
|
|
1542
|
+
}
|
|
1543
|
+
/**
|
|
1544
|
+
* Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
|
|
1545
|
+
*
|
|
1546
|
+
* The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.
|
|
1547
|
+
* If the error persists, report it to the [Composable Commerce support team](https://support.commercetools.com).
|
|
1548
|
+
*
|
|
1549
|
+
*/
|
|
1550
|
+
export interface PendingOperationError {
|
|
1551
|
+
readonly code: 'PendingOperation';
|
|
1552
|
+
[key: string]: any;
|
|
1553
|
+
/**
|
|
1554
|
+
* Plain text description of the error.
|
|
1555
|
+
*
|
|
1556
|
+
*/
|
|
1557
|
+
readonly message: string;
|
|
1558
|
+
}
|
|
1559
|
+
/**
|
|
1560
|
+
* Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart.
|
|
1561
|
+
*
|
|
1562
|
+
* When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction).
|
|
1563
|
+
*
|
|
1564
|
+
* The error is also returned as a failed response to:
|
|
1565
|
+
*
|
|
1566
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders.
|
|
1567
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
1568
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
1569
|
+
*
|
|
1570
|
+
*/
|
|
1571
|
+
export interface PriceChangedError {
|
|
1572
|
+
readonly code: 'PriceChanged';
|
|
1573
|
+
[key: string]: any;
|
|
1574
|
+
/**
|
|
1575
|
+
* Plain text description of the reason for the Price change. For example, `"The price or tax of some line items changed at the time of placing the order: $lineItems."`.
|
|
1576
|
+
*
|
|
1577
|
+
*
|
|
1578
|
+
*/
|
|
1579
|
+
readonly message: string;
|
|
1580
|
+
/**
|
|
1581
|
+
* Unique identifiers of the Line Items for which the Price or [TaxRate](ctp:api:type:TaxRate) has changed.
|
|
1582
|
+
*
|
|
1583
|
+
*
|
|
1584
|
+
*/
|
|
1585
|
+
readonly lineItems: string[];
|
|
1586
|
+
/**
|
|
1587
|
+
* `true` if the [ShippingRate](ctp:api:type:ShippingRate) has changed.
|
|
1588
|
+
*
|
|
1589
|
+
*
|
|
1590
|
+
*/
|
|
1591
|
+
readonly shipping: boolean;
|
|
1592
|
+
}
|
|
1593
|
+
/**
|
|
1594
|
+
* Returned when a Product is not assigned to the Product Selection.
|
|
1595
|
+
* The error is returned as a failed response either to the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) or to the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
|
|
1596
|
+
*
|
|
1597
|
+
*/
|
|
1598
|
+
export interface ProductAssignmentMissingError {
|
|
1599
|
+
readonly code: 'ProductAssignmentMissing';
|
|
1600
|
+
[key: string]: any;
|
|
1601
|
+
/**
|
|
1602
|
+
* For Product Selection of mode Individual, the message is:
|
|
1603
|
+
* `"A Product Variant Selection can only be set for a Product that has previously been added to the Product Selection."`
|
|
1604
|
+
* For Product Selection of mode IndividualExclusion, the message is:
|
|
1605
|
+
* `"A Variant Exclusion can only be set for a Product that has previously been added to the Product Selection of type Individual Exclusion."`
|
|
1606
|
+
*
|
|
1607
|
+
*
|
|
1608
|
+
*/
|
|
1609
|
+
readonly message: string;
|
|
1610
|
+
/**
|
|
1611
|
+
* [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
|
|
1612
|
+
*
|
|
1613
|
+
*
|
|
1614
|
+
*/
|
|
1615
|
+
readonly product: ProductReference;
|
|
1616
|
+
}
|
|
1617
|
+
/**
|
|
1618
|
+
* Returned when a Product is already assigned to a [Product Selection](/../api/projects/product-selections), but the Product Selection has either a different [Product Variant Selection](ctp:api:type:ProductVariantSelection) or a different [Product Variant Exclusion](ctp:api:type:ProductVariantExclusion).
|
|
1619
|
+
*
|
|
1620
|
+
* The error is returned as a failed response either to the [Add Product](ctp:api:type:ProductSelectionAddProductAction) or to the [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action.
|
|
1621
|
+
*
|
|
1622
|
+
*/
|
|
1623
|
+
export interface ProductPresentWithDifferentVariantSelectionError {
|
|
1624
|
+
readonly code: 'ProductPresentWithDifferentVariantSelection';
|
|
1625
|
+
[key: string]: any;
|
|
1626
|
+
/**
|
|
1627
|
+
* `"Product is already present with the following different $variantSelections."`
|
|
1628
|
+
*
|
|
1629
|
+
*
|
|
1630
|
+
*/
|
|
1631
|
+
readonly message: string;
|
|
1632
|
+
/**
|
|
1633
|
+
* [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
|
|
1634
|
+
*
|
|
1635
|
+
*
|
|
1636
|
+
*/
|
|
1637
|
+
readonly product: ProductReference;
|
|
1638
|
+
/**
|
|
1639
|
+
* Existing Product Variant Selection or Exclusion for the [Product](/../api/projects/products) in the [Product Selection](/../api/projects/product-selections).
|
|
1640
|
+
*
|
|
1641
|
+
*
|
|
1642
|
+
*/
|
|
1643
|
+
readonly existingVariantSelection: ProductVariantSelection;
|
|
1644
|
+
}
|
|
1645
|
+
/**
|
|
1646
|
+
* Returned when the languages set for a Store are not supported by the Project.
|
|
1647
|
+
*
|
|
1648
|
+
* The error is returned as a failed response to the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
|
|
1649
|
+
*
|
|
1650
|
+
*/
|
|
1651
|
+
export interface ProjectNotConfiguredForLanguagesError {
|
|
1652
|
+
readonly code: 'ProjectNotConfiguredForLanguages';
|
|
1653
|
+
[key: string]: any;
|
|
1654
|
+
/**
|
|
1655
|
+
* `"The project is not configured for given languages."`
|
|
1656
|
+
*
|
|
1657
|
+
*
|
|
1658
|
+
*/
|
|
1659
|
+
readonly message: string;
|
|
1660
|
+
/**
|
|
1661
|
+
* Languages configured for the Store.
|
|
1662
|
+
*
|
|
1663
|
+
*
|
|
1664
|
+
*/
|
|
1665
|
+
readonly languages?: string[];
|
|
1666
|
+
}
|
|
1667
|
+
export interface QueryComplexityLimitExceededError {
|
|
1668
|
+
readonly code: 'QueryComplexityLimitExceeded';
|
|
1669
|
+
[key: string]: any;
|
|
1670
|
+
/**
|
|
1671
|
+
*
|
|
1672
|
+
*/
|
|
1673
|
+
readonly message: string;
|
|
1674
|
+
}
|
|
1675
|
+
/**
|
|
1676
|
+
* Returned when the query times out.
|
|
1677
|
+
*
|
|
1678
|
+
* If a query constantly times out, please check if it follows the [performance best practices](/../api/predicates/query#performance-considerations).
|
|
1679
|
+
*
|
|
1680
|
+
*/
|
|
1681
|
+
export interface QueryTimedOutError {
|
|
1682
|
+
readonly code: 'QueryTimedOut';
|
|
1683
|
+
[key: string]: any;
|
|
1684
|
+
/**
|
|
1685
|
+
* `"The query timed out. If your query constantly times out, please check that it follows the performance best practices (see https://docs.commercetools.com/api/predicates/query#performance-considerations)."`
|
|
1686
|
+
*
|
|
1687
|
+
*
|
|
1688
|
+
*/
|
|
1689
|
+
readonly message: string;
|
|
1690
|
+
}
|
|
1691
|
+
/**
|
|
1692
|
+
* Returned when a resource cannot be deleted because it is being referenced by another resource.
|
|
1693
|
+
*
|
|
1694
|
+
*/
|
|
1695
|
+
export interface ReferenceExistsError {
|
|
1696
|
+
readonly code: 'ReferenceExists';
|
|
1697
|
+
[key: string]: any;
|
|
1698
|
+
/**
|
|
1699
|
+
* `"Can not delete a $resource while it is referenced by at least one $referencedBy."`
|
|
1700
|
+
*
|
|
1701
|
+
*
|
|
1702
|
+
*/
|
|
1703
|
+
readonly message: string;
|
|
1704
|
+
/**
|
|
1705
|
+
* Type of referenced resource.
|
|
1706
|
+
*
|
|
1707
|
+
*
|
|
1708
|
+
*/
|
|
1709
|
+
readonly referencedBy?: ReferenceTypeId;
|
|
1710
|
+
}
|
|
1711
|
+
/**
|
|
1712
|
+
* Returned when a resource referenced by a [Reference](ctp:api:type:Reference) or a [ResourceIdentifier](ctp:api:type:ResourceIdentifier) could not be found.
|
|
1713
|
+
*
|
|
1714
|
+
*/
|
|
1715
|
+
export interface ReferencedResourceNotFoundError {
|
|
1716
|
+
readonly code: 'ReferencedResourceNotFound';
|
|
1717
|
+
[key: string]: any;
|
|
1718
|
+
/**
|
|
1719
|
+
* `"The referenced object of type $typeId $predicate was not found. It either doesn't exist, or it can't be accessed from this endpoint (e.g., if the endpoint filters by store or customer account)."`
|
|
1720
|
+
*
|
|
1721
|
+
*
|
|
1722
|
+
*/
|
|
1723
|
+
readonly message: string;
|
|
1724
|
+
/**
|
|
1725
|
+
* Type of referenced resource.
|
|
1726
|
+
*
|
|
1727
|
+
*
|
|
1728
|
+
*/
|
|
1729
|
+
readonly typeId: ReferenceTypeId;
|
|
1730
|
+
/**
|
|
1731
|
+
* Unique identifier of the referenced resource, if known.
|
|
1732
|
+
*
|
|
1733
|
+
*
|
|
1734
|
+
*/
|
|
1735
|
+
readonly id?: string;
|
|
1736
|
+
/**
|
|
1737
|
+
* User-defined unique identifier of the referenced resource, if known.
|
|
1738
|
+
*
|
|
1739
|
+
*
|
|
1740
|
+
*/
|
|
1741
|
+
readonly key?: string;
|
|
1742
|
+
}
|
|
1743
|
+
/**
|
|
1744
|
+
* Returned when a value is not defined for a required field.
|
|
1745
|
+
*
|
|
1746
|
+
*/
|
|
1747
|
+
export interface RequiredFieldError {
|
|
1748
|
+
readonly code: 'RequiredField';
|
|
1749
|
+
[key: string]: any;
|
|
1750
|
+
/**
|
|
1751
|
+
* `"A value is required for field $field."`
|
|
1752
|
+
*
|
|
1753
|
+
*
|
|
1754
|
+
*/
|
|
1755
|
+
readonly message: string;
|
|
1756
|
+
/**
|
|
1757
|
+
* Name of the field missing the value.
|
|
1758
|
+
*
|
|
1759
|
+
*
|
|
1760
|
+
*/
|
|
1761
|
+
readonly field: string;
|
|
1762
|
+
}
|
|
1763
|
+
/**
|
|
1764
|
+
* Returned when the resource addressed by the request URL does not exist.
|
|
1765
|
+
*
|
|
1766
|
+
*/
|
|
1767
|
+
export interface ResourceNotFoundError {
|
|
1768
|
+
readonly code: 'ResourceNotFound';
|
|
1769
|
+
[key: string]: any;
|
|
1770
|
+
/**
|
|
1771
|
+
* `"The Resource with ID $resourceId was not found."`
|
|
1772
|
+
*
|
|
1773
|
+
*
|
|
1774
|
+
*/
|
|
1775
|
+
readonly message: string;
|
|
1776
|
+
}
|
|
1777
|
+
/**
|
|
1778
|
+
* Returned when the resource exceeds the maximum allowed size of 16 MB.
|
|
1779
|
+
*
|
|
1780
|
+
*/
|
|
1781
|
+
export interface ResourceSizeLimitExceededError {
|
|
1782
|
+
readonly code: 'ResourceSizeLimitExceeded';
|
|
1783
|
+
[key: string]: any;
|
|
1784
|
+
/**
|
|
1785
|
+
* `"The resource size exceeds the maximal allowed size of 16 MB."`
|
|
1786
|
+
*
|
|
1787
|
+
*
|
|
1788
|
+
*/
|
|
1789
|
+
readonly message: string;
|
|
1790
|
+
}
|
|
1791
|
+
/**
|
|
1792
|
+
* Returned when the indexing of Product information is deactivated in a Project.
|
|
1793
|
+
*
|
|
1794
|
+
* To activate indexing, call [Change Product Search Indexing Enabled](ctp:api:type:ProjectChangeProductSearchIndexingEnabledAction) and set `enabled` to `true`.
|
|
1795
|
+
*
|
|
1796
|
+
*/
|
|
1797
|
+
export interface SearchDeactivatedError {
|
|
1798
|
+
readonly code: 'SearchDeactivated';
|
|
1799
|
+
[key: string]: any;
|
|
1800
|
+
/**
|
|
1801
|
+
* `"The endpoint is deactivated for this project. Please enable it via the Project endpoint, via the Merchant Center in the Project settings, or reach out to Support to enable it."`
|
|
1802
|
+
*
|
|
1803
|
+
*
|
|
1804
|
+
*/
|
|
1805
|
+
readonly message: string;
|
|
1806
|
+
}
|
|
1807
|
+
/**
|
|
1808
|
+
* Returned when a search query could not be completed due to an unexpected failure.
|
|
1809
|
+
*
|
|
1810
|
+
*/
|
|
1811
|
+
export interface SearchExecutionFailureError {
|
|
1812
|
+
readonly code: 'SearchExecutionFailure';
|
|
1813
|
+
[key: string]: any;
|
|
1814
|
+
/**
|
|
1815
|
+
* `"Something went wrong during the search query execution. In most case this happens due to usage of non-existing fields and custom product attributes. Please verify all filters and facets in your search query and make sure that all paths are correct."`
|
|
1816
|
+
*
|
|
1817
|
+
*
|
|
1818
|
+
*/
|
|
1819
|
+
readonly message: string;
|
|
1820
|
+
}
|
|
1821
|
+
/**
|
|
1822
|
+
* Returned when a search facet path could not be found.
|
|
1823
|
+
*
|
|
1824
|
+
*/
|
|
1825
|
+
export interface SearchFacetPathNotFoundError {
|
|
1826
|
+
readonly code: 'SearchFacetPathNotFound';
|
|
1827
|
+
[key: string]: any;
|
|
1828
|
+
/**
|
|
1829
|
+
* `"Facet path $path not found."`
|
|
1830
|
+
*
|
|
1831
|
+
*
|
|
1832
|
+
*/
|
|
1833
|
+
readonly message: string;
|
|
1834
|
+
}
|
|
1835
|
+
/**
|
|
1836
|
+
* Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
|
|
1837
|
+
*
|
|
1838
|
+
*/
|
|
1839
|
+
export interface SearchIndexingInProgressError {
|
|
1840
|
+
readonly code: 'SearchIndexingInProgress';
|
|
1841
|
+
[key: string]: any;
|
|
1842
|
+
/**
|
|
1843
|
+
* `"The indexing is currently in progress. Please wait until the status is "Activated" to execute search requests."`
|
|
1844
|
+
*
|
|
1845
|
+
*
|
|
1846
|
+
*/
|
|
1847
|
+
readonly message: string;
|
|
1848
|
+
}
|
|
1849
|
+
/**
|
|
1850
|
+
* Returned if the requested search service is not ready. The search might be deactivated or indexing is in progress.
|
|
1851
|
+
*
|
|
1852
|
+
*/
|
|
1853
|
+
export interface SearchNotReadyError {
|
|
1854
|
+
readonly code: 'SearchNotReady';
|
|
1855
|
+
[key: string]: any;
|
|
1856
|
+
/**
|
|
1857
|
+
* `$Search is not ready. Check the indexing-status endpoint and that the feature has been activated in the project settings.`
|
|
1858
|
+
*
|
|
1859
|
+
*
|
|
1860
|
+
*/
|
|
1861
|
+
readonly message: string;
|
|
1862
|
+
}
|
|
1863
|
+
/**
|
|
1864
|
+
* Returned when a [Discount predicate](/../api/predicates/predicate-operators) or [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions) is not semantically correct.
|
|
1865
|
+
*
|
|
1866
|
+
*/
|
|
1867
|
+
export interface SemanticErrorError {
|
|
1868
|
+
readonly code: 'SemanticError';
|
|
1869
|
+
[key: string]: any;
|
|
1870
|
+
/**
|
|
1871
|
+
* Plain text description of the error concerning the predicate. For example, `"Invalid country code $countryCode provided for the field $fieldDefinition."`.
|
|
1872
|
+
*
|
|
1873
|
+
*
|
|
1874
|
+
*/
|
|
1875
|
+
readonly message: string;
|
|
1876
|
+
}
|
|
1877
|
+
/**
|
|
1878
|
+
* Returned when the Cart contains a [ShippingMethod](ctp:api:type:ShippingMethod) that is not allowed for the [Cart](ctp:api:type:Cart). In this case, the [ShippingMethodState](ctp:api:type:ShippingMethodState) value is `DoesNotMatchCart`.
|
|
1879
|
+
*
|
|
1880
|
+
* When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction).
|
|
1881
|
+
*
|
|
1882
|
+
* The error is also returned as a failed response to:
|
|
1883
|
+
*
|
|
1884
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
1885
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
1886
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
1887
|
+
*
|
|
1888
|
+
*/
|
|
1889
|
+
export interface ShippingMethodDoesNotMatchCartError {
|
|
1890
|
+
readonly code: 'ShippingMethodDoesNotMatchCart';
|
|
1891
|
+
[key: string]: any;
|
|
1892
|
+
/**
|
|
1893
|
+
* `"The predicate does not match the cart."`
|
|
1894
|
+
*
|
|
1895
|
+
*
|
|
1896
|
+
*/
|
|
1897
|
+
readonly message: string;
|
|
1898
|
+
}
|
|
1899
|
+
/**
|
|
1900
|
+
* Returned when a Cart Discount cannot be created or assigned to a Store as the [limit](/../api/limits#cart-discounts) for active Cart Discounts in a Store has been reached for one or more Stores in the request.
|
|
1901
|
+
*
|
|
1902
|
+
* The error is returned as a failed response to:
|
|
1903
|
+
*
|
|
1904
|
+
* - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests
|
|
1905
|
+
* - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions
|
|
1906
|
+
*
|
|
1907
|
+
*/
|
|
1908
|
+
export interface StoreCartDiscountsLimitReachedError {
|
|
1909
|
+
readonly code: 'StoreCartDiscountsLimitReached';
|
|
1910
|
+
[key: string]: any;
|
|
1911
|
+
/**
|
|
1912
|
+
* `"Maximum number of active cart discounts reached for $stores."`
|
|
1913
|
+
*
|
|
1914
|
+
*
|
|
1915
|
+
*/
|
|
1916
|
+
readonly message: string;
|
|
1917
|
+
/**
|
|
1918
|
+
* Stores for which the limit for active Cart Discounts that can exist has been reached.
|
|
1919
|
+
*
|
|
1920
|
+
*
|
|
1921
|
+
*/
|
|
1922
|
+
readonly stores: StoreKeyReference[];
|
|
1923
|
+
}
|
|
1924
|
+
/**
|
|
1925
|
+
* Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
|
|
1926
|
+
*
|
|
1927
|
+
*/
|
|
1928
|
+
export interface SyntaxErrorError {
|
|
1929
|
+
readonly code: 'SyntaxError';
|
|
1930
|
+
[key: string]: any;
|
|
1931
|
+
/**
|
|
1932
|
+
* `"Syntax error while parsing $fieldDefinition."`
|
|
1933
|
+
*
|
|
1934
|
+
*
|
|
1935
|
+
*/
|
|
1936
|
+
readonly message: string;
|
|
1937
|
+
}
|
|
1938
|
+
export interface VariantValues {
|
|
1939
|
+
/**
|
|
1940
|
+
* SKU of the [ProductVariant](ctp:api:type:ProductVariant).
|
|
1941
|
+
*
|
|
1942
|
+
*
|
|
1943
|
+
*/
|
|
1944
|
+
readonly sku?: string;
|
|
1945
|
+
/**
|
|
1946
|
+
* Embedded Prices of the [ProductVariant](ctp:api:type:ProductVariant).
|
|
1947
|
+
*
|
|
1948
|
+
*
|
|
1949
|
+
*/
|
|
1950
|
+
readonly prices: PriceDraft[];
|
|
1951
|
+
/**
|
|
1952
|
+
* Attributes of the [ProductVariant](ctp:api:type:ProductVariant).
|
|
1953
|
+
*
|
|
1954
|
+
*
|
|
1955
|
+
*/
|
|
1956
|
+
readonly attributes: Attribute[];
|
|
1957
|
+
}
|
|
1958
|
+
/**
|
|
1959
|
+
* Represents a single error.
|
|
1960
|
+
*/
|
|
1961
|
+
export type GraphQLErrorObject = GraphQLAnonymousIdAlreadyInUseError | GraphQLAssociateMissingPermissionError | GraphQLAttributeDefinitionAlreadyExistsError | GraphQLAttributeDefinitionTypeConflictError | GraphQLAttributeNameDoesNotExistError | GraphQLBadGatewayError | GraphQLConcurrentModificationError | GraphQLContentTooLargeError | GraphQLCountryNotConfiguredInStoreError | GraphQLDiscountCodeNonApplicableError | GraphQLDuplicateAttributeValueError | GraphQLDuplicateAttributeValuesError | GraphQLDuplicateEnumValuesError | GraphQLDuplicateFieldError | GraphQLDuplicateFieldWithConflictingResourceError | GraphQLDuplicatePriceKeyError | GraphQLDuplicatePriceScopeError | GraphQLDuplicateStandalonePriceScopeError | GraphQLDuplicateVariantValuesError | GraphQLEditPreviewFailedError | GraphQLEnumKeyAlreadyExistsError | GraphQLEnumKeyDoesNotExistError | GraphQLEnumValueIsUsedError | GraphQLEnumValuesMustMatchError | GraphQLExtensionBadResponseError | GraphQLExtensionNoResponseError | GraphQLExtensionPredicateEvaluationFailedError | GraphQLExtensionUpdateActionsFailedError | GraphQLExternalOAuthFailedError | GraphQLFeatureRemovedError | GraphQLGeneralError | GraphQLInsufficientScopeError | GraphQLInternalConstraintViolatedError | GraphQLInvalidCredentialsError | GraphQLInvalidCurrentPasswordError | GraphQLInvalidFieldError | GraphQLInvalidInputError | GraphQLInvalidItemShippingDetailsError | GraphQLInvalidJsonInputError | GraphQLInvalidOperationError | GraphQLInvalidSubjectError | GraphQLInvalidTokenError | GraphQLLanguageUsedInStoresError | GraphQLLockedFieldError | GraphQLMatchingPriceNotFoundError | GraphQLMaxCartDiscountsReachedError | GraphQLMaxResourceLimitExceededError | GraphQLMaxStoreReferencesReachedError | GraphQLMissingRoleOnChannelError | GraphQLMissingTaxRateForCountryError | GraphQLMoneyOverflowError | GraphQLNoMatchingProductDiscountFoundError | GraphQLObjectNotFoundError | GraphQLOutOfStockError | GraphQLOverCapacityError | GraphQLOverlappingStandalonePriceValidityError | GraphQLPendingOperationError | GraphQLPriceChangedError | GraphQLProductAssignmentMissingError | GraphQLProductPresentWithDifferentVariantSelectionError | GraphQLProjectNotConfiguredForLanguagesError | GraphQLQueryComplexityLimitExceededError | GraphQLQueryTimedOutError | GraphQLReferenceExistsError | GraphQLReferencedResourceNotFoundError | GraphQLRequiredFieldError | GraphQLResourceNotFoundError | GraphQLResourceSizeLimitExceededError | GraphQLSearchDeactivatedError | GraphQLSearchExecutionFailureError | GraphQLSearchFacetPathNotFoundError | GraphQLSearchIndexingInProgressError | GraphQLSearchNotReadyError | GraphQLSemanticErrorError | GraphQLShippingMethodDoesNotMatchCartError | GraphQLStoreCartDiscountsLimitReachedError | GraphQLSyntaxErrorError;
|
|
1962
|
+
/**
|
|
1963
|
+
* Returned when the anonymous ID is being used by another resource.
|
|
1964
|
+
*
|
|
1965
|
+
* The client application should choose another anonymous ID or retrieve an automatically generated one.
|
|
1966
|
+
*
|
|
1967
|
+
*/
|
|
1968
|
+
export interface GraphQLAnonymousIdAlreadyInUseError {
|
|
1969
|
+
readonly code: 'AnonymousIdAlreadyInUse';
|
|
1970
|
+
[key: string]: any;
|
|
1971
|
+
}
|
|
1972
|
+
/**
|
|
1973
|
+
* Returned when an [Associate](/projects/business-units#associate) is missing a [Permission](/projects/associate-roles#ctp:api:type:Permission) on a [B2B resource](/associates-overview#b2b-resources).
|
|
1974
|
+
*
|
|
1975
|
+
*/
|
|
1976
|
+
export interface GraphQLAssociateMissingPermissionError {
|
|
1977
|
+
readonly code: 'AssociateMissingPermission';
|
|
1978
|
+
[key: string]: any;
|
|
1979
|
+
/**
|
|
1980
|
+
* [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) to the [Associate](ctp:api:type:Associate) that tried to perform the action.
|
|
1981
|
+
*
|
|
1982
|
+
*
|
|
1983
|
+
*/
|
|
1984
|
+
readonly associate: CustomerResourceIdentifier;
|
|
1985
|
+
/**
|
|
1986
|
+
* [ResourceIdentifier](ctp:api:type:BusinessUnitResourceIdentifier) to the [BusinessUnit](ctp:api:type:BusinessUnit).
|
|
1987
|
+
*
|
|
1988
|
+
*
|
|
1989
|
+
*/
|
|
1990
|
+
readonly businessUnit: BusinessUnitResourceIdentifier;
|
|
1991
|
+
/**
|
|
1992
|
+
* [ResourceIdentifier](ctp:api:type:CustomerResourceIdentifier) of the [Associate](ctp:api:type:Associate) on whose behalf the action is performed.
|
|
1993
|
+
*
|
|
1994
|
+
*
|
|
1995
|
+
*/
|
|
1996
|
+
readonly associateOnBehalf?: CustomerResourceIdentifier;
|
|
1997
|
+
/**
|
|
1998
|
+
* The Permissions that the [Associate](ctp:api:type:Associate) performing the action lacks. At least one of these Permissions is needed.
|
|
1999
|
+
*
|
|
2000
|
+
*
|
|
2001
|
+
*/
|
|
2002
|
+
readonly permissions: Permission[];
|
|
2003
|
+
}
|
|
2004
|
+
/**
|
|
2005
|
+
* Returned when the `name` of the [AttributeDefinition](ctp:api:type:AttributeDefinition) conflicts with an existing Attribute.
|
|
2006
|
+
*
|
|
2007
|
+
* The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request or [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action.
|
|
2008
|
+
*
|
|
2009
|
+
*/
|
|
2010
|
+
export interface GraphQLAttributeDefinitionAlreadyExistsError {
|
|
2011
|
+
readonly code: 'AttributeDefinitionAlreadyExists';
|
|
2012
|
+
[key: string]: any;
|
|
2013
|
+
/**
|
|
2014
|
+
* Unique identifier of the Product Type containing the conflicting name.
|
|
2015
|
+
*
|
|
2016
|
+
*
|
|
2017
|
+
*/
|
|
2018
|
+
readonly conflictingProductTypeId: string;
|
|
2019
|
+
/**
|
|
2020
|
+
* Name of the Product Type containing the conflicting name.
|
|
2021
|
+
*
|
|
2022
|
+
*
|
|
2023
|
+
*/
|
|
2024
|
+
readonly conflictingProductTypeName: string;
|
|
2025
|
+
/**
|
|
2026
|
+
* Name of the conflicting Attribute.
|
|
2027
|
+
*
|
|
2028
|
+
*
|
|
2029
|
+
*/
|
|
2030
|
+
readonly conflictingAttributeName: string;
|
|
2031
|
+
}
|
|
2032
|
+
/**
|
|
2033
|
+
* Returned when the `type` is different for an AttributeDefinition using the same `name` in multiple Product Types.
|
|
2034
|
+
*
|
|
2035
|
+
* The error is returned as a failed response to the [Create ProductType](ctp:api:endpoint:/{projectKey}/product-types:POST) request.
|
|
2036
|
+
*
|
|
2037
|
+
*/
|
|
2038
|
+
export interface GraphQLAttributeDefinitionTypeConflictError {
|
|
2039
|
+
readonly code: 'AttributeDefinitionTypeConflict';
|
|
2040
|
+
[key: string]: any;
|
|
2041
|
+
/**
|
|
2042
|
+
* Unique identifier of the Product Type containing the conflicting name.
|
|
2043
|
+
*
|
|
2044
|
+
*
|
|
2045
|
+
*/
|
|
2046
|
+
readonly conflictingProductTypeId: string;
|
|
2047
|
+
/**
|
|
2048
|
+
* Name of the Product Type containing the conflicting name.
|
|
2049
|
+
*
|
|
2050
|
+
*
|
|
2051
|
+
*/
|
|
2052
|
+
readonly conflictingProductTypeName: string;
|
|
2053
|
+
/**
|
|
2054
|
+
* Name of the conflicting Attribute.
|
|
2055
|
+
*
|
|
2056
|
+
*
|
|
2057
|
+
*/
|
|
2058
|
+
readonly conflictingAttributeName: string;
|
|
2059
|
+
}
|
|
2060
|
+
/**
|
|
2061
|
+
* Returned when an [AttributeDefinition](ctp:api:type:AttributeDefinition) does not exist for an Attribute `name`.
|
|
2062
|
+
*
|
|
2063
|
+
* The error is returned as a failed response to the [Change AttributeDefinition Name](ctp:api:type:ProductTypeChangeAttributeNameAction) update action.
|
|
2064
|
+
*
|
|
2065
|
+
*/
|
|
2066
|
+
export interface GraphQLAttributeNameDoesNotExistError {
|
|
2067
|
+
readonly code: 'AttributeNameDoesNotExist';
|
|
2068
|
+
[key: string]: any;
|
|
2069
|
+
/**
|
|
2070
|
+
* Non-existent Attribute name.
|
|
2071
|
+
*
|
|
2072
|
+
*
|
|
2073
|
+
*/
|
|
2074
|
+
readonly invalidAttributeName: string;
|
|
2075
|
+
}
|
|
2076
|
+
/**
|
|
2077
|
+
* Returned when a server-side problem is caused by scaling infrastructure resources.
|
|
2078
|
+
*
|
|
2079
|
+
* The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.
|
|
2080
|
+
*
|
|
2081
|
+
*/
|
|
2082
|
+
export interface GraphQLBadGatewayError {
|
|
2083
|
+
readonly code: 'BadGateway';
|
|
2084
|
+
[key: string]: any;
|
|
2085
|
+
}
|
|
2086
|
+
/**
|
|
2087
|
+
* Returned when the request conflicts with the current state of the involved resources. Typically, the request attempts to modify a resource that is out of date (that is modified by another client since it was last retrieved).
|
|
2088
|
+
* The client application should resolve the conflict (with or without involving the end user) before retrying the request.
|
|
2089
|
+
*
|
|
2090
|
+
*/
|
|
2091
|
+
export interface GraphQLConcurrentModificationError {
|
|
2092
|
+
readonly code: 'ConcurrentModification';
|
|
2093
|
+
[key: string]: any;
|
|
2094
|
+
/**
|
|
2095
|
+
* Current version of the resource.
|
|
2096
|
+
*
|
|
2097
|
+
*
|
|
2098
|
+
*/
|
|
2099
|
+
readonly currentVersion?: number;
|
|
2100
|
+
}
|
|
2101
|
+
/**
|
|
2102
|
+
* Returned when the request results in too much data being returned from the API. Adjust the request query to reduce the size of the data returned.
|
|
2103
|
+
*
|
|
2104
|
+
*/
|
|
2105
|
+
export interface GraphQLContentTooLargeError {
|
|
2106
|
+
readonly code: 'ContentTooLarge';
|
|
2107
|
+
[key: string]: any;
|
|
2108
|
+
}
|
|
2109
|
+
/**
|
|
2110
|
+
* Returned when a [Cart](ctp:api:type:Cart) or an [Order](ctp:api:type:Order) in a [Store](ctp:api:type:Store) references a country that is not included in the countries configured for the Store.
|
|
2111
|
+
*
|
|
2112
|
+
* The error is returned as a failed response to:
|
|
2113
|
+
*
|
|
2114
|
+
* - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/carts:POST) request and [Set Country](ctp:api:type:CartSetCountryAction) update action on Carts.
|
|
2115
|
+
* - [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/me/carts:POST) request and [Set Country](ctp:api:type:MyCartSetCountryAction) update action on My Carts.
|
|
2116
|
+
* - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders.
|
|
2117
|
+
* - [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
2118
|
+
* - [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) request on Order Import.
|
|
2119
|
+
* - [Set Country](ctp:api:type:StagedOrderSetCountryAction) update action on Order Edits.
|
|
2120
|
+
*
|
|
2121
|
+
*/
|
|
2122
|
+
export interface GraphQLCountryNotConfiguredInStoreError {
|
|
2123
|
+
readonly code: 'CountryNotConfiguredInStore';
|
|
2124
|
+
[key: string]: any;
|
|
2125
|
+
/**
|
|
2126
|
+
* Countries configured for the Store.
|
|
2127
|
+
*
|
|
2128
|
+
*
|
|
2129
|
+
*/
|
|
2130
|
+
readonly storeCountries: string[];
|
|
2131
|
+
/**
|
|
2132
|
+
* The country that is not configured for the Store but referenced on the Cart or Order.
|
|
2133
|
+
*
|
|
2134
|
+
*
|
|
2135
|
+
*/
|
|
2136
|
+
readonly country: string;
|
|
2137
|
+
}
|
|
2138
|
+
/**
|
|
2139
|
+
* Returned when the Cart contains a Discount Code with a [DiscountCodeState](ctp:api:type:DiscountCodeState) other than `MatchesCart`.
|
|
2140
|
+
*
|
|
2141
|
+
* The error is returned as a failed response to:
|
|
2142
|
+
*
|
|
2143
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add DiscountCode](ctp:api:type:CartAddDiscountCodeAction) update action on Carts.
|
|
2144
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests and [Add DiscountCode](ctp:api:type:MyCartAddDiscountCodeAction) update action on My Carts.
|
|
2145
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts.
|
|
2146
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
2147
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
2148
|
+
* - [Add DiscountCode](ctp:api:type:StagedOrderAddDiscountCodeAction) update action on Order Edits.
|
|
2149
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
2150
|
+
*
|
|
2151
|
+
*/
|
|
2152
|
+
export interface GraphQLDiscountCodeNonApplicableError {
|
|
2153
|
+
readonly code: 'DiscountCodeNonApplicable';
|
|
2154
|
+
[key: string]: any;
|
|
2155
|
+
/**
|
|
2156
|
+
* Discount Code passed to the Cart.
|
|
2157
|
+
*
|
|
2158
|
+
*
|
|
2159
|
+
*/
|
|
2160
|
+
readonly discountCode?: string;
|
|
2161
|
+
/**
|
|
2162
|
+
* `"DoesNotExist"` or `"TimeRangeNonApplicable"`
|
|
2163
|
+
*
|
|
2164
|
+
*
|
|
2165
|
+
*/
|
|
2166
|
+
readonly reason?: string;
|
|
2167
|
+
/**
|
|
2168
|
+
* Unique identifier of the Discount Code.
|
|
2169
|
+
*
|
|
2170
|
+
*
|
|
2171
|
+
*/
|
|
2172
|
+
readonly discountCodeId?: string;
|
|
2173
|
+
/**
|
|
2174
|
+
* Date and time (UTC) from which the Discount Code is valid.
|
|
2175
|
+
*
|
|
2176
|
+
*
|
|
2177
|
+
*/
|
|
2178
|
+
readonly validFrom?: string;
|
|
2179
|
+
/**
|
|
2180
|
+
* Date and time (UTC) until which the Discount Code is valid.
|
|
2181
|
+
*
|
|
2182
|
+
*
|
|
2183
|
+
*/
|
|
2184
|
+
readonly validUntil?: string;
|
|
2185
|
+
/**
|
|
2186
|
+
* Date and time (UTC) the Discount Code validity check was last performed.
|
|
2187
|
+
*
|
|
2188
|
+
*
|
|
2189
|
+
*/
|
|
2190
|
+
readonly validityCheckTime?: string;
|
|
2191
|
+
}
|
|
2192
|
+
/**
|
|
2193
|
+
* Returned when the `Unique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
|
|
2194
|
+
*
|
|
2195
|
+
*/
|
|
2196
|
+
export interface GraphQLDuplicateAttributeValueError {
|
|
2197
|
+
readonly code: 'DuplicateAttributeValue';
|
|
2198
|
+
[key: string]: any;
|
|
2199
|
+
/**
|
|
2200
|
+
* Conflicting Attributes.
|
|
2201
|
+
*
|
|
2202
|
+
*
|
|
2203
|
+
*/
|
|
2204
|
+
readonly attribute: Attribute;
|
|
2205
|
+
}
|
|
2206
|
+
/**
|
|
2207
|
+
* Returned when the `CombinationUnique` [AttributeConstraint](ctp:api:type:AttributeConstraintEnum) criteria are not met during an [Update Product](/../api/projects/products#update-product) request.
|
|
2208
|
+
*
|
|
2209
|
+
*/
|
|
2210
|
+
export interface GraphQLDuplicateAttributeValuesError {
|
|
2211
|
+
readonly code: 'DuplicateAttributeValues';
|
|
2212
|
+
[key: string]: any;
|
|
2213
|
+
/**
|
|
2214
|
+
* Conflicting Attributes.
|
|
2215
|
+
*
|
|
2216
|
+
*
|
|
2217
|
+
*/
|
|
2218
|
+
readonly attributes: Attribute[];
|
|
2219
|
+
}
|
|
2220
|
+
/**
|
|
2221
|
+
* Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains duplicate keys.
|
|
2222
|
+
*
|
|
2223
|
+
*/
|
|
2224
|
+
export interface GraphQLDuplicateEnumValuesError {
|
|
2225
|
+
readonly code: 'DuplicateEnumValues';
|
|
2226
|
+
[key: string]: any;
|
|
2227
|
+
/**
|
|
2228
|
+
* Duplicate keys.
|
|
2229
|
+
*
|
|
2230
|
+
*
|
|
2231
|
+
*/
|
|
2232
|
+
readonly duplicates: string[];
|
|
2233
|
+
}
|
|
2234
|
+
/**
|
|
2235
|
+
* Returned when a field value conflicts with an existing value causing a duplicate.
|
|
2236
|
+
*
|
|
2237
|
+
*/
|
|
2238
|
+
export interface GraphQLDuplicateFieldError {
|
|
2239
|
+
readonly code: 'DuplicateField';
|
|
2240
|
+
[key: string]: any;
|
|
2241
|
+
/**
|
|
2242
|
+
* Name of the conflicting field.
|
|
2243
|
+
*
|
|
2244
|
+
*
|
|
2245
|
+
*/
|
|
2246
|
+
readonly field: string;
|
|
2247
|
+
/**
|
|
2248
|
+
* Conflicting duplicate value.
|
|
2249
|
+
*
|
|
2250
|
+
*
|
|
2251
|
+
*/
|
|
2252
|
+
readonly duplicateValue: any;
|
|
2253
|
+
}
|
|
2254
|
+
/**
|
|
2255
|
+
* Returned when a field value conflicts with an existing value stored in a particular resource causing a duplicate.
|
|
2256
|
+
*
|
|
2257
|
+
*/
|
|
2258
|
+
export interface GraphQLDuplicateFieldWithConflictingResourceError {
|
|
2259
|
+
readonly code: 'DuplicateFieldWithConflictingResource';
|
|
2260
|
+
[key: string]: any;
|
|
2261
|
+
/**
|
|
2262
|
+
* Name of the conflicting field.
|
|
2263
|
+
*
|
|
2264
|
+
*
|
|
2265
|
+
*/
|
|
2266
|
+
readonly field: string;
|
|
2267
|
+
/**
|
|
2268
|
+
* Conflicting duplicate value.
|
|
2269
|
+
*
|
|
2270
|
+
*
|
|
2271
|
+
*/
|
|
2272
|
+
readonly duplicateValue: any;
|
|
2273
|
+
/**
|
|
2274
|
+
* Reference to the resource that has the conflicting value.
|
|
2275
|
+
*
|
|
2276
|
+
*
|
|
2277
|
+
*/
|
|
2278
|
+
readonly conflictingResource: Reference;
|
|
2279
|
+
}
|
|
2280
|
+
/**
|
|
2281
|
+
* Returned when a Price key conflicts with an existing key.
|
|
2282
|
+
*
|
|
2283
|
+
* Keys of Embedded Prices must be unique per ProductVariant.
|
|
2284
|
+
*
|
|
2285
|
+
*/
|
|
2286
|
+
export interface GraphQLDuplicatePriceKeyError {
|
|
2287
|
+
readonly code: 'DuplicatePriceKey';
|
|
2288
|
+
[key: string]: any;
|
|
2289
|
+
/**
|
|
2290
|
+
* Conflicting Embedded Price.
|
|
2291
|
+
*
|
|
2292
|
+
*
|
|
2293
|
+
*/
|
|
2294
|
+
readonly conflictingPrice: Price;
|
|
2295
|
+
}
|
|
2296
|
+
/**
|
|
2297
|
+
* Returned when a Price scope conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
|
|
2298
|
+
*
|
|
2299
|
+
* Every Price of a Product Variant must have a distinct combination of currency, Customer Group, country, and Channel that constitute the scope of a Price.
|
|
2300
|
+
*
|
|
2301
|
+
*/
|
|
2302
|
+
export interface GraphQLDuplicatePriceScopeError {
|
|
2303
|
+
readonly code: 'DuplicatePriceScope';
|
|
2304
|
+
[key: string]: any;
|
|
2305
|
+
/**
|
|
2306
|
+
* Conflicting Embedded Price.
|
|
2307
|
+
*
|
|
2308
|
+
*
|
|
2309
|
+
*/
|
|
2310
|
+
readonly conflictingPrice: Price;
|
|
2311
|
+
}
|
|
2312
|
+
/**
|
|
2313
|
+
* Returned when the given Price scope conflicts with the Price scope of an existing Standalone Price.
|
|
2314
|
+
* Every Standalone Price associated with the same SKU must have a distinct combination of currency, country, Customer Group, Channel, and validity periods (`validFrom` and `validUntil`).
|
|
2315
|
+
*
|
|
2316
|
+
* The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
|
|
2317
|
+
*
|
|
2318
|
+
*/
|
|
2319
|
+
export interface GraphQLDuplicateStandalonePriceScopeError {
|
|
2320
|
+
readonly code: 'DuplicateStandalonePriceScope';
|
|
2321
|
+
[key: string]: any;
|
|
2322
|
+
/**
|
|
2323
|
+
* Reference to the conflicting Standalone Price.
|
|
2324
|
+
*
|
|
2325
|
+
*
|
|
2326
|
+
*/
|
|
2327
|
+
readonly conflictingStandalonePrice: StandalonePriceReference;
|
|
2328
|
+
/**
|
|
2329
|
+
* SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
|
|
2330
|
+
*
|
|
2331
|
+
*
|
|
2332
|
+
*/
|
|
2333
|
+
readonly sku: string;
|
|
2334
|
+
/**
|
|
2335
|
+
* Currency code of the country.
|
|
2336
|
+
*
|
|
2337
|
+
*
|
|
2338
|
+
*/
|
|
2339
|
+
readonly currency: string;
|
|
2340
|
+
/**
|
|
2341
|
+
* Country code of the geographic location.
|
|
2342
|
+
*
|
|
2343
|
+
*
|
|
2344
|
+
*/
|
|
2345
|
+
readonly country?: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
|
|
2348
|
+
*
|
|
2349
|
+
*
|
|
2350
|
+
*/
|
|
2351
|
+
readonly customerGroup?: CustomerGroupResourceIdentifier;
|
|
2352
|
+
/**
|
|
2353
|
+
* [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
|
|
2354
|
+
*
|
|
2355
|
+
*
|
|
2356
|
+
*/
|
|
2357
|
+
readonly channel?: ChannelResourceIdentifier;
|
|
2358
|
+
/**
|
|
2359
|
+
* Date and time (UTC) from which the Standalone Price is valid.
|
|
2360
|
+
*
|
|
2361
|
+
*
|
|
2362
|
+
*/
|
|
2363
|
+
readonly validFrom?: string;
|
|
2364
|
+
/**
|
|
2365
|
+
* Date and time (UTC) until which the Standalone Price is valid.
|
|
2366
|
+
*
|
|
2367
|
+
*
|
|
2368
|
+
*/
|
|
2369
|
+
readonly validUntil?: string;
|
|
2370
|
+
}
|
|
2371
|
+
/**
|
|
2372
|
+
* Returned when a [Product Variant](ctp:api:type:ProductVariant) value conflicts with an existing one during an [Update Product](/../api/projects/products#update-product) request.
|
|
2373
|
+
*
|
|
2374
|
+
*/
|
|
2375
|
+
export interface GraphQLDuplicateVariantValuesError {
|
|
2376
|
+
readonly code: 'DuplicateVariantValues';
|
|
2377
|
+
[key: string]: any;
|
|
2378
|
+
/**
|
|
2379
|
+
* Every Product Variant must have a distinct combination of SKU, prices, and custom Attribute values.
|
|
2380
|
+
*
|
|
2381
|
+
*
|
|
2382
|
+
*/
|
|
2383
|
+
readonly variantValues: VariantValues;
|
|
2384
|
+
}
|
|
2385
|
+
/**
|
|
2386
|
+
* Returned when a preview to find an appropriate Shipping Method for an OrderEdit could not be generated.
|
|
2387
|
+
*
|
|
2388
|
+
* The error is returned as a failed response to the [Get Shipping Methods for an OrderEdit](ctp:api:endpoint:/{projectKey}/shipping-methods/matching-orderedit:GET) request.
|
|
2389
|
+
*
|
|
2390
|
+
*/
|
|
2391
|
+
export interface GraphQLEditPreviewFailedError {
|
|
2392
|
+
readonly code: 'EditPreviewFailed';
|
|
2393
|
+
[key: string]: any;
|
|
2394
|
+
/**
|
|
2395
|
+
* State of the OrderEdit where the `stagedActions` cannot be applied to the Order.
|
|
2396
|
+
*
|
|
2397
|
+
*
|
|
2398
|
+
*/
|
|
2399
|
+
readonly result: OrderEditPreviewFailure;
|
|
2400
|
+
}
|
|
2401
|
+
/**
|
|
2402
|
+
* Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) contains a key that already exists.
|
|
2403
|
+
*
|
|
2404
|
+
*/
|
|
2405
|
+
export interface GraphQLEnumKeyAlreadyExistsError {
|
|
2406
|
+
readonly code: 'EnumKeyAlreadyExists';
|
|
2407
|
+
[key: string]: any;
|
|
2408
|
+
/**
|
|
2409
|
+
* Conflicting enum key.
|
|
2410
|
+
*
|
|
2411
|
+
*
|
|
2412
|
+
*/
|
|
2413
|
+
readonly conflictingEnumKey: string;
|
|
2414
|
+
/**
|
|
2415
|
+
* Name of the conflicting Attribute.
|
|
2416
|
+
*
|
|
2417
|
+
*
|
|
2418
|
+
*/
|
|
2419
|
+
readonly conflictingAttributeName: string;
|
|
2420
|
+
}
|
|
2421
|
+
/**
|
|
2422
|
+
* Returned when an [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) already contains a value with the given key.
|
|
2423
|
+
*
|
|
2424
|
+
* The error is returned as a failed response to the [Change the key of an EnumValue](ctp:api:type:ProductTypeChangeEnumKeyAction) update action.
|
|
2425
|
+
*
|
|
2426
|
+
*/
|
|
2427
|
+
export interface GraphQLEnumKeyDoesNotExistError {
|
|
2428
|
+
readonly code: 'EnumKeyDoesNotExist';
|
|
2429
|
+
[key: string]: any;
|
|
2430
|
+
/**
|
|
2431
|
+
* Conflicting enum key.
|
|
2432
|
+
*
|
|
2433
|
+
*
|
|
2434
|
+
*/
|
|
2435
|
+
readonly conflictingEnumKey: string;
|
|
2436
|
+
/**
|
|
2437
|
+
* Name of the conflicting Attribute.
|
|
2438
|
+
*
|
|
2439
|
+
*
|
|
2440
|
+
*/
|
|
2441
|
+
readonly conflictingAttributeName: string;
|
|
2442
|
+
}
|
|
2443
|
+
/**
|
|
2444
|
+
* Returned when an enum value cannot be removed from an Attribute as it is being used by a Product.
|
|
2445
|
+
*
|
|
2446
|
+
* The error is returned as a failed response to the [Remove EnumValues from AttributeDefinition](ctp:api:type:ProductTypeRemoveEnumValuesAction) update action.
|
|
2447
|
+
*
|
|
2448
|
+
*/
|
|
2449
|
+
export interface GraphQLEnumValueIsUsedError {
|
|
2450
|
+
readonly code: 'EnumValueIsUsed';
|
|
2451
|
+
[key: string]: any;
|
|
2452
|
+
}
|
|
2453
|
+
/**
|
|
2454
|
+
* Returned when during an order update of [AttributeEnumType](ctp:api:type:AttributeEnumType) or [AttributeLocalizedEnumType](ctp:api:type:AttributeLocalizedEnumType) the new enum values do not match the existing ones.
|
|
2455
|
+
*
|
|
2456
|
+
* The error is returned as a failed response to the [Change the order of EnumValues](ctp:api:type:ProductTypeChangePlainEnumValueOrderAction) and [Change the order of LocalizedEnumValues](ctp:api:type:ProductTypeChangeLocalizedEnumValueOrderAction) update actions.
|
|
2457
|
+
*
|
|
2458
|
+
*/
|
|
2459
|
+
export interface GraphQLEnumValuesMustMatchError {
|
|
2460
|
+
readonly code: 'EnumValuesMustMatch';
|
|
2461
|
+
[key: string]: any;
|
|
2462
|
+
}
|
|
2463
|
+
/**
|
|
2464
|
+
* Returned when the response from the API Extension could not be parsed successfully (such as a `500` HTTP status code, or an invalid JSON response).
|
|
2465
|
+
*
|
|
2466
|
+
*/
|
|
2467
|
+
export interface GraphQLExtensionBadResponseError {
|
|
2468
|
+
readonly code: 'ExtensionBadResponse';
|
|
2469
|
+
[key: string]: any;
|
|
2470
|
+
/**
|
|
2471
|
+
* User-defined localized description of the error.
|
|
2472
|
+
*
|
|
2473
|
+
*
|
|
2474
|
+
*/
|
|
2475
|
+
readonly localizedMessage?: LocalizedString;
|
|
2476
|
+
/**
|
|
2477
|
+
* Any information that should be returned to the API caller.
|
|
2478
|
+
*
|
|
2479
|
+
*
|
|
2480
|
+
*/
|
|
2481
|
+
readonly extensionExtraInfo?: any;
|
|
2482
|
+
/**
|
|
2483
|
+
* Additional errors related to the API Extension.
|
|
2484
|
+
*
|
|
2485
|
+
*
|
|
2486
|
+
*/
|
|
2487
|
+
readonly extensionErrors: ExtensionError[];
|
|
2488
|
+
/**
|
|
2489
|
+
* The response body returned by the Extension.
|
|
2490
|
+
*
|
|
2491
|
+
*/
|
|
2492
|
+
readonly extensionBody?: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Http status code returned by the Extension.
|
|
2495
|
+
*
|
|
2496
|
+
*/
|
|
2497
|
+
readonly extensionStatusCode?: number;
|
|
2498
|
+
/**
|
|
2499
|
+
* Unique identifier of the Extension.
|
|
2500
|
+
*
|
|
2501
|
+
*/
|
|
2502
|
+
readonly extensionId: string;
|
|
2503
|
+
/**
|
|
2504
|
+
* User-defined unique identifier of the Extension.
|
|
2505
|
+
*
|
|
2506
|
+
*/
|
|
2507
|
+
readonly extensionKey?: string;
|
|
2508
|
+
}
|
|
2509
|
+
/**
|
|
2510
|
+
* Returned when the API Extension does not respond within the [time limit](/../api/projects/api-extensions#time-limits), or could not be reached.
|
|
2511
|
+
*
|
|
2512
|
+
*/
|
|
2513
|
+
export interface GraphQLExtensionNoResponseError {
|
|
2514
|
+
readonly code: 'ExtensionNoResponse';
|
|
2515
|
+
[key: string]: any;
|
|
2516
|
+
/**
|
|
2517
|
+
* Unique identifier of the API Extension.
|
|
2518
|
+
*
|
|
2519
|
+
*
|
|
2520
|
+
*/
|
|
2521
|
+
readonly extensionId: string;
|
|
2522
|
+
/**
|
|
2523
|
+
* User-defined unique identifier of the API Extension, if available.
|
|
2524
|
+
*
|
|
2525
|
+
*
|
|
2526
|
+
*/
|
|
2527
|
+
readonly extensionKey?: string;
|
|
2528
|
+
}
|
|
2529
|
+
/**
|
|
2530
|
+
* Returned when the predicate defined in the [ExtensionTrigger](ctp:api:type:ExtensionTrigger) could not be evaluated due to a missing field.
|
|
2531
|
+
*
|
|
2532
|
+
*/
|
|
2533
|
+
export interface GraphQLExtensionPredicateEvaluationFailedError {
|
|
2534
|
+
readonly code: 'ExtensionPredicateEvaluationFailed';
|
|
2535
|
+
[key: string]: any;
|
|
2536
|
+
/**
|
|
2537
|
+
* Details about the API Extension that was involved in the error.
|
|
2538
|
+
*
|
|
2539
|
+
*
|
|
2540
|
+
*/
|
|
2541
|
+
readonly errorByExtension: ErrorByExtension;
|
|
2542
|
+
}
|
|
2543
|
+
/**
|
|
2544
|
+
* Returned when update actions could not be applied to the resource (for example, because a referenced resource does not exist).
|
|
2545
|
+
* This would result in a [400 Bad Request](#400-bad-request) response if the same update action was sent from a regular client.
|
|
2546
|
+
*
|
|
2547
|
+
*/
|
|
2548
|
+
export interface GraphQLExtensionUpdateActionsFailedError {
|
|
2549
|
+
readonly code: 'ExtensionUpdateActionsFailed';
|
|
2550
|
+
[key: string]: any;
|
|
2551
|
+
/**
|
|
2552
|
+
* User-defined localized description of the error.
|
|
2553
|
+
*
|
|
2554
|
+
*
|
|
2555
|
+
*/
|
|
2556
|
+
readonly localizedMessage?: LocalizedString;
|
|
2557
|
+
/**
|
|
2558
|
+
* Any information that should be returned to the API caller.
|
|
2559
|
+
*
|
|
2560
|
+
*
|
|
2561
|
+
*/
|
|
2562
|
+
readonly extensionExtraInfo?: any;
|
|
2563
|
+
/**
|
|
2564
|
+
* Additional errors related to the API Extension.
|
|
2565
|
+
*
|
|
2566
|
+
*
|
|
2567
|
+
*/
|
|
2568
|
+
readonly extensionErrors: ExtensionError[];
|
|
2569
|
+
}
|
|
2570
|
+
/**
|
|
2571
|
+
* Returned when an [external OAuth Introspection endpoint](/../api/authorization#requesting-an-access-token-using-an-external-oauth-server) does not return a response within the [time limit](/../api/authorization#time-limits), or the response isn't compliant with [RFC 7662](https://www.rfc-editor.org/rfc/rfc7662.html) (for example, an HTTP status code like `500`).
|
|
2572
|
+
*
|
|
2573
|
+
*/
|
|
2574
|
+
export interface GraphQLExternalOAuthFailedError {
|
|
2575
|
+
readonly code: 'ExternalOAuthFailed';
|
|
2576
|
+
[key: string]: any;
|
|
2577
|
+
}
|
|
2578
|
+
/**
|
|
2579
|
+
* Returned when the requested feature was removed.
|
|
2580
|
+
*
|
|
2581
|
+
*/
|
|
2582
|
+
export interface GraphQLFeatureRemovedError {
|
|
2583
|
+
readonly code: 'FeatureRemoved';
|
|
2584
|
+
[key: string]: any;
|
|
2585
|
+
}
|
|
2586
|
+
/**
|
|
2587
|
+
* Returned when a server-side problem occurs before or after data persistence. In some cases, the requested action may successfully complete after the error is returned. Therefore, it is recommended to verify the status of the requested resource after receiving a 500 error.
|
|
2588
|
+
*
|
|
2589
|
+
* If you encounter this error, report it to the [Composable Commerce support team](https://support.commercetools.com).
|
|
2590
|
+
*
|
|
2591
|
+
*/
|
|
2592
|
+
export interface GraphQLGeneralError {
|
|
2593
|
+
readonly code: 'General';
|
|
2594
|
+
[key: string]: any;
|
|
2595
|
+
}
|
|
2596
|
+
export interface GraphQLInsufficientScopeError {
|
|
2597
|
+
readonly code: 'insufficient_scope';
|
|
2598
|
+
[key: string]: any;
|
|
2599
|
+
}
|
|
2600
|
+
/**
|
|
2601
|
+
* Returned when certain API-specific constraints were not met. For example, the specified [Discount Code](ctp:api:type:DiscountCode) was never applied and cannot be updated.
|
|
2602
|
+
*
|
|
2603
|
+
*/
|
|
2604
|
+
export interface GraphQLInternalConstraintViolatedError {
|
|
2605
|
+
readonly code: 'InternalConstraintViolated';
|
|
2606
|
+
[key: string]: any;
|
|
2607
|
+
}
|
|
2608
|
+
/**
|
|
2609
|
+
* Returned when a Customer with the given credentials (matching the given email/password pair) is not found and authentication fails.
|
|
2610
|
+
*
|
|
2611
|
+
* The error is returned as a failed response to:
|
|
2612
|
+
*
|
|
2613
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests on Customers.
|
|
2614
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile.
|
|
2615
|
+
*
|
|
2616
|
+
*/
|
|
2617
|
+
export interface GraphQLInvalidCredentialsError {
|
|
2618
|
+
readonly code: 'InvalidCredentials';
|
|
2619
|
+
[key: string]: any;
|
|
2620
|
+
}
|
|
2621
|
+
/**
|
|
2622
|
+
* Returned when the current password of the Customer does not match.
|
|
2623
|
+
*
|
|
2624
|
+
* The error is returned as a failed response to:
|
|
2625
|
+
*
|
|
2626
|
+
* - [Change Customer Password](ctp:api:endpoint:/{projectKey}/customers/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/customers/password:POST) requests on Customers.
|
|
2627
|
+
* - [Change Customer Password](ctp:api:endpoint:/{projectKey}/me/password:POST) and [Change Customer Password in a Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/password:POST) requests on My Customer Profile.
|
|
2628
|
+
*
|
|
2629
|
+
*/
|
|
2630
|
+
export interface GraphQLInvalidCurrentPasswordError {
|
|
2631
|
+
readonly code: 'InvalidCurrentPassword';
|
|
2632
|
+
[key: string]: any;
|
|
2633
|
+
}
|
|
2634
|
+
/**
|
|
2635
|
+
* Returned when a field has an invalid value.
|
|
2636
|
+
*
|
|
2637
|
+
*/
|
|
2638
|
+
export interface GraphQLInvalidFieldError {
|
|
2639
|
+
readonly code: 'InvalidField';
|
|
2640
|
+
[key: string]: any;
|
|
2641
|
+
/**
|
|
2642
|
+
* Name of the field with the invalid value.
|
|
2643
|
+
*
|
|
2644
|
+
*
|
|
2645
|
+
*/
|
|
2646
|
+
readonly field: string;
|
|
2647
|
+
/**
|
|
2648
|
+
* Value invalid for the field.
|
|
2649
|
+
*
|
|
2650
|
+
*
|
|
2651
|
+
*/
|
|
2652
|
+
readonly invalidValue: any;
|
|
2653
|
+
/**
|
|
2654
|
+
* Fixed set of allowed values for the field, if any.
|
|
2655
|
+
*
|
|
2656
|
+
*
|
|
2657
|
+
*/
|
|
2658
|
+
readonly allowedValues?: any[];
|
|
2659
|
+
}
|
|
2660
|
+
/**
|
|
2661
|
+
* Returned when an invalid input has been sent.
|
|
2662
|
+
*
|
|
2663
|
+
*/
|
|
2664
|
+
export interface GraphQLInvalidInputError {
|
|
2665
|
+
readonly code: 'InvalidInput';
|
|
2666
|
+
[key: string]: any;
|
|
2667
|
+
}
|
|
2668
|
+
/**
|
|
2669
|
+
* Returned when Line Item or Custom Line Item quantities set under [ItemShippingDetails](ctp:api:type:ItemShippingDetails) do not match the sum of the quantities in their respective shipping details.
|
|
2670
|
+
*
|
|
2671
|
+
* When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction).
|
|
2672
|
+
*
|
|
2673
|
+
* The error is also returned as a failed response to:
|
|
2674
|
+
*
|
|
2675
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST) requests and [Add LineItem](ctp:api:type:CartAddLineItemAction), [Add CustomLineItem](ctp:api:type:CartAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:CartSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:CartSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:CartAddShoppingListAction), and [Remove LineItem](ctp:api:type:CartRemoveLineItemAction) update actions on Carts.
|
|
2676
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) requests, and [Add LineItem](ctp:api:type:MyCartAddLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:MyCartSetLineItemShippingDetailsAction), and [Remove LineItem](ctp:api:type:MyCartRemoveLineItemAction) update actions on My Carts.
|
|
2677
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) request on Associate Carts.
|
|
2678
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders.
|
|
2679
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
2680
|
+
* - [Add LineItem](ctp:api:type:StagedOrderAddLineItemAction), [Add CustomLineItem](ctp:api:type:StagedOrderAddCustomLineItemAction), [Set LineItem ShippingDetails](ctp:api:type:StagedOrderSetLineItemShippingDetailsAction), [Set CustomLineItem ShippingDetails](ctp:api:type:StagedOrderSetCustomLineItemShippingDetailsAction), [Add Shopping List](ctp:api:type:StagedOrderAddShoppingListAction), and [Remove LineItem](ctp:api:type:StagedOrderRemoveLineItemAction) update actions on Order Edits.
|
|
2681
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders.
|
|
2682
|
+
*
|
|
2683
|
+
*/
|
|
2684
|
+
export interface GraphQLInvalidItemShippingDetailsError {
|
|
2685
|
+
readonly code: 'InvalidItemShippingDetails';
|
|
2686
|
+
[key: string]: any;
|
|
2687
|
+
/**
|
|
2688
|
+
* `"LineItem"` or `"CustomLineItem"`
|
|
2689
|
+
*
|
|
2690
|
+
*
|
|
2691
|
+
*/
|
|
2692
|
+
readonly subject: string;
|
|
2693
|
+
/**
|
|
2694
|
+
* Unique identifier of the Line Item or Custom Line Item.
|
|
2695
|
+
*
|
|
2696
|
+
*
|
|
2697
|
+
*/
|
|
2698
|
+
readonly itemId: string;
|
|
2699
|
+
}
|
|
2700
|
+
/**
|
|
2701
|
+
* Returned when an invalid JSON input has been sent.
|
|
2702
|
+
* Either the JSON is syntactically incorrect or does not conform to the expected shape (for example is missing a required field).
|
|
2703
|
+
*
|
|
2704
|
+
* The client application should validate the input according to the constraints described in the error message before sending the request.
|
|
2705
|
+
*
|
|
2706
|
+
*/
|
|
2707
|
+
export interface GraphQLInvalidJsonInputError {
|
|
2708
|
+
readonly code: 'InvalidJsonInput';
|
|
2709
|
+
[key: string]: any;
|
|
2710
|
+
/**
|
|
2711
|
+
* Further explanation about why the JSON is invalid.
|
|
2712
|
+
*
|
|
2713
|
+
*/
|
|
2714
|
+
readonly detailedErrorMessage: string;
|
|
2715
|
+
}
|
|
2716
|
+
/**
|
|
2717
|
+
* Returned when the resources involved in the request are not in a valid state for the operation.
|
|
2718
|
+
*
|
|
2719
|
+
* The client application should validate the constraints described in the error message before sending the request.
|
|
2720
|
+
*
|
|
2721
|
+
*/
|
|
2722
|
+
export interface GraphQLInvalidOperationError {
|
|
2723
|
+
readonly code: 'InvalidOperation';
|
|
2724
|
+
[key: string]: any;
|
|
2725
|
+
}
|
|
2726
|
+
export interface GraphQLInvalidSubjectError {
|
|
2727
|
+
readonly code: 'InvalidSubject';
|
|
2728
|
+
[key: string]: any;
|
|
2729
|
+
}
|
|
2730
|
+
export interface GraphQLInvalidTokenError {
|
|
2731
|
+
readonly code: 'invalid_token';
|
|
2732
|
+
[key: string]: any;
|
|
2733
|
+
}
|
|
2734
|
+
/**
|
|
2735
|
+
* Returned when a language cannot be removed from a Project as it is being used by a Store.
|
|
2736
|
+
*
|
|
2737
|
+
* The error is returned as a failed response to the [Change Languages](ctp:api:type:ProjectChangeLanguagesAction) update action.
|
|
2738
|
+
*
|
|
2739
|
+
*/
|
|
2740
|
+
export interface GraphQLLanguageUsedInStoresError {
|
|
2741
|
+
readonly code: 'LanguageUsedInStores';
|
|
2742
|
+
[key: string]: any;
|
|
2743
|
+
}
|
|
2744
|
+
/**
|
|
2745
|
+
* Returned when two [Customers](ctp:api:type:Customer) are simultaneously created or updated with the same email address.
|
|
2746
|
+
*
|
|
2747
|
+
* To confirm if the operation was successful, repeat the request.
|
|
2748
|
+
*
|
|
2749
|
+
*/
|
|
2750
|
+
export interface GraphQLLockedFieldError {
|
|
2751
|
+
readonly code: 'LockedField';
|
|
2752
|
+
[key: string]: any;
|
|
2753
|
+
/**
|
|
2754
|
+
* Field that is currently locked.
|
|
2755
|
+
*
|
|
2756
|
+
*
|
|
2757
|
+
*/
|
|
2758
|
+
readonly field: string;
|
|
2759
|
+
}
|
|
2760
|
+
/**
|
|
2761
|
+
* Returned when the Product Variant does not have a Price according to the [Product](ctp:api:type:Product) `priceMode` value for a selected currency, country, Customer Group, or Channel.
|
|
2762
|
+
*
|
|
2763
|
+
* The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction).
|
|
2764
|
+
*
|
|
2765
|
+
* The error is also returned as a failed response to:
|
|
2766
|
+
*
|
|
2767
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers.
|
|
2768
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) requests on My Customer Profile.
|
|
2769
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts.
|
|
2770
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts.
|
|
2771
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts.
|
|
2772
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
2773
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
2774
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
2775
|
+
*
|
|
2776
|
+
*/
|
|
2777
|
+
export interface GraphQLMatchingPriceNotFoundError {
|
|
2778
|
+
readonly code: 'MatchingPriceNotFound';
|
|
2779
|
+
[key: string]: any;
|
|
2780
|
+
/**
|
|
2781
|
+
* Unique identifier of a [Product](ctp:api:type:Product).
|
|
2782
|
+
*
|
|
2783
|
+
*
|
|
2784
|
+
*/
|
|
2785
|
+
readonly productId: string;
|
|
2786
|
+
/**
|
|
2787
|
+
* Unique identifier of a [ProductVariant](ctp:api:type:ProductVariant) in the Product.
|
|
2788
|
+
*
|
|
2789
|
+
*
|
|
2790
|
+
*/
|
|
2791
|
+
readonly variantId: number;
|
|
2792
|
+
/**
|
|
2793
|
+
* Currency code of the country.
|
|
2794
|
+
*
|
|
2795
|
+
*
|
|
2796
|
+
*/
|
|
2797
|
+
readonly currency?: string;
|
|
2798
|
+
/**
|
|
2799
|
+
* Country code of the geographic location.
|
|
2800
|
+
*
|
|
2801
|
+
*
|
|
2802
|
+
*/
|
|
2803
|
+
readonly country?: string;
|
|
2804
|
+
/**
|
|
2805
|
+
* Customer Group associated with the Price.
|
|
2806
|
+
*
|
|
2807
|
+
*
|
|
2808
|
+
*/
|
|
2809
|
+
readonly customerGroup?: CustomerGroupReference;
|
|
2810
|
+
/**
|
|
2811
|
+
* Channel associated with the Price.
|
|
2812
|
+
*
|
|
2813
|
+
*
|
|
2814
|
+
*/
|
|
2815
|
+
readonly channel?: ChannelReference;
|
|
2816
|
+
}
|
|
2817
|
+
/**
|
|
2818
|
+
* Returned when a Cart Discount cannot be created or activated as the [limit](/../api/limits#cart-discounts) for active Cart Discounts has been reached.
|
|
2819
|
+
*
|
|
2820
|
+
* The error is returned as a failed response to:
|
|
2821
|
+
*
|
|
2822
|
+
* - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests
|
|
2823
|
+
* - [Change IsActive](ctp:api:type:CartDiscountChangeIsActiveAction) update action
|
|
2824
|
+
*
|
|
2825
|
+
*/
|
|
2826
|
+
export interface GraphQLMaxCartDiscountsReachedError {
|
|
2827
|
+
readonly code: 'MaxCartDiscountsReached';
|
|
2828
|
+
[key: string]: any;
|
|
2829
|
+
}
|
|
2830
|
+
/**
|
|
2831
|
+
* Returned when a resource type cannot be created as it has reached its [limits](/../api/limits).
|
|
2832
|
+
*
|
|
2833
|
+
* The limits must be adjusted for this resource before sending the request again.
|
|
2834
|
+
*
|
|
2835
|
+
*/
|
|
2836
|
+
export interface GraphQLMaxResourceLimitExceededError {
|
|
2837
|
+
readonly code: 'MaxResourceLimitExceeded';
|
|
2838
|
+
[key: string]: any;
|
|
2839
|
+
/**
|
|
2840
|
+
* Resource type that reached its maximum limit of configured elements (for example, 100 Zones per Project).
|
|
2841
|
+
*
|
|
2842
|
+
*
|
|
2843
|
+
*/
|
|
2844
|
+
readonly exceededResource: ReferenceTypeId;
|
|
2845
|
+
}
|
|
2846
|
+
/**
|
|
2847
|
+
* Returned when a Store cannot be added to a Cart Discount as the [limit](/../api/limits#cart-discounts-stores) for Stores configured for a Cart Discount has been reached.
|
|
2848
|
+
*
|
|
2849
|
+
* The error is returned as a failed response to:
|
|
2850
|
+
*
|
|
2851
|
+
* - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests
|
|
2852
|
+
* - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions
|
|
2853
|
+
*
|
|
2854
|
+
*/
|
|
2855
|
+
export interface GraphQLMaxStoreReferencesReachedError {
|
|
2856
|
+
readonly code: 'MaxStoreReferencesReached';
|
|
2857
|
+
[key: string]: any;
|
|
2858
|
+
}
|
|
2859
|
+
/**
|
|
2860
|
+
* Returned when one of the following states occur:
|
|
2861
|
+
*
|
|
2862
|
+
* - [Channel](ctp:api:type:Channel) is added or set on a [Store](ctp:api:type:Store) with missing Channel `roles`.
|
|
2863
|
+
* - [Standalone Price](ctp:api:type:StandalonePrice) references a Channel that does not contain the `ProductDistribution` role.
|
|
2864
|
+
*
|
|
2865
|
+
* The error is returned as a failed response to:
|
|
2866
|
+
*
|
|
2867
|
+
* - [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), [Set Distribution Channel](ctp:api:type:StoreSetDistributionChannelsAction), [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), and [Set Supply Channel](ctp:api:type:StoreSetSupplyChannelsAction) update actions.
|
|
2868
|
+
* - [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
|
|
2869
|
+
*
|
|
2870
|
+
*/
|
|
2871
|
+
export interface GraphQLMissingRoleOnChannelError {
|
|
2872
|
+
readonly code: 'MissingRoleOnChannel';
|
|
2873
|
+
[key: string]: any;
|
|
2874
|
+
/**
|
|
2875
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a given [Channel](ctp:api:type:Channel).
|
|
2876
|
+
*
|
|
2877
|
+
*
|
|
2878
|
+
*/
|
|
2879
|
+
readonly channel?: ChannelResourceIdentifier;
|
|
2880
|
+
/**
|
|
2881
|
+
* - `ProductDistribution` for Product Distribution Channels allowed for the Store. Also required for [Standalone Prices](ctp:api:type:StandalonePrice).
|
|
2882
|
+
* - `InventorySupply` for Inventory Supply Channels allowed for the Store.
|
|
2883
|
+
*
|
|
2884
|
+
*
|
|
2885
|
+
*/
|
|
2886
|
+
readonly missingRole: ChannelRoleEnum;
|
|
2887
|
+
}
|
|
2888
|
+
/**
|
|
2889
|
+
* Returned when the Tax Category of at least one of the `lineItems`, `customLineItems`, or `shippingInfo` in the [Cart](ctp:api:type:Cart) is missing the [TaxRate](ctp:api:type:TaxRate) matching `country` and `state` given in the `shippingAddress` of that Cart.
|
|
2890
|
+
*
|
|
2891
|
+
* The error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [Staged Orders](ctp:api:type:StagedOrderUpdateAction).
|
|
2892
|
+
*
|
|
2893
|
+
* The error is also returned as a failed response to:
|
|
2894
|
+
*
|
|
2895
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/login:POST) requests and [Set CustomerGroup](ctp:api:type:CustomerSetCustomerGroupAction) update action on Customers.
|
|
2896
|
+
* - [Authenticate (sign in) Customer](ctp:api:endpoint:/{projectKey}/me/login:POST) and [Authenticate (sign in) Customer in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/login:POST) on My Customer Profile.
|
|
2897
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/carts:POST), [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts:POST), [Replicate Cart](ctp:api:endpoint:/{projectKey}/carts/replicate:POST), and [Replicate Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/carts/replicate:POST) requests on Carts.
|
|
2898
|
+
* - [Create Cart](ctp:api:endpoint:/{projectKey}/me/carts:POST) and [Create Cart in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/me/carts:POST) and [Replicate My Cart](ctp:api:endpoint:/{projectKey}/me/carts/replicate:POST) requests on My Carts.
|
|
2899
|
+
* - [Create Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts:POST) and [Replicate Cart in Business Unit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/carts/replicate:POST) requests on Associate Carts.
|
|
2900
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
2901
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
2902
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) requests on Associate Orders.
|
|
2903
|
+
*
|
|
2904
|
+
*/
|
|
2905
|
+
export interface GraphQLMissingTaxRateForCountryError {
|
|
2906
|
+
readonly code: 'MissingTaxRateForCountry';
|
|
2907
|
+
[key: string]: any;
|
|
2908
|
+
/**
|
|
2909
|
+
* Unique identifier of the [TaxCategory](ctp:api:type:TaxCategory).
|
|
2910
|
+
*
|
|
2911
|
+
*
|
|
2912
|
+
*/
|
|
2913
|
+
readonly taxCategoryId: string;
|
|
2914
|
+
/**
|
|
2915
|
+
* Country code of the geographic location.
|
|
2916
|
+
*
|
|
2917
|
+
*
|
|
2918
|
+
*/
|
|
2919
|
+
readonly country?: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* State within the country, such as Texas in the United States.
|
|
2922
|
+
*
|
|
2923
|
+
*
|
|
2924
|
+
*/
|
|
2925
|
+
readonly state?: string;
|
|
2926
|
+
}
|
|
2927
|
+
/**
|
|
2928
|
+
* Returned when a [Money](ctp:api:type:Money) operation overflows the 64-bit integer range.
|
|
2929
|
+
* See [Money usage](/types#usage) for more information.
|
|
2930
|
+
*
|
|
2931
|
+
*/
|
|
2932
|
+
export interface GraphQLMoneyOverflowError {
|
|
2933
|
+
readonly code: 'MoneyOverflow';
|
|
2934
|
+
[key: string]: any;
|
|
2935
|
+
}
|
|
2936
|
+
/**
|
|
2937
|
+
* Returned when a Product Discount could not be found that could be applied to the Price of a Product Variant.
|
|
2938
|
+
*
|
|
2939
|
+
* The error is returned as a failed response to the [Get Matching ProductDiscount](ctp:api:endpoint:/{projectKey}/product-discounts/matching:POST) request.
|
|
2940
|
+
*
|
|
2941
|
+
*/
|
|
2942
|
+
export interface GraphQLNoMatchingProductDiscountFoundError {
|
|
2943
|
+
readonly code: 'NoMatchingProductDiscountFound';
|
|
2944
|
+
[key: string]: any;
|
|
2945
|
+
}
|
|
2946
|
+
/**
|
|
2947
|
+
* Returned when the requested resource was not found.
|
|
2948
|
+
*
|
|
2949
|
+
*/
|
|
2950
|
+
export interface GraphQLObjectNotFoundError {
|
|
2951
|
+
readonly code: 'ObjectNotFound';
|
|
2952
|
+
[key: string]: any;
|
|
2953
|
+
}
|
|
2954
|
+
/**
|
|
2955
|
+
* Returned when some of the [Line Items](ctp:api:type:LineItem) are out of stock at the time of placing an [Order](ctp:api:type:Order).
|
|
2956
|
+
*
|
|
2957
|
+
* The error is returned as a failed response to:
|
|
2958
|
+
*
|
|
2959
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST), and [Create Order by Import](ctp:api:endpoint:/{projectKey}/orders/import:POST) requests on Orders.
|
|
2960
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
2961
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) and [Create Order from Quote in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders/quotes:POST) requests on Associate Orders.
|
|
2962
|
+
*
|
|
2963
|
+
*/
|
|
2964
|
+
export interface GraphQLOutOfStockError {
|
|
2965
|
+
readonly code: 'OutOfStock';
|
|
2966
|
+
[key: string]: any;
|
|
2967
|
+
/**
|
|
2968
|
+
* Unique identifiers of the Line Items that are out of stock.
|
|
2969
|
+
*
|
|
2970
|
+
*
|
|
2971
|
+
*/
|
|
2972
|
+
readonly lineItems: string[];
|
|
2973
|
+
/**
|
|
2974
|
+
* SKUs of the Line Items that are out of stock.
|
|
2975
|
+
*
|
|
2976
|
+
*
|
|
2977
|
+
*/
|
|
2978
|
+
readonly skus: string[];
|
|
2979
|
+
}
|
|
2980
|
+
/**
|
|
2981
|
+
* Returned when the service is having trouble handling the load.
|
|
2982
|
+
*
|
|
2983
|
+
* The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.
|
|
2984
|
+
*
|
|
2985
|
+
*/
|
|
2986
|
+
export interface GraphQLOverCapacityError {
|
|
2987
|
+
readonly code: 'OverCapacity';
|
|
2988
|
+
[key: string]: any;
|
|
2989
|
+
}
|
|
2990
|
+
/**
|
|
2991
|
+
* Returned when a given Price validity period conflicts with an existing one.
|
|
2992
|
+
* Every Standalone Price associated with the same SKU and with the same combination of currency, country, Customer Group, and Channel, must have non-overlapping validity periods (`validFrom` and `validUntil`).
|
|
2993
|
+
*
|
|
2994
|
+
* The error is returned as a failed response to the [Create StandalonePrice](ctp:api:endpoint:/{projectKey}/standalone-prices:POST) request.
|
|
2995
|
+
*
|
|
2996
|
+
*/
|
|
2997
|
+
export interface GraphQLOverlappingStandalonePriceValidityError {
|
|
2998
|
+
readonly code: 'OverlappingStandalonePriceValidity';
|
|
2999
|
+
[key: string]: any;
|
|
3000
|
+
/**
|
|
3001
|
+
* Reference to the conflicting Standalone Price.
|
|
3002
|
+
*
|
|
3003
|
+
*
|
|
3004
|
+
*/
|
|
3005
|
+
readonly conflictingStandalonePrice: StandalonePriceReference;
|
|
3006
|
+
/**
|
|
3007
|
+
* SKU of the [ProductVariant](ctp:api:type:ProductVariant) to which the conflicting Standalone Price is associated.
|
|
3008
|
+
*
|
|
3009
|
+
*
|
|
3010
|
+
*/
|
|
3011
|
+
readonly sku: string;
|
|
3012
|
+
/**
|
|
3013
|
+
* Currency code of the country.
|
|
3014
|
+
*
|
|
3015
|
+
*
|
|
3016
|
+
*/
|
|
3017
|
+
readonly currency: string;
|
|
3018
|
+
/**
|
|
3019
|
+
* Country code of the geographic location.
|
|
3020
|
+
*
|
|
3021
|
+
*
|
|
3022
|
+
*/
|
|
3023
|
+
readonly country?: string;
|
|
3024
|
+
/**
|
|
3025
|
+
* [CustomerGroup](ctp:api:type:CustomerGroup) for which the Standalone Price is valid.
|
|
3026
|
+
*
|
|
3027
|
+
*
|
|
3028
|
+
*/
|
|
3029
|
+
readonly customerGroup?: CustomerGroupResourceIdentifier;
|
|
3030
|
+
/**
|
|
3031
|
+
* [Channel](ctp:api:type:Channel) for which the Standalone Price is valid.
|
|
3032
|
+
*
|
|
3033
|
+
*
|
|
3034
|
+
*/
|
|
3035
|
+
readonly channel?: ChannelResourceIdentifier;
|
|
3036
|
+
/**
|
|
3037
|
+
* Date and time (UTC) from which the Standalone Price is valid.
|
|
3038
|
+
*
|
|
3039
|
+
*
|
|
3040
|
+
*/
|
|
3041
|
+
readonly validFrom?: string;
|
|
3042
|
+
/**
|
|
3043
|
+
* Date and time (UTC) until which the Standalone Price is valid.
|
|
3044
|
+
*
|
|
3045
|
+
*
|
|
3046
|
+
*/
|
|
3047
|
+
readonly validUntil?: string;
|
|
3048
|
+
/**
|
|
3049
|
+
* Date and time (UTC) from which the conflicting Standalone Price is valid.
|
|
3050
|
+
*
|
|
3051
|
+
*
|
|
3052
|
+
*/
|
|
3053
|
+
readonly conflictingValidFrom?: string;
|
|
3054
|
+
/**
|
|
3055
|
+
* Date and time (UTC) until which the conflicting Standalone Price is valid.
|
|
3056
|
+
*
|
|
3057
|
+
*
|
|
3058
|
+
*/
|
|
3059
|
+
readonly conflictingValidUntil?: string;
|
|
3060
|
+
}
|
|
3061
|
+
/**
|
|
3062
|
+
* Returned when a previous conflicting operation is still pending and needs to finish before the request can succeed.
|
|
3063
|
+
*
|
|
3064
|
+
* The client application should retry the request with exponential backoff up to a point where further delay is unacceptable.
|
|
3065
|
+
* If the error persists, report it to the [Composable Commerce support team](https://support.commercetools.com).
|
|
3066
|
+
*
|
|
3067
|
+
*/
|
|
3068
|
+
export interface GraphQLPendingOperationError {
|
|
3069
|
+
readonly code: 'PendingOperation';
|
|
3070
|
+
[key: string]: any;
|
|
3071
|
+
}
|
|
3072
|
+
/**
|
|
3073
|
+
* Returned when the Price or Tax Rate of some Line Items or Shipping Rate of some Shipping Methods changed since they were last added to the Cart.
|
|
3074
|
+
*
|
|
3075
|
+
* When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction).
|
|
3076
|
+
*
|
|
3077
|
+
* The error is also returned as a failed response to:
|
|
3078
|
+
*
|
|
3079
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/orders/quotes:POST) requests on Orders.
|
|
3080
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST), [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST), and [Create Order from Quote](ctp:api:endpoint:/{projectKey}/me/orders/quotes:POST) requests on My Orders.
|
|
3081
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
3082
|
+
*
|
|
3083
|
+
*/
|
|
3084
|
+
export interface GraphQLPriceChangedError {
|
|
3085
|
+
readonly code: 'PriceChanged';
|
|
3086
|
+
[key: string]: any;
|
|
3087
|
+
/**
|
|
3088
|
+
* Unique identifiers of the Line Items for which the Price or [TaxRate](ctp:api:type:TaxRate) has changed.
|
|
3089
|
+
*
|
|
3090
|
+
*
|
|
3091
|
+
*/
|
|
3092
|
+
readonly lineItems: string[];
|
|
3093
|
+
/**
|
|
3094
|
+
* `true` if the [ShippingRate](ctp:api:type:ShippingRate) has changed.
|
|
3095
|
+
*
|
|
3096
|
+
*
|
|
3097
|
+
*/
|
|
3098
|
+
readonly shipping: boolean;
|
|
3099
|
+
}
|
|
3100
|
+
/**
|
|
3101
|
+
* Returned when a Product is not assigned to the Product Selection.
|
|
3102
|
+
* The error is returned as a failed response either to the [Set Variant Selection](ctp:api:type:ProductSelectionSetVariantSelectionAction) or to the [Set Variant Exclusion](ctp:api:type:ProductSelectionSetVariantExclusionAction) update action.
|
|
3103
|
+
*
|
|
3104
|
+
*/
|
|
3105
|
+
export interface GraphQLProductAssignmentMissingError {
|
|
3106
|
+
readonly code: 'ProductAssignmentMissing';
|
|
3107
|
+
[key: string]: any;
|
|
3108
|
+
/**
|
|
3109
|
+
* [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
|
|
3110
|
+
*
|
|
3111
|
+
*
|
|
3112
|
+
*/
|
|
3113
|
+
readonly product: ProductReference;
|
|
3114
|
+
}
|
|
3115
|
+
/**
|
|
3116
|
+
* Returned when a Product is already assigned to a [Product Selection](/../api/projects/product-selections), but the Product Selection has either a different [Product Variant Selection](ctp:api:type:ProductVariantSelection) or a different [Product Variant Exclusion](ctp:api:type:ProductVariantExclusion).
|
|
3117
|
+
*
|
|
3118
|
+
* The error is returned as a failed response either to the [Add Product](ctp:api:type:ProductSelectionAddProductAction) or to the [Exclude Product](ctp:api:type:ProductSelectionExcludeProductAction) update action.
|
|
3119
|
+
*
|
|
3120
|
+
*/
|
|
3121
|
+
export interface GraphQLProductPresentWithDifferentVariantSelectionError {
|
|
3122
|
+
readonly code: 'ProductPresentWithDifferentVariantSelection';
|
|
3123
|
+
[key: string]: any;
|
|
3124
|
+
/**
|
|
3125
|
+
* [Reference](ctp:api:type:Reference) to the [Product](ctp:api:type:Product) for which the error was returned.
|
|
3126
|
+
*
|
|
3127
|
+
*
|
|
3128
|
+
*/
|
|
3129
|
+
readonly product: ProductReference;
|
|
3130
|
+
/**
|
|
3131
|
+
* Existing Product Variant Selection or Exclusion for the [Product](/../api/projects/products) in the [Product Selection](/../api/projects/product-selections).
|
|
3132
|
+
*
|
|
3133
|
+
*
|
|
3134
|
+
*/
|
|
3135
|
+
readonly existingVariantSelection: ProductVariantSelection;
|
|
3136
|
+
}
|
|
3137
|
+
/**
|
|
3138
|
+
* Returned when the languages set for a Store are not supported by the Project.
|
|
3139
|
+
*
|
|
3140
|
+
* The error is returned as a failed response to the [Set Languages](ctp:api:type:StoreSetLanguagesAction) update action.
|
|
3141
|
+
*
|
|
3142
|
+
*/
|
|
3143
|
+
export interface GraphQLProjectNotConfiguredForLanguagesError {
|
|
3144
|
+
readonly code: 'ProjectNotConfiguredForLanguages';
|
|
3145
|
+
[key: string]: any;
|
|
3146
|
+
/**
|
|
3147
|
+
* Languages configured for the Store.
|
|
3148
|
+
*
|
|
3149
|
+
*
|
|
3150
|
+
*/
|
|
3151
|
+
readonly languages?: string[];
|
|
3152
|
+
}
|
|
3153
|
+
export interface GraphQLQueryComplexityLimitExceededError {
|
|
3154
|
+
readonly code: 'QueryComplexityLimitExceeded';
|
|
3155
|
+
[key: string]: any;
|
|
3156
|
+
}
|
|
3157
|
+
/**
|
|
3158
|
+
* Returned when the query times out.
|
|
3159
|
+
*
|
|
3160
|
+
* If a query constantly times out, please check if it follows the [performance best practices](/../api/predicates/query#performance-considerations).
|
|
3161
|
+
*
|
|
3162
|
+
*/
|
|
3163
|
+
export interface GraphQLQueryTimedOutError {
|
|
3164
|
+
readonly code: 'QueryTimedOut';
|
|
3165
|
+
[key: string]: any;
|
|
3166
|
+
}
|
|
3167
|
+
/**
|
|
3168
|
+
* Returned when a resource cannot be deleted because it is being referenced by another resource.
|
|
3169
|
+
*
|
|
3170
|
+
*/
|
|
3171
|
+
export interface GraphQLReferenceExistsError {
|
|
3172
|
+
readonly code: 'ReferenceExists';
|
|
3173
|
+
[key: string]: any;
|
|
3174
|
+
/**
|
|
3175
|
+
* Type of referenced resource.
|
|
3176
|
+
*
|
|
3177
|
+
*
|
|
3178
|
+
*/
|
|
3179
|
+
readonly referencedBy?: ReferenceTypeId;
|
|
3180
|
+
}
|
|
3181
|
+
/**
|
|
3182
|
+
* Returned when a resource referenced by a [Reference](ctp:api:type:Reference) or a [ResourceIdentifier](ctp:api:type:ResourceIdentifier) could not be found.
|
|
3183
|
+
*
|
|
3184
|
+
*/
|
|
3185
|
+
export interface GraphQLReferencedResourceNotFoundError {
|
|
3186
|
+
readonly code: 'ReferencedResourceNotFound';
|
|
3187
|
+
[key: string]: any;
|
|
3188
|
+
/**
|
|
3189
|
+
* Type of referenced resource.
|
|
3190
|
+
*
|
|
3191
|
+
*
|
|
3192
|
+
*/
|
|
3193
|
+
readonly typeId: ReferenceTypeId;
|
|
3194
|
+
/**
|
|
3195
|
+
* Unique identifier of the referenced resource, if known.
|
|
3196
|
+
*
|
|
3197
|
+
*
|
|
3198
|
+
*/
|
|
3199
|
+
readonly id?: string;
|
|
3200
|
+
/**
|
|
3201
|
+
* User-defined unique identifier of the referenced resource, if known.
|
|
3202
|
+
*
|
|
3203
|
+
*
|
|
3204
|
+
*/
|
|
3205
|
+
readonly key?: string;
|
|
3206
|
+
}
|
|
3207
|
+
/**
|
|
3208
|
+
* Returned when a value is not defined for a required field.
|
|
3209
|
+
*
|
|
3210
|
+
*/
|
|
3211
|
+
export interface GraphQLRequiredFieldError {
|
|
3212
|
+
readonly code: 'RequiredField';
|
|
3213
|
+
[key: string]: any;
|
|
3214
|
+
/**
|
|
3215
|
+
* Name of the field missing the value.
|
|
3216
|
+
*
|
|
3217
|
+
*
|
|
3218
|
+
*/
|
|
3219
|
+
readonly field: string;
|
|
3220
|
+
}
|
|
3221
|
+
/**
|
|
3222
|
+
* Returned when the resource addressed by the request URL does not exist.
|
|
3223
|
+
*
|
|
3224
|
+
*/
|
|
3225
|
+
export interface GraphQLResourceNotFoundError {
|
|
3226
|
+
readonly code: 'ResourceNotFound';
|
|
3227
|
+
[key: string]: any;
|
|
3228
|
+
}
|
|
3229
|
+
/**
|
|
3230
|
+
* Returned when the resource exceeds the maximum allowed size of 16 MB.
|
|
3231
|
+
*
|
|
3232
|
+
*/
|
|
3233
|
+
export interface GraphQLResourceSizeLimitExceededError {
|
|
3234
|
+
readonly code: 'ResourceSizeLimitExceeded';
|
|
3235
|
+
[key: string]: any;
|
|
3236
|
+
}
|
|
3237
|
+
/**
|
|
3238
|
+
* Returned when the indexing of Product information is deactivated in a Project.
|
|
3239
|
+
*
|
|
3240
|
+
* To activate indexing, call [Change Product Search Indexing Enabled](ctp:api:type:ProjectChangeProductSearchIndexingEnabledAction) and set `enabled` to `true`.
|
|
3241
|
+
*
|
|
3242
|
+
*/
|
|
3243
|
+
export interface GraphQLSearchDeactivatedError {
|
|
3244
|
+
readonly code: 'SearchDeactivated';
|
|
3245
|
+
[key: string]: any;
|
|
3246
|
+
}
|
|
3247
|
+
/**
|
|
3248
|
+
* Returned when a search query could not be completed due to an unexpected failure.
|
|
3249
|
+
*
|
|
3250
|
+
*/
|
|
3251
|
+
export interface GraphQLSearchExecutionFailureError {
|
|
3252
|
+
readonly code: 'SearchExecutionFailure';
|
|
3253
|
+
[key: string]: any;
|
|
3254
|
+
}
|
|
3255
|
+
/**
|
|
3256
|
+
* Returned when a search facet path could not be found.
|
|
3257
|
+
*
|
|
3258
|
+
*/
|
|
3259
|
+
export interface GraphQLSearchFacetPathNotFoundError {
|
|
3260
|
+
readonly code: 'SearchFacetPathNotFound';
|
|
3261
|
+
[key: string]: any;
|
|
3262
|
+
}
|
|
3263
|
+
/**
|
|
3264
|
+
* Returned when the indexing of Product information is still in progress for Projects that have indexing activated.
|
|
3265
|
+
*
|
|
3266
|
+
*/
|
|
3267
|
+
export interface GraphQLSearchIndexingInProgressError {
|
|
3268
|
+
readonly code: 'SearchIndexingInProgress';
|
|
3269
|
+
[key: string]: any;
|
|
3270
|
+
}
|
|
3271
|
+
/**
|
|
3272
|
+
* Returned if the requested search service is not ready. The search might be deactivated or indexing is in progress.
|
|
3273
|
+
*
|
|
3274
|
+
*/
|
|
3275
|
+
export interface GraphQLSearchNotReadyError {
|
|
3276
|
+
readonly code: 'SearchNotReady';
|
|
3277
|
+
[key: string]: any;
|
|
3278
|
+
}
|
|
3279
|
+
/**
|
|
3280
|
+
* Returned when a [Discount predicate](/../api/predicates/predicate-operators) or [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions) is not semantically correct.
|
|
3281
|
+
*
|
|
3282
|
+
*/
|
|
3283
|
+
export interface GraphQLSemanticErrorError {
|
|
3284
|
+
readonly code: 'SemanticError';
|
|
3285
|
+
[key: string]: any;
|
|
3286
|
+
}
|
|
3287
|
+
/**
|
|
3288
|
+
* Returned when the Cart contains a [ShippingMethod](ctp:api:type:ShippingMethod) that is not allowed for the [Cart](ctp:api:type:Cart). In this case, the [ShippingMethodState](ctp:api:type:ShippingMethodState) value is `DoesNotMatchCart`.
|
|
3289
|
+
*
|
|
3290
|
+
* When a Cart is frozen, the error can be returned as a failed response to all update actions on [Carts](ctp:api:type:CartUpdateAction) and [My Carts](ctp:api:type:MyCartUpdateAction).
|
|
3291
|
+
*
|
|
3292
|
+
* The error is also returned as a failed response to:
|
|
3293
|
+
*
|
|
3294
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/orders:POST) requests on Orders.
|
|
3295
|
+
* - [Create Order from Cart](ctp:api:endpoint:/{projectKey}/me/orders:POST) and [Create Order in Store from Cart](ctp:api:endpoint:/{projectKey}/in-store/me/orders:POST) requests on My Orders.
|
|
3296
|
+
* - [Create Order from Cart in BusinessUnit](ctp:api:endpoint:/{projectKey}/as-associate/{associateId}/in-business-unit/key={businessUnitKey}/orders:POST) request on Associate Orders.
|
|
3297
|
+
*
|
|
3298
|
+
*/
|
|
3299
|
+
export interface GraphQLShippingMethodDoesNotMatchCartError {
|
|
3300
|
+
readonly code: 'ShippingMethodDoesNotMatchCart';
|
|
3301
|
+
[key: string]: any;
|
|
3302
|
+
}
|
|
3303
|
+
/**
|
|
3304
|
+
* Returned when a Cart Discount cannot be created or assigned to a Store as the [limit](/../api/limits#cart-discounts) for active Cart Discounts in a Store has been reached for one or more Stores in the request.
|
|
3305
|
+
*
|
|
3306
|
+
* The error is returned as a failed response to:
|
|
3307
|
+
*
|
|
3308
|
+
* - [Create CartDiscount](ctp:api:endpoint:/{projectKey}/cart-discounts:POST) and [Create CartDiscount in Store](ctp:api:endpoint:/{projectKey}/in-store/key={storeKey}/cart-discounts:POST) requests
|
|
3309
|
+
* - [Add Store](ctp:api:type:CartDiscountAddStoreAction) and [Set Store](ctp:api:type:CartDiscountSetStoresAction) update actions
|
|
3310
|
+
*
|
|
3311
|
+
*/
|
|
3312
|
+
export interface GraphQLStoreCartDiscountsLimitReachedError {
|
|
3313
|
+
readonly code: 'StoreCartDiscountsLimitReached';
|
|
3314
|
+
[key: string]: any;
|
|
3315
|
+
/**
|
|
3316
|
+
* Stores for which the limit for active Cart Discounts that can exist has been reached.
|
|
3317
|
+
*
|
|
3318
|
+
*
|
|
3319
|
+
*/
|
|
3320
|
+
readonly stores: StoreKeyReference[];
|
|
3321
|
+
}
|
|
3322
|
+
/**
|
|
3323
|
+
* Returned when a [Discount predicate](/../api/predicates/predicate-operators), [API Extension predicate](/../api/predicates/query#using-predicates-in-conditional-api-extensions), or [search query](/../api/projects/products-search) does not have the correct syntax.
|
|
3324
|
+
*
|
|
3325
|
+
*/
|
|
3326
|
+
export interface GraphQLSyntaxErrorError {
|
|
3327
|
+
readonly code: 'SyntaxError';
|
|
3328
|
+
[key: string]: any;
|
|
3329
|
+
}
|
|
3330
|
+
//# sourceMappingURL=error.d.ts.map
|