@gradientedge/commercetools-utils 5.9.1 → 5.11.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/CommercetoolsApi.d.ts +1252 -0
- package/dist/cjs/api/CommercetoolsApi.d.ts.map +1 -0
- package/dist/cjs/api/CommercetoolsApi.js +2106 -0
- package/dist/cjs/api/CommercetoolsApi.js.map +1 -0
- package/dist/cjs/api/index.d.ts +3 -0
- package/dist/cjs/api/index.d.ts.map +1 -0
- package/dist/cjs/api/index.js +19 -0
- package/dist/cjs/api/index.js.map +1 -0
- package/dist/cjs/api/types.d.ts +33 -0
- package/dist/cjs/api/types.d.ts.map +1 -0
- package/dist/cjs/api/types.js +3 -0
- package/dist/cjs/api/types.js.map +1 -0
- package/dist/cjs/auth/CommercetoolsAuth.d.ts +182 -0
- package/dist/cjs/auth/CommercetoolsAuth.d.ts.map +1 -0
- package/dist/cjs/auth/CommercetoolsAuth.js +238 -0
- package/dist/cjs/auth/CommercetoolsAuth.js.map +1 -0
- package/dist/cjs/auth/CommercetoolsAuthApi.d.ts +83 -0
- package/dist/cjs/auth/CommercetoolsAuthApi.d.ts.map +1 -0
- package/dist/cjs/auth/CommercetoolsAuthApi.js +169 -0
- package/dist/cjs/auth/CommercetoolsAuthApi.js.map +1 -0
- package/dist/cjs/auth/CommercetoolsGrant.d.ts +66 -0
- package/dist/cjs/auth/CommercetoolsGrant.d.ts.map +1 -0
- package/dist/cjs/auth/CommercetoolsGrant.js +99 -0
- package/dist/cjs/auth/CommercetoolsGrant.js.map +1 -0
- package/dist/cjs/auth/constants.d.ts +7 -0
- package/dist/cjs/auth/constants.d.ts.map +1 -0
- package/dist/cjs/auth/constants.js +31 -0
- package/dist/cjs/auth/constants.js.map +1 -0
- package/dist/cjs/auth/index.d.ts +4 -0
- package/dist/cjs/auth/index.d.ts.map +1 -0
- package/dist/cjs/auth/index.js +19 -0
- package/dist/cjs/auth/index.js.map +1 -0
- package/dist/cjs/auth/scopes.d.ts +11 -0
- package/dist/cjs/auth/scopes.d.ts.map +1 -0
- package/dist/cjs/auth/scopes.js +30 -0
- package/dist/cjs/auth/scopes.js.map +1 -0
- package/dist/cjs/auth/types.d.ts +118 -0
- package/dist/cjs/auth/types.d.ts.map +1 -0
- package/dist/cjs/auth/types.js +28 -0
- package/dist/cjs/auth/types.js.map +1 -0
- package/dist/{typings → cjs}/auth/utils.d.ts +1 -0
- package/dist/cjs/auth/utils.d.ts.map +1 -0
- package/dist/cjs/auth/utils.js +14 -0
- package/dist/cjs/auth/utils.js.map +1 -0
- package/dist/cjs/constants.d.ts +33 -0
- package/dist/cjs/constants.d.ts.map +1 -0
- package/dist/cjs/constants.js +46 -0
- package/dist/cjs/constants.js.map +1 -0
- package/dist/cjs/error/CommercetoolsError.d.ts +34 -0
- package/dist/cjs/error/CommercetoolsError.d.ts.map +1 -0
- package/dist/cjs/error/CommercetoolsError.js +113 -0
- package/dist/cjs/error/CommercetoolsError.js.map +1 -0
- package/dist/cjs/error/index.d.ts +2 -0
- package/dist/cjs/error/index.d.ts.map +1 -0
- package/dist/cjs/error/index.js +18 -0
- package/dist/cjs/error/index.js.map +1 -0
- package/dist/cjs/index.d.ts +8 -0
- package/dist/cjs/index.d.ts.map +1 -0
- package/dist/cjs/index.js +26 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/models/associate-role.d.ts +319 -0
- package/dist/cjs/models/associate-role.d.ts.map +1 -0
- package/dist/cjs/models/associate-role.js +8 -0
- package/dist/cjs/models/associate-role.js.map +1 -0
- package/dist/cjs/models/attribute-group.d.ts +253 -0
- package/dist/cjs/models/attribute-group.d.ts.map +1 -0
- package/dist/cjs/models/attribute-group.js +8 -0
- package/dist/cjs/models/attribute-group.js.map +1 -0
- package/dist/cjs/models/business-unit.d.ts +1197 -0
- package/dist/cjs/models/business-unit.d.ts.map +1 -0
- package/dist/cjs/models/business-unit.js +8 -0
- package/dist/cjs/models/business-unit.js.map +1 -0
- package/dist/cjs/models/cart-discount.d.ts +716 -0
- package/dist/cjs/models/cart-discount.d.ts.map +1 -0
- package/dist/cjs/models/cart-discount.js +8 -0
- package/dist/cjs/models/cart-discount.js.map +1 -0
- package/dist/cjs/models/cart.d.ts +3350 -0
- package/dist/cjs/models/cart.d.ts.map +1 -0
- package/dist/cjs/models/cart.js +8 -0
- package/dist/cjs/models/cart.js.map +1 -0
- package/dist/cjs/models/category.d.ts +634 -0
- package/dist/cjs/models/category.d.ts.map +1 -0
- package/dist/cjs/models/category.js +8 -0
- package/dist/cjs/models/category.js.map +1 -0
- package/dist/cjs/models/channel.d.ts +379 -0
- package/dist/cjs/models/channel.d.ts.map +1 -0
- package/dist/cjs/models/channel.js +8 -0
- package/dist/cjs/models/channel.js.map +1 -0
- package/dist/cjs/models/common.d.ts +1096 -0
- package/dist/cjs/models/common.d.ts.map +1 -0
- package/dist/cjs/models/common.js +8 -0
- package/dist/cjs/models/common.js.map +1 -0
- package/dist/cjs/models/custom-object.d.ts +151 -0
- package/dist/cjs/models/custom-object.d.ts.map +1 -0
- package/dist/cjs/models/custom-object.js +8 -0
- package/dist/cjs/models/custom-object.js.map +1 -0
- package/dist/cjs/models/customer-group.d.ts +235 -0
- package/dist/cjs/models/customer-group.d.ts.map +1 -0
- package/dist/cjs/models/customer-group.js +8 -0
- package/dist/cjs/models/customer-group.js.map +1 -0
- package/dist/cjs/models/customer.d.ts +1221 -0
- package/dist/cjs/models/customer.d.ts.map +1 -0
- package/dist/cjs/models/customer.js +8 -0
- package/dist/cjs/models/customer.js.map +1 -0
- package/dist/cjs/models/discount-code.d.ts +439 -0
- package/dist/cjs/models/discount-code.d.ts.map +1 -0
- package/dist/cjs/models/discount-code.js +8 -0
- package/dist/cjs/models/discount-code.js.map +1 -0
- package/dist/cjs/models/error.d.ts +3062 -0
- package/dist/cjs/models/error.d.ts.map +1 -0
- package/dist/cjs/models/error.js +8 -0
- package/dist/cjs/models/error.js.map +1 -0
- package/dist/cjs/models/extension.d.ts +335 -0
- package/dist/cjs/models/extension.d.ts.map +1 -0
- package/dist/cjs/models/extension.js +8 -0
- package/dist/cjs/models/extension.js.map +1 -0
- package/dist/cjs/models/graph-ql.d.ts +63 -0
- package/dist/cjs/models/graph-ql.d.ts.map +1 -0
- package/dist/cjs/models/graph-ql.js +8 -0
- package/dist/cjs/models/graph-ql.js.map +1 -0
- package/dist/cjs/models/index.d.ts +42 -0
- package/dist/cjs/models/index.d.ts.map +1 -0
- package/dist/cjs/models/index.js +58 -0
- package/dist/cjs/models/index.js.map +1 -0
- package/dist/cjs/models/inventory.d.ts +327 -0
- package/dist/cjs/models/inventory.d.ts.map +1 -0
- package/dist/cjs/models/inventory.js +8 -0
- package/dist/cjs/models/inventory.js.map +1 -0
- package/dist/cjs/models/me.d.ts +2483 -0
- package/dist/cjs/models/me.d.ts.map +1 -0
- package/dist/cjs/models/me.js +8 -0
- package/dist/cjs/models/me.js.map +1 -0
- package/dist/cjs/models/message.d.ts +15095 -0
- package/dist/cjs/models/message.d.ts.map +1 -0
- package/dist/cjs/models/message.js +8 -0
- package/dist/cjs/models/message.js.map +1 -0
- package/dist/cjs/models/order-edit.d.ts +1645 -0
- package/dist/cjs/models/order-edit.d.ts.map +1 -0
- package/dist/cjs/models/order-edit.js +8 -0
- package/dist/cjs/models/order-edit.js.map +1 -0
- package/dist/{typings → cjs}/models/order.d.ts +1490 -15
- package/dist/cjs/models/order.d.ts.map +1 -0
- package/dist/cjs/models/order.js +8 -0
- package/dist/cjs/models/order.js.map +1 -0
- package/dist/cjs/models/payment.d.ts +734 -0
- package/dist/cjs/models/payment.d.ts.map +1 -0
- package/dist/cjs/models/payment.js +8 -0
- package/dist/cjs/models/payment.js.map +1 -0
- package/dist/cjs/models/product-discount.d.ts +461 -0
- package/dist/cjs/models/product-discount.d.ts.map +1 -0
- package/dist/cjs/models/product-discount.js +8 -0
- package/dist/cjs/models/product-discount.js.map +1 -0
- package/dist/cjs/models/product-selection.d.ts +638 -0
- package/dist/cjs/models/product-selection.d.ts.map +1 -0
- package/dist/cjs/models/product-selection.js +8 -0
- package/dist/cjs/models/product-selection.js.map +1 -0
- package/dist/cjs/models/product-type.d.ts +774 -0
- package/dist/cjs/models/product-type.d.ts.map +1 -0
- package/dist/cjs/models/product-type.js +8 -0
- package/dist/cjs/models/product-type.js.map +1 -0
- package/dist/cjs/models/product.d.ts +2282 -0
- package/dist/cjs/models/product.d.ts.map +1 -0
- package/dist/cjs/models/product.js +8 -0
- package/dist/cjs/models/product.js.map +1 -0
- package/dist/cjs/models/project.d.ts +381 -0
- package/dist/cjs/models/project.d.ts.map +1 -0
- package/dist/cjs/models/project.js +8 -0
- package/dist/cjs/models/project.js.map +1 -0
- package/dist/cjs/models/quote-request.d.ts +430 -0
- package/dist/cjs/models/quote-request.d.ts.map +1 -0
- package/dist/cjs/models/quote-request.js +8 -0
- package/dist/cjs/models/quote-request.js.map +1 -0
- package/dist/cjs/models/quote.d.ts +458 -0
- package/dist/cjs/models/quote.d.ts.map +1 -0
- package/dist/cjs/models/quote.js +8 -0
- package/dist/cjs/models/quote.js.map +1 -0
- package/dist/cjs/models/review.d.ts +435 -0
- package/dist/cjs/models/review.d.ts.map +1 -0
- package/dist/cjs/models/review.js +8 -0
- package/dist/cjs/models/review.js.map +1 -0
- package/dist/cjs/models/scalar-types.d.ts +9 -0
- package/dist/cjs/models/scalar-types.d.ts.map +1 -0
- package/dist/cjs/models/scalar-types.js +8 -0
- package/dist/cjs/models/scalar-types.js.map +1 -0
- package/dist/cjs/models/shipping-method.d.ts +569 -0
- package/dist/cjs/models/shipping-method.d.ts.map +1 -0
- package/dist/cjs/models/shipping-method.js +8 -0
- package/dist/cjs/models/shipping-method.js.map +1 -0
- package/dist/cjs/models/shopping-list.d.ts +844 -0
- package/dist/cjs/models/shopping-list.d.ts.map +1 -0
- package/dist/cjs/models/shopping-list.js +8 -0
- package/dist/cjs/models/shopping-list.js.map +1 -0
- package/dist/cjs/models/staged-quote.d.ts +338 -0
- package/dist/cjs/models/staged-quote.d.ts.map +1 -0
- package/dist/cjs/models/staged-quote.js +8 -0
- package/dist/cjs/models/staged-quote.js.map +1 -0
- package/dist/cjs/models/standalone-price.d.ts +410 -0
- package/dist/cjs/models/standalone-price.d.ts.map +1 -0
- package/dist/cjs/models/standalone-price.js +8 -0
- package/dist/cjs/models/standalone-price.js.map +1 -0
- package/dist/cjs/models/state.d.ts +341 -0
- package/dist/cjs/models/state.d.ts.map +1 -0
- package/dist/cjs/models/state.js +8 -0
- package/dist/cjs/models/state.js.map +1 -0
- package/dist/cjs/models/store-country.d.ts +14 -0
- package/dist/cjs/models/store-country.d.ts.map +1 -0
- package/dist/cjs/models/store-country.js +8 -0
- package/dist/cjs/models/store-country.js.map +1 -0
- package/dist/cjs/models/store.d.ts +547 -0
- package/dist/cjs/models/store.d.ts.map +1 -0
- package/dist/cjs/models/store.js +8 -0
- package/dist/cjs/models/store.js.map +1 -0
- package/dist/cjs/models/subscription.d.ts +717 -0
- package/dist/cjs/models/subscription.d.ts.map +1 -0
- package/dist/cjs/models/subscription.js +8 -0
- package/dist/cjs/models/subscription.js.map +1 -0
- package/dist/cjs/models/tax-category.d.ts +376 -0
- package/dist/cjs/models/tax-category.d.ts.map +1 -0
- package/dist/cjs/models/tax-category.js +8 -0
- package/dist/cjs/models/tax-category.js.map +1 -0
- package/dist/cjs/models/type.d.ts +645 -0
- package/dist/cjs/models/type.d.ts.map +1 -0
- package/dist/cjs/models/type.js +8 -0
- package/dist/cjs/models/type.js.map +1 -0
- package/dist/cjs/models/zone.d.ts +234 -0
- package/dist/cjs/models/zone.d.ts.map +1 -0
- package/dist/cjs/models/zone.js +8 -0
- package/dist/cjs/models/zone.js.map +1 -0
- package/dist/cjs/package.json +1 -0
- package/dist/cjs/request/index.d.ts +3 -0
- package/dist/cjs/request/index.d.ts.map +1 -0
- package/dist/cjs/request/index.js +19 -0
- package/dist/cjs/request/index.js.map +1 -0
- package/dist/cjs/request/is-retryable-error.d.ts +6 -0
- package/dist/cjs/request/is-retryable-error.d.ts.map +1 -0
- package/dist/cjs/request/is-retryable-error.js +28 -0
- package/dist/cjs/request/is-retryable-error.js.map +1 -0
- package/dist/{typings → cjs}/request/request-executor.d.ts +3 -2
- package/dist/cjs/request/request-executor.d.ts.map +1 -0
- package/dist/cjs/request/request-executor.js +23 -0
- package/dist/cjs/request/request-executor.js.map +1 -0
- package/dist/{typings → cjs}/request/request.d.ts +3 -2
- package/dist/cjs/request/request.d.ts.map +1 -0
- package/dist/cjs/request/request.js +84 -0
- package/dist/cjs/request/request.js.map +1 -0
- package/dist/cjs/request/transform-error.d.ts +7 -0
- package/dist/cjs/request/transform-error.d.ts.map +1 -0
- package/dist/cjs/request/transform-error.js +16 -0
- package/dist/cjs/request/transform-error.js.map +1 -0
- package/dist/{typings → cjs}/types.d.ts +39 -1
- package/dist/cjs/types.d.ts.map +1 -0
- package/dist/cjs/types.js +16 -0
- package/dist/cjs/types.js.map +1 -0
- package/dist/{typings → cjs}/utils/axios/convert-error.d.ts +2 -1
- package/dist/cjs/utils/axios/convert-error.d.ts.map +1 -0
- package/dist/cjs/utils/axios/convert-error.js +28 -0
- package/dist/cjs/utils/axios/convert-error.js.map +1 -0
- package/dist/{typings → cjs}/utils/axios/convert-response.d.ts +2 -1
- package/dist/cjs/utils/axios/convert-response.d.ts.map +1 -0
- package/dist/cjs/utils/axios/convert-response.js +23 -0
- package/dist/cjs/utils/axios/convert-response.js.map +1 -0
- package/dist/{typings → cjs}/utils/axios/create-instance.d.ts +5 -0
- package/dist/cjs/utils/axios/create-instance.d.ts.map +1 -0
- package/dist/cjs/utils/axios/create-instance.js +30 -0
- package/dist/cjs/utils/axios/create-instance.js.map +1 -0
- package/dist/{typings → cjs}/utils/axios/extract-headers.d.ts +1 -0
- package/dist/cjs/utils/axios/extract-headers.d.ts.map +1 -0
- package/dist/cjs/utils/axios/extract-headers.js +23 -0
- package/dist/cjs/utils/axios/extract-headers.js.map +1 -0
- package/dist/cjs/utils/axios/index.d.ts +5 -0
- package/dist/cjs/utils/axios/index.d.ts.map +1 -0
- package/dist/cjs/utils/axios/index.js +21 -0
- package/dist/cjs/utils/axios/index.js.map +1 -0
- package/dist/cjs/utils/calculate-delay.d.ts +7 -0
- package/dist/cjs/utils/calculate-delay.d.ts.map +1 -0
- package/dist/cjs/utils/calculate-delay.js +30 -0
- package/dist/cjs/utils/calculate-delay.js.map +1 -0
- package/dist/cjs/utils/ensure-non-empty-string.d.ts +16 -0
- package/dist/cjs/utils/ensure-non-empty-string.d.ts.map +1 -0
- package/dist/cjs/utils/ensure-non-empty-string.js +16 -0
- package/dist/cjs/utils/ensure-non-empty-string.js.map +1 -0
- package/dist/cjs/utils/format.d.ts +11 -0
- package/dist/cjs/utils/format.d.ts.map +1 -0
- package/dist/cjs/utils/format.js +48 -0
- package/dist/cjs/utils/format.js.map +1 -0
- package/dist/cjs/utils/get-attribute-value.d.ts +17 -0
- package/dist/cjs/utils/get-attribute-value.d.ts.map +1 -0
- package/dist/cjs/utils/get-attribute-value.js +19 -0
- package/dist/cjs/utils/get-attribute-value.js.map +1 -0
- package/dist/cjs/utils/index.d.ts +9 -0
- package/dist/cjs/utils/index.d.ts.map +1 -0
- package/dist/cjs/utils/index.js +25 -0
- package/dist/cjs/utils/index.js.map +1 -0
- package/dist/cjs/utils/mask.d.ts +28 -0
- package/dist/cjs/utils/mask.d.ts.map +1 -0
- package/dist/cjs/utils/mask.js +63 -0
- package/dist/cjs/utils/mask.js.map +1 -0
- package/dist/cjs/utils/plain-clone.d.ts +14 -0
- package/dist/cjs/utils/plain-clone.d.ts.map +1 -0
- package/dist/cjs/utils/plain-clone.js +41 -0
- package/dist/cjs/utils/plain-clone.js.map +1 -0
- package/dist/cjs/utils/retry-on-conflict.d.ts +99 -0
- package/dist/cjs/utils/retry-on-conflict.d.ts.map +1 -0
- package/dist/cjs/utils/retry-on-conflict.js +109 -0
- package/dist/cjs/utils/retry-on-conflict.js.map +1 -0
- package/dist/cjs/utils/useragent.d.ts +10 -0
- package/dist/cjs/utils/useragent.d.ts.map +1 -0
- package/dist/cjs/utils/useragent.js +21 -0
- package/dist/cjs/utils/useragent.js.map +1 -0
- package/dist/mjs/api/CommercetoolsApi.d.ts +1252 -0
- package/dist/mjs/api/CommercetoolsApi.d.ts.map +1 -0
- package/dist/mjs/api/CommercetoolsApi.js +2102 -0
- package/dist/mjs/api/CommercetoolsApi.js.map +1 -0
- package/dist/mjs/api/index.d.ts +3 -0
- package/dist/mjs/api/index.d.ts.map +1 -0
- package/dist/mjs/api/index.js +3 -0
- package/dist/mjs/api/index.js.map +1 -0
- package/dist/mjs/api/types.d.ts +33 -0
- package/dist/mjs/api/types.d.ts.map +1 -0
- package/dist/mjs/api/types.js +2 -0
- package/dist/mjs/api/types.js.map +1 -0
- package/dist/mjs/auth/CommercetoolsAuth.d.ts +182 -0
- package/dist/mjs/auth/CommercetoolsAuth.d.ts.map +1 -0
- package/dist/mjs/auth/CommercetoolsAuth.js +234 -0
- package/dist/mjs/auth/CommercetoolsAuth.js.map +1 -0
- package/dist/mjs/auth/CommercetoolsAuthApi.d.ts +83 -0
- package/dist/mjs/auth/CommercetoolsAuthApi.d.ts.map +1 -0
- package/dist/mjs/auth/CommercetoolsAuthApi.js +165 -0
- package/dist/mjs/auth/CommercetoolsAuthApi.js.map +1 -0
- package/dist/mjs/auth/CommercetoolsGrant.d.ts +66 -0
- package/dist/mjs/auth/CommercetoolsGrant.d.ts.map +1 -0
- package/dist/mjs/auth/CommercetoolsGrant.js +95 -0
- package/dist/mjs/auth/CommercetoolsGrant.js.map +1 -0
- package/dist/mjs/auth/constants.d.ts +7 -0
- package/dist/mjs/auth/constants.d.ts.map +1 -0
- package/dist/mjs/auth/constants.js +28 -0
- package/dist/mjs/auth/constants.js.map +1 -0
- package/dist/mjs/auth/index.d.ts +4 -0
- package/dist/mjs/auth/index.d.ts.map +1 -0
- package/dist/mjs/auth/index.js +3 -0
- package/dist/mjs/auth/index.js.map +1 -0
- package/dist/mjs/auth/scopes.d.ts +11 -0
- package/dist/mjs/auth/scopes.d.ts.map +1 -0
- package/dist/mjs/auth/scopes.js +25 -0
- package/dist/mjs/auth/scopes.js.map +1 -0
- package/dist/mjs/auth/types.d.ts +118 -0
- package/dist/mjs/auth/types.d.ts.map +1 -0
- package/dist/mjs/auth/types.js +25 -0
- package/dist/mjs/auth/types.js.map +1 -0
- package/dist/mjs/auth/utils.d.ts +2 -0
- package/dist/mjs/auth/utils.d.ts.map +1 -0
- package/dist/mjs/auth/utils.js +10 -0
- package/dist/mjs/auth/utils.js.map +1 -0
- package/dist/mjs/constants.d.ts +33 -0
- package/dist/mjs/constants.d.ts.map +1 -0
- package/dist/mjs/constants.js +43 -0
- package/dist/mjs/constants.js.map +1 -0
- package/dist/mjs/error/CommercetoolsError.d.ts +34 -0
- package/dist/mjs/error/CommercetoolsError.d.ts.map +1 -0
- package/dist/mjs/error/CommercetoolsError.js +106 -0
- package/dist/mjs/error/CommercetoolsError.js.map +1 -0
- package/dist/mjs/error/index.d.ts +2 -0
- package/dist/mjs/error/index.d.ts.map +1 -0
- package/dist/mjs/error/index.js +2 -0
- package/dist/mjs/error/index.js.map +1 -0
- package/dist/mjs/index.d.ts +8 -0
- package/dist/mjs/index.d.ts.map +1 -0
- package/dist/mjs/index.js +8 -0
- package/dist/mjs/index.js.map +1 -0
- package/dist/mjs/models/associate-role.d.ts +319 -0
- package/dist/mjs/models/associate-role.d.ts.map +1 -0
- package/dist/mjs/models/associate-role.js +7 -0
- package/dist/mjs/models/associate-role.js.map +1 -0
- package/dist/mjs/models/attribute-group.d.ts +253 -0
- package/dist/mjs/models/attribute-group.d.ts.map +1 -0
- package/dist/mjs/models/attribute-group.js +7 -0
- package/dist/mjs/models/attribute-group.js.map +1 -0
- package/dist/mjs/models/business-unit.d.ts +1197 -0
- package/dist/mjs/models/business-unit.d.ts.map +1 -0
- package/dist/mjs/models/business-unit.js +7 -0
- package/dist/mjs/models/business-unit.js.map +1 -0
- package/dist/mjs/models/cart-discount.d.ts +716 -0
- package/dist/mjs/models/cart-discount.d.ts.map +1 -0
- package/dist/mjs/models/cart-discount.js +7 -0
- package/dist/mjs/models/cart-discount.js.map +1 -0
- package/dist/mjs/models/cart.d.ts +3350 -0
- package/dist/mjs/models/cart.d.ts.map +1 -0
- package/dist/mjs/models/cart.js +7 -0
- package/dist/mjs/models/cart.js.map +1 -0
- package/dist/mjs/models/category.d.ts +634 -0
- package/dist/mjs/models/category.d.ts.map +1 -0
- package/dist/mjs/models/category.js +7 -0
- package/dist/mjs/models/category.js.map +1 -0
- package/dist/mjs/models/channel.d.ts +379 -0
- package/dist/mjs/models/channel.d.ts.map +1 -0
- package/dist/mjs/models/channel.js +7 -0
- package/dist/mjs/models/channel.js.map +1 -0
- package/dist/mjs/models/common.d.ts +1096 -0
- package/dist/mjs/models/common.d.ts.map +1 -0
- package/dist/mjs/models/common.js +7 -0
- package/dist/mjs/models/common.js.map +1 -0
- package/dist/mjs/models/custom-object.d.ts +151 -0
- package/dist/mjs/models/custom-object.d.ts.map +1 -0
- package/dist/mjs/models/custom-object.js +7 -0
- package/dist/mjs/models/custom-object.js.map +1 -0
- package/dist/mjs/models/customer-group.d.ts +235 -0
- package/dist/mjs/models/customer-group.d.ts.map +1 -0
- package/dist/mjs/models/customer-group.js +7 -0
- package/dist/mjs/models/customer-group.js.map +1 -0
- package/dist/mjs/models/customer.d.ts +1221 -0
- package/dist/mjs/models/customer.d.ts.map +1 -0
- package/dist/mjs/models/customer.js +7 -0
- package/dist/mjs/models/customer.js.map +1 -0
- package/dist/mjs/models/discount-code.d.ts +439 -0
- package/dist/mjs/models/discount-code.d.ts.map +1 -0
- package/dist/mjs/models/discount-code.js +7 -0
- package/dist/mjs/models/discount-code.js.map +1 -0
- package/dist/mjs/models/error.d.ts +3062 -0
- package/dist/mjs/models/error.d.ts.map +1 -0
- package/dist/mjs/models/error.js +7 -0
- package/dist/mjs/models/error.js.map +1 -0
- package/dist/mjs/models/extension.d.ts +335 -0
- package/dist/mjs/models/extension.d.ts.map +1 -0
- package/dist/mjs/models/extension.js +7 -0
- package/dist/mjs/models/extension.js.map +1 -0
- package/dist/mjs/models/graph-ql.d.ts +63 -0
- package/dist/mjs/models/graph-ql.d.ts.map +1 -0
- package/dist/mjs/models/graph-ql.js +7 -0
- package/dist/mjs/models/graph-ql.js.map +1 -0
- package/dist/mjs/models/index.d.ts +42 -0
- package/dist/mjs/models/index.d.ts.map +1 -0
- package/dist/mjs/models/index.js +42 -0
- package/dist/mjs/models/index.js.map +1 -0
- package/dist/mjs/models/inventory.d.ts +327 -0
- package/dist/mjs/models/inventory.d.ts.map +1 -0
- package/dist/mjs/models/inventory.js +7 -0
- package/dist/mjs/models/inventory.js.map +1 -0
- package/dist/mjs/models/me.d.ts +2483 -0
- package/dist/mjs/models/me.d.ts.map +1 -0
- package/dist/mjs/models/me.js +7 -0
- package/dist/mjs/models/me.js.map +1 -0
- package/dist/mjs/models/message.d.ts +15095 -0
- package/dist/mjs/models/message.d.ts.map +1 -0
- package/dist/mjs/models/message.js +7 -0
- package/dist/mjs/models/message.js.map +1 -0
- package/dist/mjs/models/order-edit.d.ts +1645 -0
- package/dist/mjs/models/order-edit.d.ts.map +1 -0
- package/dist/mjs/models/order-edit.js +7 -0
- package/dist/mjs/models/order-edit.js.map +1 -0
- package/dist/mjs/models/order.d.ts +2157 -0
- package/dist/mjs/models/order.d.ts.map +1 -0
- package/dist/mjs/models/order.js +7 -0
- package/dist/mjs/models/order.js.map +1 -0
- package/dist/mjs/models/payment.d.ts +734 -0
- package/dist/mjs/models/payment.d.ts.map +1 -0
- package/dist/mjs/models/payment.js +7 -0
- package/dist/mjs/models/payment.js.map +1 -0
- package/dist/mjs/models/product-discount.d.ts +461 -0
- package/dist/mjs/models/product-discount.d.ts.map +1 -0
- package/dist/mjs/models/product-discount.js +7 -0
- package/dist/mjs/models/product-discount.js.map +1 -0
- package/dist/mjs/models/product-selection.d.ts +638 -0
- package/dist/mjs/models/product-selection.d.ts.map +1 -0
- package/dist/mjs/models/product-selection.js +7 -0
- package/dist/mjs/models/product-selection.js.map +1 -0
- package/dist/mjs/models/product-type.d.ts +774 -0
- package/dist/mjs/models/product-type.d.ts.map +1 -0
- package/dist/mjs/models/product-type.js +7 -0
- package/dist/mjs/models/product-type.js.map +1 -0
- package/dist/mjs/models/product.d.ts +2282 -0
- package/dist/mjs/models/product.d.ts.map +1 -0
- package/dist/mjs/models/product.js +7 -0
- package/dist/mjs/models/product.js.map +1 -0
- package/dist/mjs/models/project.d.ts +381 -0
- package/dist/mjs/models/project.d.ts.map +1 -0
- package/dist/mjs/models/project.js +7 -0
- package/dist/mjs/models/project.js.map +1 -0
- package/dist/mjs/models/quote-request.d.ts +430 -0
- package/dist/mjs/models/quote-request.d.ts.map +1 -0
- package/dist/mjs/models/quote-request.js +7 -0
- package/dist/mjs/models/quote-request.js.map +1 -0
- package/dist/mjs/models/quote.d.ts +458 -0
- package/dist/mjs/models/quote.d.ts.map +1 -0
- package/dist/mjs/models/quote.js +7 -0
- package/dist/mjs/models/quote.js.map +1 -0
- package/dist/mjs/models/review.d.ts +435 -0
- package/dist/mjs/models/review.d.ts.map +1 -0
- package/dist/mjs/models/review.js +7 -0
- package/dist/mjs/models/review.js.map +1 -0
- package/dist/mjs/models/scalar-types.d.ts +9 -0
- package/dist/mjs/models/scalar-types.d.ts.map +1 -0
- package/dist/mjs/models/scalar-types.js +7 -0
- package/dist/mjs/models/scalar-types.js.map +1 -0
- package/dist/mjs/models/shipping-method.d.ts +569 -0
- package/dist/mjs/models/shipping-method.d.ts.map +1 -0
- package/dist/mjs/models/shipping-method.js +7 -0
- package/dist/mjs/models/shipping-method.js.map +1 -0
- package/dist/mjs/models/shopping-list.d.ts +844 -0
- package/dist/mjs/models/shopping-list.d.ts.map +1 -0
- package/dist/mjs/models/shopping-list.js +7 -0
- package/dist/mjs/models/shopping-list.js.map +1 -0
- package/dist/mjs/models/staged-quote.d.ts +338 -0
- package/dist/mjs/models/staged-quote.d.ts.map +1 -0
- package/dist/mjs/models/staged-quote.js +7 -0
- package/dist/mjs/models/staged-quote.js.map +1 -0
- package/dist/mjs/models/standalone-price.d.ts +410 -0
- package/dist/mjs/models/standalone-price.d.ts.map +1 -0
- package/dist/mjs/models/standalone-price.js +7 -0
- package/dist/mjs/models/standalone-price.js.map +1 -0
- package/dist/mjs/models/state.d.ts +341 -0
- package/dist/mjs/models/state.d.ts.map +1 -0
- package/dist/mjs/models/state.js +7 -0
- package/dist/mjs/models/state.js.map +1 -0
- package/dist/mjs/models/store-country.d.ts +14 -0
- package/dist/mjs/models/store-country.d.ts.map +1 -0
- package/dist/mjs/models/store-country.js +7 -0
- package/dist/mjs/models/store-country.js.map +1 -0
- package/dist/mjs/models/store.d.ts +547 -0
- package/dist/mjs/models/store.d.ts.map +1 -0
- package/dist/mjs/models/store.js +7 -0
- package/dist/mjs/models/store.js.map +1 -0
- package/dist/mjs/models/subscription.d.ts +717 -0
- package/dist/mjs/models/subscription.d.ts.map +1 -0
- package/dist/mjs/models/subscription.js +7 -0
- package/dist/mjs/models/subscription.js.map +1 -0
- package/dist/mjs/models/tax-category.d.ts +376 -0
- package/dist/mjs/models/tax-category.d.ts.map +1 -0
- package/dist/mjs/models/tax-category.js +7 -0
- package/dist/mjs/models/tax-category.js.map +1 -0
- package/dist/mjs/models/type.d.ts +645 -0
- package/dist/mjs/models/type.d.ts.map +1 -0
- package/dist/mjs/models/type.js +7 -0
- package/dist/mjs/models/type.js.map +1 -0
- package/dist/mjs/models/zone.d.ts +234 -0
- package/dist/mjs/models/zone.d.ts.map +1 -0
- package/dist/mjs/models/zone.js +7 -0
- package/dist/mjs/models/zone.js.map +1 -0
- package/dist/mjs/request/index.d.ts +3 -0
- package/dist/mjs/request/index.d.ts.map +1 -0
- package/dist/mjs/request/index.js +3 -0
- package/dist/mjs/request/index.js.map +1 -0
- package/dist/mjs/request/is-retryable-error.d.ts +6 -0
- package/dist/mjs/request/is-retryable-error.d.ts.map +1 -0
- package/dist/mjs/request/is-retryable-error.js +24 -0
- package/dist/mjs/request/is-retryable-error.js.map +1 -0
- package/dist/mjs/request/request-executor.d.ts +12 -0
- package/dist/mjs/request/request-executor.d.ts.map +1 -0
- package/dist/mjs/request/request-executor.js +19 -0
- package/dist/mjs/request/request-executor.js.map +1 -0
- package/dist/mjs/request/request.d.ts +11 -0
- package/dist/mjs/request/request.d.ts.map +1 -0
- package/dist/mjs/request/request.js +80 -0
- package/dist/mjs/request/request.js.map +1 -0
- package/dist/mjs/request/transform-error.d.ts +7 -0
- package/dist/mjs/request/transform-error.d.ts.map +1 -0
- package/dist/mjs/request/transform-error.js +12 -0
- package/dist/mjs/request/transform-error.js.map +1 -0
- package/dist/mjs/types.d.ts +96 -0
- package/dist/mjs/types.d.ts.map +1 -0
- package/dist/mjs/types.js +13 -0
- package/dist/mjs/types.js.map +1 -0
- package/dist/mjs/utils/axios/convert-error.d.ts +4 -0
- package/dist/mjs/utils/axios/convert-error.d.ts.map +1 -0
- package/dist/mjs/utils/axios/convert-error.js +24 -0
- package/dist/mjs/utils/axios/convert-error.js.map +1 -0
- package/dist/mjs/utils/axios/convert-response.d.ts +4 -0
- package/dist/mjs/utils/axios/convert-response.d.ts.map +1 -0
- package/dist/mjs/utils/axios/convert-response.js +19 -0
- package/dist/mjs/utils/axios/convert-response.js.map +1 -0
- package/dist/mjs/utils/axios/create-instance.d.ts +11 -0
- package/dist/mjs/utils/axios/create-instance.d.ts.map +1 -0
- package/dist/mjs/utils/axios/create-instance.js +23 -0
- package/dist/mjs/utils/axios/create-instance.js.map +1 -0
- package/dist/mjs/utils/axios/extract-headers.d.ts +2 -0
- package/dist/mjs/utils/axios/extract-headers.d.ts.map +1 -0
- package/dist/mjs/utils/axios/extract-headers.js +19 -0
- package/dist/mjs/utils/axios/extract-headers.js.map +1 -0
- package/dist/mjs/utils/axios/index.d.ts +5 -0
- package/dist/mjs/utils/axios/index.d.ts.map +1 -0
- package/dist/mjs/utils/axios/index.js +5 -0
- package/dist/mjs/utils/axios/index.js.map +1 -0
- package/dist/mjs/utils/calculate-delay.d.ts +7 -0
- package/dist/mjs/utils/calculate-delay.d.ts.map +1 -0
- package/dist/mjs/utils/calculate-delay.js +26 -0
- package/dist/mjs/utils/calculate-delay.js.map +1 -0
- package/dist/mjs/utils/ensure-non-empty-string.d.ts +16 -0
- package/dist/mjs/utils/ensure-non-empty-string.d.ts.map +1 -0
- package/dist/mjs/utils/ensure-non-empty-string.js +12 -0
- package/dist/mjs/utils/ensure-non-empty-string.js.map +1 -0
- package/dist/mjs/utils/format.d.ts +11 -0
- package/dist/mjs/utils/format.d.ts.map +1 -0
- package/dist/mjs/utils/format.js +44 -0
- package/dist/mjs/utils/format.js.map +1 -0
- package/dist/mjs/utils/get-attribute-value.d.ts +17 -0
- package/dist/mjs/utils/get-attribute-value.d.ts.map +1 -0
- package/dist/mjs/utils/get-attribute-value.js +15 -0
- package/dist/mjs/utils/get-attribute-value.js.map +1 -0
- package/dist/mjs/utils/index.d.ts +9 -0
- package/dist/mjs/utils/index.d.ts.map +1 -0
- package/dist/mjs/utils/index.js +9 -0
- package/dist/mjs/utils/index.js.map +1 -0
- package/dist/mjs/utils/mask.d.ts +28 -0
- package/dist/mjs/utils/mask.d.ts.map +1 -0
- package/dist/mjs/utils/mask.js +54 -0
- package/dist/mjs/utils/mask.js.map +1 -0
- package/dist/mjs/utils/plain-clone.d.ts +14 -0
- package/dist/mjs/utils/plain-clone.d.ts.map +1 -0
- package/dist/mjs/utils/plain-clone.js +37 -0
- package/dist/mjs/utils/plain-clone.js.map +1 -0
- package/dist/mjs/utils/retry-on-conflict.d.ts +99 -0
- package/dist/mjs/utils/retry-on-conflict.d.ts.map +1 -0
- package/dist/mjs/utils/retry-on-conflict.js +105 -0
- package/dist/mjs/utils/retry-on-conflict.js.map +1 -0
- package/dist/mjs/utils/useragent.d.ts +10 -0
- package/dist/mjs/utils/useragent.d.ts.map +1 -0
- package/dist/mjs/utils/useragent.js +17 -0
- package/dist/mjs/utils/useragent.js.map +1 -0
- package/package.json +50 -48
- package/dist/ge-commercetools-utils-browser.cjs.js +0 -2
- package/dist/ge-commercetools-utils-browser.cjs.js.map +0 -1
- package/dist/ge-commercetools-utils-browser.esm.js +0 -2
- package/dist/ge-commercetools-utils-browser.esm.js.map +0 -1
- package/dist/ge-commercetools-utils-node.cjs.js +0 -3
- package/dist/ge-commercetools-utils-node.cjs.js.LICENSE.txt +0 -13
- package/dist/ge-commercetools-utils-node.cjs.js.map +0 -1
- package/dist/ge-commercetools-utils-node.esm.js +0 -2
- package/dist/ge-commercetools-utils-node.esm.js.LICENSE.txt +0 -13
- package/dist/typings/api/CommercetoolsApi.d.ts +0 -515
- package/dist/typings/api/index.d.ts +0 -2
- package/dist/typings/api/types.d.ts +0 -12
- package/dist/typings/auth/CommercetoolsAuth.d.ts +0 -22
- package/dist/typings/auth/CommercetoolsAuthApi.d.ts +0 -27
- package/dist/typings/auth/CommercetoolsGrant.d.ts +0 -13
- package/dist/typings/auth/constants.d.ts +0 -3
- package/dist/typings/auth/index.d.ts +0 -3
- package/dist/typings/auth/scopes.d.ts +0 -2
- package/dist/typings/auth/types.d.ts +0 -41
- package/dist/typings/constants.d.ts +0 -12
- package/dist/typings/error/CommercetoolsError.d.ts +0 -11
- package/dist/typings/error/index.d.ts +0 -1
- package/dist/typings/index.d.ts +0 -7
- package/dist/typings/models/associate-role.d.ts +0 -79
- package/dist/typings/models/attribute-group.d.ts +0 -68
- package/dist/typings/models/business-unit.d.ts +0 -272
- package/dist/typings/models/cart-discount.d.ts +0 -196
- package/dist/typings/models/cart.d.ts +0 -745
- package/dist/typings/models/category.d.ts +0 -166
- package/dist/typings/models/channel.d.ts +0 -103
- package/dist/typings/models/common.d.ts +0 -256
- package/dist/typings/models/custom-object.d.ts +0 -30
- package/dist/typings/models/customer-group.d.ts +0 -58
- package/dist/typings/models/customer.d.ts +0 -293
- package/dist/typings/models/discount-code.d.ts +0 -116
- package/dist/typings/models/error.d.ts +0 -874
- package/dist/typings/models/extension.d.ts +0 -83
- package/dist/typings/models/graph-ql.d.ts +0 -23
- package/dist/typings/models/index.d.ts +0 -41
- package/dist/typings/models/inventory.d.ts +0 -88
- package/dist/typings/models/me.d.ts +0 -640
- package/dist/typings/models/message.d.ts +0 -3210
- package/dist/typings/models/order-edit.d.ts +0 -572
- package/dist/typings/models/payment.d.ts +0 -191
- package/dist/typings/models/product-discount.d.ts +0 -123
- package/dist/typings/models/product-selection.d.ts +0 -158
- package/dist/typings/models/product-type.d.ts +0 -213
- package/dist/typings/models/product.d.ts +0 -535
- package/dist/typings/models/project.d.ts +0 -120
- package/dist/typings/models/quote-request.d.ts +0 -94
- package/dist/typings/models/quote.d.ts +0 -103
- package/dist/typings/models/review.d.ts +0 -115
- package/dist/typings/models/scalar-types.d.ts +0 -3
- package/dist/typings/models/shipping-method.d.ts +0 -160
- package/dist/typings/models/shopping-list.d.ts +0 -217
- package/dist/typings/models/staged-quote.d.ts +0 -84
- package/dist/typings/models/standalone-price.d.ts +0 -95
- package/dist/typings/models/state.d.ts +0 -86
- package/dist/typings/models/store-country.d.ts +0 -3
- package/dist/typings/models/store.d.ts +0 -137
- package/dist/typings/models/subscription.d.ts +0 -161
- package/dist/typings/models/tax-category.d.ts +0 -91
- package/dist/typings/models/type.d.ts +0 -177
- package/dist/typings/models/zone.d.ts +0 -65
- package/dist/typings/request/index.d.ts +0 -2
- package/dist/typings/request/is-retryable-error.d.ts +0 -1
- package/dist/typings/request/transform-error.d.ts +0 -2
- package/dist/typings/utils/axios/index.d.ts +0 -4
- package/dist/typings/utils/calculate-delay.d.ts +0 -2
- package/dist/typings/utils/ensure-non-empty-string.d.ts +0 -5
- package/dist/typings/utils/format.d.ts +0 -1
- package/dist/typings/utils/get-attribute-value.d.ts +0 -6
- package/dist/typings/utils/index.d.ts +0 -8
- package/dist/typings/utils/mask.d.ts +0 -6
- package/dist/typings/utils/plain-clone.d.ts +0 -1
- package/dist/typings/utils/retry-on-conflict.d.ts +0 -7
- package/dist/typings/utils/useragent.d.ts +0 -1
|
@@ -0,0 +1,1645 @@
|
|
|
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 { CustomLineItemPriceMode, ExternalLineItemTotalPrice, ExternalTaxAmountDraft, ExternalTaxRateDraft, ItemShippingDetailsDraft, RoundingMode, ShippingRateInputDraft, TaxCalculationMode, TaxedPrice, TaxMode, TaxPortionDraft } from './cart.js';
|
|
7
|
+
import { ChannelResourceIdentifier } from './channel.js';
|
|
8
|
+
import { BaseResource, CreatedBy, LastModifiedBy, LocalizedString, TypedMoney, _BaseAddress, _Money } from './common.js';
|
|
9
|
+
import { CustomerGroupResourceIdentifier } from './customer-group.js';
|
|
10
|
+
import { DiscountCodeReference } from './discount-code.js';
|
|
11
|
+
import { ErrorObject } from './error.js';
|
|
12
|
+
import { MessagePayload } from './message.js';
|
|
13
|
+
import { DeliveryItem, ItemState, Order, OrderReference, OrderState, ParcelDraft, ParcelMeasurements, PaymentState, ReturnInfoDraft, ReturnItemDraft, ReturnPaymentState, ReturnShipmentState, ShipmentState, StagedOrderUpdateAction, TrackingData } from './order.js';
|
|
14
|
+
import { PaymentResourceIdentifier } from './payment.js';
|
|
15
|
+
import { ShippingMethodResourceIdentifier, ShippingRateDraft } from './shipping-method.js';
|
|
16
|
+
import { ShoppingListResourceIdentifier } from './shopping-list.js';
|
|
17
|
+
import { StateResourceIdentifier } from './state.js';
|
|
18
|
+
import { TaxCategoryResourceIdentifier } from './tax-category.js';
|
|
19
|
+
import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type.js';
|
|
20
|
+
export interface OrderEdit extends BaseResource {
|
|
21
|
+
/**
|
|
22
|
+
* Unique identifier of the OrderEdit.
|
|
23
|
+
*
|
|
24
|
+
*/
|
|
25
|
+
readonly id: string;
|
|
26
|
+
/**
|
|
27
|
+
* The current version of the OrderEdit.
|
|
28
|
+
*
|
|
29
|
+
*/
|
|
30
|
+
readonly version: number;
|
|
31
|
+
/**
|
|
32
|
+
*
|
|
33
|
+
*/
|
|
34
|
+
readonly createdAt: string;
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
*/
|
|
38
|
+
readonly lastModifiedAt: string;
|
|
39
|
+
/**
|
|
40
|
+
* Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
*/
|
|
44
|
+
readonly lastModifiedBy?: LastModifiedBy;
|
|
45
|
+
/**
|
|
46
|
+
* Present on resources created after 1 February 2019 except for [events not tracked](/client-logging#events-tracked).
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
*/
|
|
50
|
+
readonly createdBy?: CreatedBy;
|
|
51
|
+
/**
|
|
52
|
+
* User-defined unique identifier of the OrderEdit.
|
|
53
|
+
*
|
|
54
|
+
*/
|
|
55
|
+
readonly key?: string;
|
|
56
|
+
/**
|
|
57
|
+
* The order to be updated with this edit.
|
|
58
|
+
*
|
|
59
|
+
*/
|
|
60
|
+
readonly resource: OrderReference;
|
|
61
|
+
/**
|
|
62
|
+
* The actions to apply to the Order.
|
|
63
|
+
* Cannot be updated after the edit has been applied.
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
66
|
+
readonly stagedActions: StagedOrderUpdateAction[];
|
|
67
|
+
/**
|
|
68
|
+
*
|
|
69
|
+
*/
|
|
70
|
+
readonly custom?: CustomFields;
|
|
71
|
+
/**
|
|
72
|
+
* Contains a preview of the changes in case of unapplied edit.
|
|
73
|
+
* For applied edits, it contains the summary of the changes.
|
|
74
|
+
*
|
|
75
|
+
*/
|
|
76
|
+
readonly result: OrderEditResult;
|
|
77
|
+
/**
|
|
78
|
+
* This field can be used to add textual information regarding the edit.
|
|
79
|
+
*
|
|
80
|
+
*/
|
|
81
|
+
readonly comment?: string;
|
|
82
|
+
}
|
|
83
|
+
export interface OrderEditApply {
|
|
84
|
+
/**
|
|
85
|
+
*
|
|
86
|
+
*/
|
|
87
|
+
readonly editVersion: number;
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
*/
|
|
91
|
+
readonly resourceVersion: number;
|
|
92
|
+
}
|
|
93
|
+
export interface OrderEditDraft {
|
|
94
|
+
/**
|
|
95
|
+
* User-defined unique identifier for the OrderEdit.
|
|
96
|
+
*
|
|
97
|
+
*/
|
|
98
|
+
readonly key?: string;
|
|
99
|
+
/**
|
|
100
|
+
* The order to be updated with this edit.
|
|
101
|
+
*
|
|
102
|
+
*/
|
|
103
|
+
readonly resource: OrderReference;
|
|
104
|
+
/**
|
|
105
|
+
* The actions to apply to `resource`.
|
|
106
|
+
*
|
|
107
|
+
*/
|
|
108
|
+
readonly stagedActions?: StagedOrderUpdateAction[];
|
|
109
|
+
/**
|
|
110
|
+
* The custom fields.
|
|
111
|
+
*
|
|
112
|
+
*/
|
|
113
|
+
readonly custom?: CustomFieldsDraft;
|
|
114
|
+
/**
|
|
115
|
+
* This field can be used to add additional textual information regarding the edit.
|
|
116
|
+
*
|
|
117
|
+
*/
|
|
118
|
+
readonly comment?: string;
|
|
119
|
+
/**
|
|
120
|
+
* When set to `true` the edit is applied on the Order without persisting it.
|
|
121
|
+
*
|
|
122
|
+
*/
|
|
123
|
+
readonly dryRun?: boolean;
|
|
124
|
+
}
|
|
125
|
+
export interface OrderEditPagedQueryResponse {
|
|
126
|
+
/**
|
|
127
|
+
* Number of [results requested](/../api/general-concepts#limit).
|
|
128
|
+
*
|
|
129
|
+
*
|
|
130
|
+
*/
|
|
131
|
+
readonly limit: number;
|
|
132
|
+
/**
|
|
133
|
+
*
|
|
134
|
+
*/
|
|
135
|
+
readonly count: number;
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
*/
|
|
139
|
+
readonly total?: number;
|
|
140
|
+
/**
|
|
141
|
+
* Number of [elements skipped](/../api/general-concepts#offset).
|
|
142
|
+
*
|
|
143
|
+
*
|
|
144
|
+
*/
|
|
145
|
+
readonly offset: number;
|
|
146
|
+
/**
|
|
147
|
+
*
|
|
148
|
+
*/
|
|
149
|
+
readonly results: OrderEdit[];
|
|
150
|
+
}
|
|
151
|
+
/**
|
|
152
|
+
* [Reference](ctp:api:type:Reference) to an [OrderEdit](ctp:api:type:OrderEdit).
|
|
153
|
+
*
|
|
154
|
+
*/
|
|
155
|
+
export interface OrderEditReference {
|
|
156
|
+
readonly typeId: 'order-edit';
|
|
157
|
+
/**
|
|
158
|
+
* Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit).
|
|
159
|
+
*
|
|
160
|
+
*
|
|
161
|
+
*/
|
|
162
|
+
readonly id: string;
|
|
163
|
+
/**
|
|
164
|
+
* Contains the representation of the expanded OrderEdit. Only present in responses to requests with [Reference Expansion](/../api/general-concepts#reference-expansion) for OrderEdits.
|
|
165
|
+
*
|
|
166
|
+
*
|
|
167
|
+
*/
|
|
168
|
+
readonly obj?: OrderEdit;
|
|
169
|
+
}
|
|
170
|
+
/**
|
|
171
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to an [OrderEdit](ctp:api:type:OrderEdit).
|
|
172
|
+
*
|
|
173
|
+
*/
|
|
174
|
+
export interface OrderEditResourceIdentifier {
|
|
175
|
+
readonly typeId: 'order-edit';
|
|
176
|
+
/**
|
|
177
|
+
* Unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required.
|
|
178
|
+
*
|
|
179
|
+
*
|
|
180
|
+
*/
|
|
181
|
+
readonly id?: string;
|
|
182
|
+
/**
|
|
183
|
+
* User-defined unique identifier of the referenced [OrderEdit](ctp:api:type:OrderEdit). Either `id` or `key` is required.
|
|
184
|
+
*
|
|
185
|
+
*
|
|
186
|
+
*/
|
|
187
|
+
readonly key?: string;
|
|
188
|
+
}
|
|
189
|
+
export type OrderEditResult = OrderEditApplied | OrderEditNotProcessed | OrderEditPreviewFailure | OrderEditPreviewSuccess;
|
|
190
|
+
export interface OrderEditApplied {
|
|
191
|
+
readonly type: 'Applied';
|
|
192
|
+
/**
|
|
193
|
+
*
|
|
194
|
+
*/
|
|
195
|
+
readonly appliedAt: string;
|
|
196
|
+
/**
|
|
197
|
+
*
|
|
198
|
+
*/
|
|
199
|
+
readonly excerptBeforeEdit: OrderExcerpt;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
*/
|
|
203
|
+
readonly excerptAfterEdit: OrderExcerpt;
|
|
204
|
+
}
|
|
205
|
+
export interface OrderEditNotProcessed {
|
|
206
|
+
readonly type: 'NotProcessed';
|
|
207
|
+
}
|
|
208
|
+
export interface OrderEditPreviewFailure {
|
|
209
|
+
readonly type: 'PreviewFailure';
|
|
210
|
+
/**
|
|
211
|
+
*
|
|
212
|
+
*/
|
|
213
|
+
readonly errors: ErrorObject[];
|
|
214
|
+
}
|
|
215
|
+
export interface OrderEditPreviewSuccess {
|
|
216
|
+
readonly type: 'PreviewSuccess';
|
|
217
|
+
/**
|
|
218
|
+
*
|
|
219
|
+
*/
|
|
220
|
+
readonly preview: StagedOrder;
|
|
221
|
+
/**
|
|
222
|
+
*
|
|
223
|
+
*/
|
|
224
|
+
readonly messagePayloads: MessagePayload[];
|
|
225
|
+
}
|
|
226
|
+
export interface OrderEditUpdate {
|
|
227
|
+
/**
|
|
228
|
+
*
|
|
229
|
+
*/
|
|
230
|
+
readonly version: number;
|
|
231
|
+
/**
|
|
232
|
+
*
|
|
233
|
+
*/
|
|
234
|
+
readonly actions: OrderEditUpdateAction[];
|
|
235
|
+
/**
|
|
236
|
+
*
|
|
237
|
+
*/
|
|
238
|
+
readonly dryRun?: boolean;
|
|
239
|
+
}
|
|
240
|
+
export type OrderEditUpdateAction = OrderEditAddStagedActionAction | OrderEditSetCommentAction | OrderEditSetCustomFieldAction | OrderEditSetCustomTypeAction | OrderEditSetKeyAction | OrderEditSetStagedActionsAction;
|
|
241
|
+
export interface OrderExcerpt {
|
|
242
|
+
/**
|
|
243
|
+
*
|
|
244
|
+
*/
|
|
245
|
+
readonly totalPrice: TypedMoney;
|
|
246
|
+
/**
|
|
247
|
+
*
|
|
248
|
+
*/
|
|
249
|
+
readonly taxedPrice?: TaxedPrice;
|
|
250
|
+
/**
|
|
251
|
+
*
|
|
252
|
+
*/
|
|
253
|
+
readonly version: number;
|
|
254
|
+
}
|
|
255
|
+
export interface StagedOrder extends Order {
|
|
256
|
+
}
|
|
257
|
+
export interface OrderEditAddStagedActionAction {
|
|
258
|
+
readonly action: 'addStagedAction';
|
|
259
|
+
/**
|
|
260
|
+
*
|
|
261
|
+
*/
|
|
262
|
+
readonly stagedAction: StagedOrderUpdateAction;
|
|
263
|
+
}
|
|
264
|
+
export interface OrderEditSetCommentAction {
|
|
265
|
+
readonly action: 'setComment';
|
|
266
|
+
/**
|
|
267
|
+
*
|
|
268
|
+
*/
|
|
269
|
+
readonly comment?: string;
|
|
270
|
+
}
|
|
271
|
+
export interface OrderEditSetCustomFieldAction {
|
|
272
|
+
readonly action: 'setCustomField';
|
|
273
|
+
/**
|
|
274
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
275
|
+
*
|
|
276
|
+
*
|
|
277
|
+
*/
|
|
278
|
+
readonly name: string;
|
|
279
|
+
/**
|
|
280
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
281
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
282
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
283
|
+
*
|
|
284
|
+
*
|
|
285
|
+
*/
|
|
286
|
+
readonly value?: any;
|
|
287
|
+
}
|
|
288
|
+
export interface OrderEditSetCustomTypeAction {
|
|
289
|
+
readonly action: 'setCustomType';
|
|
290
|
+
/**
|
|
291
|
+
* Defines the [Type](ctp:api:type:Type) that extends the OrderEdit with [Custom Fields](/../api/projects/custom-fields).
|
|
292
|
+
* If absent, any existing Type and Custom Fields are removed from the OrderEdit.
|
|
293
|
+
*
|
|
294
|
+
*
|
|
295
|
+
*/
|
|
296
|
+
readonly type?: TypeResourceIdentifier;
|
|
297
|
+
/**
|
|
298
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the OrderEdit.
|
|
299
|
+
*
|
|
300
|
+
*
|
|
301
|
+
*/
|
|
302
|
+
readonly fields?: FieldContainer;
|
|
303
|
+
}
|
|
304
|
+
export interface OrderEditSetKeyAction {
|
|
305
|
+
readonly action: 'setKey';
|
|
306
|
+
/**
|
|
307
|
+
* If `key` is absent or `null`, this field will be removed if it exists.
|
|
308
|
+
*
|
|
309
|
+
*/
|
|
310
|
+
readonly key?: string;
|
|
311
|
+
}
|
|
312
|
+
export interface OrderEditSetStagedActionsAction {
|
|
313
|
+
readonly action: 'setStagedActions';
|
|
314
|
+
/**
|
|
315
|
+
* The actions to edit the `resource`.
|
|
316
|
+
*
|
|
317
|
+
*/
|
|
318
|
+
readonly stagedActions: StagedOrderUpdateAction[];
|
|
319
|
+
}
|
|
320
|
+
export interface StagedOrderAddCustomLineItemAction {
|
|
321
|
+
readonly action: 'addCustomLineItem';
|
|
322
|
+
/**
|
|
323
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
324
|
+
*
|
|
325
|
+
*
|
|
326
|
+
*/
|
|
327
|
+
readonly money: _Money;
|
|
328
|
+
/**
|
|
329
|
+
* JSON object where the keys are of type [Locale](ctp:api:type:Locale), and the values are the strings used for the corresponding language.
|
|
330
|
+
*
|
|
331
|
+
*
|
|
332
|
+
*/
|
|
333
|
+
readonly name: LocalizedString;
|
|
334
|
+
/**
|
|
335
|
+
*
|
|
336
|
+
*/
|
|
337
|
+
readonly quantity?: number;
|
|
338
|
+
/**
|
|
339
|
+
*
|
|
340
|
+
*/
|
|
341
|
+
readonly slug: string;
|
|
342
|
+
/**
|
|
343
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory).
|
|
344
|
+
*
|
|
345
|
+
*
|
|
346
|
+
*/
|
|
347
|
+
readonly taxCategory?: TaxCategoryResourceIdentifier;
|
|
348
|
+
/**
|
|
349
|
+
* The representation used when creating or updating a [customizable data type](/../api/projects/types#list-of-customizable-data-types) with Custom Fields.
|
|
350
|
+
*
|
|
351
|
+
*
|
|
352
|
+
*/
|
|
353
|
+
readonly custom?: CustomFieldsDraft;
|
|
354
|
+
/**
|
|
355
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
356
|
+
*
|
|
357
|
+
*
|
|
358
|
+
*/
|
|
359
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
360
|
+
/**
|
|
361
|
+
* - If `Standard`, Cart Discounts with a matching [CartDiscountCustomLineItemsTarget](ctp:api:type:CartDiscountCustomLineItemsTarget)
|
|
362
|
+
* are applied to the Custom Line Item.
|
|
363
|
+
* - If `External`, Cart Discounts are not considered on the Custom Line Item.
|
|
364
|
+
*
|
|
365
|
+
*
|
|
366
|
+
*/
|
|
367
|
+
readonly priceMode?: CustomLineItemPriceMode;
|
|
368
|
+
}
|
|
369
|
+
export interface StagedOrderAddDeliveryAction {
|
|
370
|
+
readonly action: 'addDelivery';
|
|
371
|
+
/**
|
|
372
|
+
*
|
|
373
|
+
*/
|
|
374
|
+
readonly items?: DeliveryItem[];
|
|
375
|
+
/**
|
|
376
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
377
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
378
|
+
* only differ in the data type for the optional `custom` field.
|
|
379
|
+
*
|
|
380
|
+
*
|
|
381
|
+
*/
|
|
382
|
+
readonly address?: _BaseAddress;
|
|
383
|
+
/**
|
|
384
|
+
*
|
|
385
|
+
*/
|
|
386
|
+
readonly parcels?: ParcelDraft[];
|
|
387
|
+
/**
|
|
388
|
+
* Custom Fields for the Transaction.
|
|
389
|
+
*
|
|
390
|
+
*/
|
|
391
|
+
readonly custom?: CustomFieldsDraft;
|
|
392
|
+
}
|
|
393
|
+
export interface StagedOrderAddDiscountCodeAction {
|
|
394
|
+
readonly action: 'addDiscountCode';
|
|
395
|
+
/**
|
|
396
|
+
*
|
|
397
|
+
*/
|
|
398
|
+
readonly code: string;
|
|
399
|
+
}
|
|
400
|
+
export interface StagedOrderAddItemShippingAddressAction {
|
|
401
|
+
readonly action: 'addItemShippingAddress';
|
|
402
|
+
/**
|
|
403
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
404
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
405
|
+
* only differ in the data type for the optional `custom` field.
|
|
406
|
+
*
|
|
407
|
+
*
|
|
408
|
+
*/
|
|
409
|
+
readonly address: _BaseAddress;
|
|
410
|
+
}
|
|
411
|
+
export interface StagedOrderAddLineItemAction {
|
|
412
|
+
readonly action: 'addLineItem';
|
|
413
|
+
/**
|
|
414
|
+
* The representation used when creating or updating a [customizable data type](/../api/projects/types#list-of-customizable-data-types) with Custom Fields.
|
|
415
|
+
*
|
|
416
|
+
*
|
|
417
|
+
*/
|
|
418
|
+
readonly custom?: CustomFieldsDraft;
|
|
419
|
+
/**
|
|
420
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
|
|
421
|
+
*
|
|
422
|
+
*
|
|
423
|
+
*/
|
|
424
|
+
readonly distributionChannel?: ChannelResourceIdentifier;
|
|
425
|
+
/**
|
|
426
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
427
|
+
*
|
|
428
|
+
*
|
|
429
|
+
*/
|
|
430
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
431
|
+
/**
|
|
432
|
+
*
|
|
433
|
+
*/
|
|
434
|
+
readonly productId?: string;
|
|
435
|
+
/**
|
|
436
|
+
*
|
|
437
|
+
*/
|
|
438
|
+
readonly variantId?: number;
|
|
439
|
+
/**
|
|
440
|
+
*
|
|
441
|
+
*/
|
|
442
|
+
readonly sku?: string;
|
|
443
|
+
/**
|
|
444
|
+
*
|
|
445
|
+
*/
|
|
446
|
+
readonly quantity?: number;
|
|
447
|
+
/**
|
|
448
|
+
*
|
|
449
|
+
*/
|
|
450
|
+
readonly addedAt?: string;
|
|
451
|
+
/**
|
|
452
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
|
|
453
|
+
*
|
|
454
|
+
*
|
|
455
|
+
*/
|
|
456
|
+
readonly supplyChannel?: ChannelResourceIdentifier;
|
|
457
|
+
/**
|
|
458
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
459
|
+
*
|
|
460
|
+
*
|
|
461
|
+
*/
|
|
462
|
+
readonly externalPrice?: _Money;
|
|
463
|
+
/**
|
|
464
|
+
*
|
|
465
|
+
*/
|
|
466
|
+
readonly externalTotalPrice?: ExternalLineItemTotalPrice;
|
|
467
|
+
/**
|
|
468
|
+
* For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
|
|
469
|
+
*
|
|
470
|
+
*
|
|
471
|
+
*/
|
|
472
|
+
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
473
|
+
}
|
|
474
|
+
export interface StagedOrderAddParcelToDeliveryAction {
|
|
475
|
+
readonly action: 'addParcelToDelivery';
|
|
476
|
+
/**
|
|
477
|
+
*
|
|
478
|
+
*/
|
|
479
|
+
readonly deliveryId: string;
|
|
480
|
+
/**
|
|
481
|
+
*
|
|
482
|
+
*/
|
|
483
|
+
readonly measurements?: ParcelMeasurements;
|
|
484
|
+
/**
|
|
485
|
+
*
|
|
486
|
+
*/
|
|
487
|
+
readonly trackingData?: TrackingData;
|
|
488
|
+
/**
|
|
489
|
+
*
|
|
490
|
+
*/
|
|
491
|
+
readonly items?: DeliveryItem[];
|
|
492
|
+
}
|
|
493
|
+
export interface StagedOrderAddPaymentAction {
|
|
494
|
+
readonly action: 'addPayment';
|
|
495
|
+
/**
|
|
496
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
|
|
497
|
+
*
|
|
498
|
+
*
|
|
499
|
+
*/
|
|
500
|
+
readonly payment: PaymentResourceIdentifier;
|
|
501
|
+
}
|
|
502
|
+
export interface StagedOrderAddReturnInfoAction {
|
|
503
|
+
readonly action: 'addReturnInfo';
|
|
504
|
+
/**
|
|
505
|
+
*
|
|
506
|
+
*/
|
|
507
|
+
readonly returnTrackingId?: string;
|
|
508
|
+
/**
|
|
509
|
+
*
|
|
510
|
+
*/
|
|
511
|
+
readonly items: ReturnItemDraft[];
|
|
512
|
+
/**
|
|
513
|
+
*
|
|
514
|
+
*/
|
|
515
|
+
readonly returnDate?: string;
|
|
516
|
+
}
|
|
517
|
+
export interface StagedOrderAddShoppingListAction {
|
|
518
|
+
readonly action: 'addShoppingList';
|
|
519
|
+
/**
|
|
520
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShoppingList](ctp:api:type:ShoppingList).
|
|
521
|
+
*
|
|
522
|
+
*
|
|
523
|
+
*/
|
|
524
|
+
readonly shoppingList: ShoppingListResourceIdentifier;
|
|
525
|
+
/**
|
|
526
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
|
|
527
|
+
*
|
|
528
|
+
*
|
|
529
|
+
*/
|
|
530
|
+
readonly supplyChannel?: ChannelResourceIdentifier;
|
|
531
|
+
/**
|
|
532
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
|
|
533
|
+
*
|
|
534
|
+
*
|
|
535
|
+
*/
|
|
536
|
+
readonly distributionChannel?: ChannelResourceIdentifier;
|
|
537
|
+
}
|
|
538
|
+
export interface StagedOrderChangeCustomLineItemMoneyAction {
|
|
539
|
+
readonly action: 'changeCustomLineItemMoney';
|
|
540
|
+
/**
|
|
541
|
+
*
|
|
542
|
+
*/
|
|
543
|
+
readonly customLineItemId: string;
|
|
544
|
+
/**
|
|
545
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
546
|
+
*
|
|
547
|
+
*
|
|
548
|
+
*/
|
|
549
|
+
readonly money: _Money;
|
|
550
|
+
}
|
|
551
|
+
export interface StagedOrderChangeCustomLineItemQuantityAction {
|
|
552
|
+
readonly action: 'changeCustomLineItemQuantity';
|
|
553
|
+
/**
|
|
554
|
+
*
|
|
555
|
+
*/
|
|
556
|
+
readonly customLineItemId: string;
|
|
557
|
+
/**
|
|
558
|
+
*
|
|
559
|
+
*/
|
|
560
|
+
readonly quantity: number;
|
|
561
|
+
}
|
|
562
|
+
export interface StagedOrderChangeLineItemQuantityAction {
|
|
563
|
+
readonly action: 'changeLineItemQuantity';
|
|
564
|
+
/**
|
|
565
|
+
*
|
|
566
|
+
*/
|
|
567
|
+
readonly lineItemId: string;
|
|
568
|
+
/**
|
|
569
|
+
*
|
|
570
|
+
*/
|
|
571
|
+
readonly quantity: number;
|
|
572
|
+
/**
|
|
573
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
574
|
+
*
|
|
575
|
+
*
|
|
576
|
+
*/
|
|
577
|
+
readonly externalPrice?: _Money;
|
|
578
|
+
/**
|
|
579
|
+
*
|
|
580
|
+
*/
|
|
581
|
+
readonly externalTotalPrice?: ExternalLineItemTotalPrice;
|
|
582
|
+
}
|
|
583
|
+
export interface StagedOrderChangeOrderStateAction {
|
|
584
|
+
readonly action: 'changeOrderState';
|
|
585
|
+
/**
|
|
586
|
+
*
|
|
587
|
+
*/
|
|
588
|
+
readonly orderState: OrderState;
|
|
589
|
+
}
|
|
590
|
+
export interface StagedOrderChangePaymentStateAction {
|
|
591
|
+
readonly action: 'changePaymentState';
|
|
592
|
+
/**
|
|
593
|
+
*
|
|
594
|
+
*/
|
|
595
|
+
readonly paymentState?: PaymentState;
|
|
596
|
+
}
|
|
597
|
+
export interface StagedOrderChangeShipmentStateAction {
|
|
598
|
+
readonly action: 'changeShipmentState';
|
|
599
|
+
/**
|
|
600
|
+
*
|
|
601
|
+
*/
|
|
602
|
+
readonly shipmentState?: ShipmentState;
|
|
603
|
+
}
|
|
604
|
+
export interface StagedOrderChangeTaxCalculationModeAction {
|
|
605
|
+
readonly action: 'changeTaxCalculationMode';
|
|
606
|
+
/**
|
|
607
|
+
* Determines in which [Tax calculation mode](/carts-orders-overview#tax-calculation-mode) taxed prices are calculated.
|
|
608
|
+
*
|
|
609
|
+
*
|
|
610
|
+
*/
|
|
611
|
+
readonly taxCalculationMode: TaxCalculationMode;
|
|
612
|
+
}
|
|
613
|
+
export interface StagedOrderChangeTaxModeAction {
|
|
614
|
+
readonly action: 'changeTaxMode';
|
|
615
|
+
/**
|
|
616
|
+
* Indicates how taxes are set on the Cart.
|
|
617
|
+
*
|
|
618
|
+
*
|
|
619
|
+
*/
|
|
620
|
+
readonly taxMode: TaxMode;
|
|
621
|
+
}
|
|
622
|
+
export interface StagedOrderChangeTaxRoundingModeAction {
|
|
623
|
+
readonly action: 'changeTaxRoundingMode';
|
|
624
|
+
/**
|
|
625
|
+
* Determines how monetary values are rounded.
|
|
626
|
+
*
|
|
627
|
+
*
|
|
628
|
+
*/
|
|
629
|
+
readonly taxRoundingMode: RoundingMode;
|
|
630
|
+
}
|
|
631
|
+
export interface StagedOrderImportCustomLineItemStateAction {
|
|
632
|
+
readonly action: 'importCustomLineItemState';
|
|
633
|
+
/**
|
|
634
|
+
*
|
|
635
|
+
*/
|
|
636
|
+
readonly customLineItemId: string;
|
|
637
|
+
/**
|
|
638
|
+
*
|
|
639
|
+
*/
|
|
640
|
+
readonly state: ItemState[];
|
|
641
|
+
}
|
|
642
|
+
export interface StagedOrderImportLineItemStateAction {
|
|
643
|
+
readonly action: 'importLineItemState';
|
|
644
|
+
/**
|
|
645
|
+
*
|
|
646
|
+
*/
|
|
647
|
+
readonly lineItemId: string;
|
|
648
|
+
/**
|
|
649
|
+
*
|
|
650
|
+
*/
|
|
651
|
+
readonly state: ItemState[];
|
|
652
|
+
}
|
|
653
|
+
export interface StagedOrderRemoveCustomLineItemAction {
|
|
654
|
+
readonly action: 'removeCustomLineItem';
|
|
655
|
+
/**
|
|
656
|
+
*
|
|
657
|
+
*/
|
|
658
|
+
readonly customLineItemId: string;
|
|
659
|
+
}
|
|
660
|
+
export interface StagedOrderRemoveDeliveryAction {
|
|
661
|
+
readonly action: 'removeDelivery';
|
|
662
|
+
/**
|
|
663
|
+
*
|
|
664
|
+
*/
|
|
665
|
+
readonly deliveryId: string;
|
|
666
|
+
}
|
|
667
|
+
export interface StagedOrderRemoveDiscountCodeAction {
|
|
668
|
+
readonly action: 'removeDiscountCode';
|
|
669
|
+
/**
|
|
670
|
+
* [Reference](ctp:api:type:Reference) to a [DiscountCode](ctp:api:type:DiscountCode).
|
|
671
|
+
*
|
|
672
|
+
*
|
|
673
|
+
*/
|
|
674
|
+
readonly discountCode: DiscountCodeReference;
|
|
675
|
+
}
|
|
676
|
+
export interface StagedOrderRemoveItemShippingAddressAction {
|
|
677
|
+
readonly action: 'removeItemShippingAddress';
|
|
678
|
+
/**
|
|
679
|
+
*
|
|
680
|
+
*/
|
|
681
|
+
readonly addressKey: string;
|
|
682
|
+
}
|
|
683
|
+
export interface StagedOrderRemoveLineItemAction {
|
|
684
|
+
readonly action: 'removeLineItem';
|
|
685
|
+
/**
|
|
686
|
+
*
|
|
687
|
+
*/
|
|
688
|
+
readonly lineItemId: string;
|
|
689
|
+
/**
|
|
690
|
+
*
|
|
691
|
+
*/
|
|
692
|
+
readonly quantity?: number;
|
|
693
|
+
/**
|
|
694
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
695
|
+
*
|
|
696
|
+
*
|
|
697
|
+
*/
|
|
698
|
+
readonly externalPrice?: _Money;
|
|
699
|
+
/**
|
|
700
|
+
*
|
|
701
|
+
*/
|
|
702
|
+
readonly externalTotalPrice?: ExternalLineItemTotalPrice;
|
|
703
|
+
/**
|
|
704
|
+
* For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
|
|
705
|
+
*
|
|
706
|
+
*
|
|
707
|
+
*/
|
|
708
|
+
readonly shippingDetailsToRemove?: ItemShippingDetailsDraft;
|
|
709
|
+
}
|
|
710
|
+
export interface StagedOrderRemoveParcelFromDeliveryAction {
|
|
711
|
+
readonly action: 'removeParcelFromDelivery';
|
|
712
|
+
/**
|
|
713
|
+
*
|
|
714
|
+
*/
|
|
715
|
+
readonly parcelId: string;
|
|
716
|
+
}
|
|
717
|
+
export interface StagedOrderRemovePaymentAction {
|
|
718
|
+
readonly action: 'removePayment';
|
|
719
|
+
/**
|
|
720
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) of a [Payment](ctp:api:type:Payment).
|
|
721
|
+
*
|
|
722
|
+
*
|
|
723
|
+
*/
|
|
724
|
+
readonly payment: PaymentResourceIdentifier;
|
|
725
|
+
}
|
|
726
|
+
export interface StagedOrderSetBillingAddressAction {
|
|
727
|
+
readonly action: 'setBillingAddress';
|
|
728
|
+
/**
|
|
729
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
730
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
731
|
+
* only differ in the data type for the optional `custom` field.
|
|
732
|
+
*
|
|
733
|
+
*
|
|
734
|
+
*/
|
|
735
|
+
readonly address?: _BaseAddress;
|
|
736
|
+
}
|
|
737
|
+
export interface StagedOrderSetBillingAddressCustomFieldAction {
|
|
738
|
+
readonly action: 'setBillingAddressCustomField';
|
|
739
|
+
/**
|
|
740
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
741
|
+
*
|
|
742
|
+
*
|
|
743
|
+
*/
|
|
744
|
+
readonly name: string;
|
|
745
|
+
/**
|
|
746
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
747
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
748
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
749
|
+
*
|
|
750
|
+
*
|
|
751
|
+
*/
|
|
752
|
+
readonly value?: any;
|
|
753
|
+
}
|
|
754
|
+
export interface StagedOrderSetBillingAddressCustomTypeAction {
|
|
755
|
+
readonly action: 'setBillingAddressCustomType';
|
|
756
|
+
/**
|
|
757
|
+
* Defines the [Type](ctp:api:type:Type) that extends the `billingAddress` with [Custom Fields](/../api/projects/custom-fields).
|
|
758
|
+
* If absent, any existing Type and Custom Fields are removed from the `billingAddress`.
|
|
759
|
+
*
|
|
760
|
+
*
|
|
761
|
+
*/
|
|
762
|
+
readonly type?: TypeResourceIdentifier;
|
|
763
|
+
/**
|
|
764
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `billingAddress`.
|
|
765
|
+
*
|
|
766
|
+
*
|
|
767
|
+
*/
|
|
768
|
+
readonly fields?: FieldContainer;
|
|
769
|
+
}
|
|
770
|
+
export interface StagedOrderSetCountryAction {
|
|
771
|
+
readonly action: 'setCountry';
|
|
772
|
+
/**
|
|
773
|
+
*
|
|
774
|
+
*/
|
|
775
|
+
readonly country?: string;
|
|
776
|
+
}
|
|
777
|
+
export interface StagedOrderSetCustomFieldAction {
|
|
778
|
+
readonly action: 'setCustomField';
|
|
779
|
+
/**
|
|
780
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
781
|
+
*
|
|
782
|
+
*
|
|
783
|
+
*/
|
|
784
|
+
readonly name: string;
|
|
785
|
+
/**
|
|
786
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
787
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
788
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
789
|
+
*
|
|
790
|
+
*
|
|
791
|
+
*/
|
|
792
|
+
readonly value?: any;
|
|
793
|
+
}
|
|
794
|
+
export interface StagedOrderSetCustomLineItemCustomFieldAction {
|
|
795
|
+
readonly action: 'setCustomLineItemCustomField';
|
|
796
|
+
/**
|
|
797
|
+
*
|
|
798
|
+
*/
|
|
799
|
+
readonly customLineItemId: string;
|
|
800
|
+
/**
|
|
801
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
802
|
+
*
|
|
803
|
+
*
|
|
804
|
+
*/
|
|
805
|
+
readonly name: string;
|
|
806
|
+
/**
|
|
807
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
808
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
809
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
810
|
+
*
|
|
811
|
+
*
|
|
812
|
+
*/
|
|
813
|
+
readonly value?: any;
|
|
814
|
+
}
|
|
815
|
+
export interface StagedOrderSetCustomLineItemCustomTypeAction {
|
|
816
|
+
readonly action: 'setCustomLineItemCustomType';
|
|
817
|
+
/**
|
|
818
|
+
*
|
|
819
|
+
*/
|
|
820
|
+
readonly customLineItemId: string;
|
|
821
|
+
/**
|
|
822
|
+
* Defines the [Type](ctp:api:type:Type) that extends the CustomLineItem with [Custom Fields](/../api/projects/custom-fields).
|
|
823
|
+
* If absent, any existing Type and Custom Fields are removed from the CustomLineItem.
|
|
824
|
+
*
|
|
825
|
+
*
|
|
826
|
+
*/
|
|
827
|
+
readonly type?: TypeResourceIdentifier;
|
|
828
|
+
/**
|
|
829
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the CustomLineItem.
|
|
830
|
+
*
|
|
831
|
+
*
|
|
832
|
+
*/
|
|
833
|
+
readonly fields?: FieldContainer;
|
|
834
|
+
}
|
|
835
|
+
export interface StagedOrderSetCustomLineItemShippingDetailsAction {
|
|
836
|
+
readonly action: 'setCustomLineItemShippingDetails';
|
|
837
|
+
/**
|
|
838
|
+
*
|
|
839
|
+
*/
|
|
840
|
+
readonly customLineItemId: string;
|
|
841
|
+
/**
|
|
842
|
+
* For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
|
|
843
|
+
*
|
|
844
|
+
*
|
|
845
|
+
*/
|
|
846
|
+
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
847
|
+
}
|
|
848
|
+
export interface StagedOrderSetCustomLineItemTaxAmountAction {
|
|
849
|
+
readonly action: 'setCustomLineItemTaxAmount';
|
|
850
|
+
/**
|
|
851
|
+
*
|
|
852
|
+
*/
|
|
853
|
+
readonly customLineItemId: string;
|
|
854
|
+
/**
|
|
855
|
+
* Cannot be used in [LineItemDraft](ctp:api:type:LineItemDraft) or [CustomLineItemDraft](ctp:api:type:CustomLineItemDraft).
|
|
856
|
+
*
|
|
857
|
+
* Can only be set by these update actions:
|
|
858
|
+
*
|
|
859
|
+
* - [Set LineItem TaxAmount](ctp:api:type:CartSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:CartSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:CartSetShippingMethodTaxAmountAction) on Carts
|
|
860
|
+
* - [Set LineItem TaxAmount](ctp:api:type:OrderEditSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:OrderEditSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:OrderEditSetShippingMethodTaxAmountAction) on Order Edits
|
|
861
|
+
*
|
|
862
|
+
*
|
|
863
|
+
*/
|
|
864
|
+
readonly externalTaxAmount?: ExternalTaxAmountDraft;
|
|
865
|
+
}
|
|
866
|
+
export interface StagedOrderSetCustomLineItemTaxRateAction {
|
|
867
|
+
readonly action: 'setCustomLineItemTaxRate';
|
|
868
|
+
/**
|
|
869
|
+
*
|
|
870
|
+
*/
|
|
871
|
+
readonly customLineItemId: string;
|
|
872
|
+
/**
|
|
873
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
874
|
+
*
|
|
875
|
+
*
|
|
876
|
+
*/
|
|
877
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
878
|
+
}
|
|
879
|
+
export interface StagedOrderSetCustomShippingMethodAction {
|
|
880
|
+
readonly action: 'setCustomShippingMethod';
|
|
881
|
+
/**
|
|
882
|
+
*
|
|
883
|
+
*/
|
|
884
|
+
readonly shippingMethodName: string;
|
|
885
|
+
/**
|
|
886
|
+
*
|
|
887
|
+
*/
|
|
888
|
+
readonly shippingRate: ShippingRateDraft;
|
|
889
|
+
/**
|
|
890
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory).
|
|
891
|
+
*
|
|
892
|
+
*
|
|
893
|
+
*/
|
|
894
|
+
readonly taxCategory?: TaxCategoryResourceIdentifier;
|
|
895
|
+
/**
|
|
896
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
897
|
+
*
|
|
898
|
+
*
|
|
899
|
+
*/
|
|
900
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
901
|
+
}
|
|
902
|
+
export interface StagedOrderSetCustomTypeAction {
|
|
903
|
+
readonly action: 'setCustomType';
|
|
904
|
+
/**
|
|
905
|
+
* Defines the [Type](ctp:api:type:Type) that extends the StagedOrder with [Custom Fields](/../api/projects/custom-fields).
|
|
906
|
+
* If absent, any existing Type and Custom Fields are removed from the StagedOrder.
|
|
907
|
+
*
|
|
908
|
+
*
|
|
909
|
+
*/
|
|
910
|
+
readonly type?: TypeResourceIdentifier;
|
|
911
|
+
/**
|
|
912
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the StagedOrder.
|
|
913
|
+
*
|
|
914
|
+
*
|
|
915
|
+
*/
|
|
916
|
+
readonly fields?: FieldContainer;
|
|
917
|
+
}
|
|
918
|
+
export interface StagedOrderSetCustomerEmailAction {
|
|
919
|
+
readonly action: 'setCustomerEmail';
|
|
920
|
+
/**
|
|
921
|
+
*
|
|
922
|
+
*/
|
|
923
|
+
readonly email?: string;
|
|
924
|
+
}
|
|
925
|
+
export interface StagedOrderSetCustomerGroupAction {
|
|
926
|
+
readonly action: 'setCustomerGroup';
|
|
927
|
+
/**
|
|
928
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [CustomerGroup](ctp:api:type:CustomerGroup).
|
|
929
|
+
*
|
|
930
|
+
*
|
|
931
|
+
*/
|
|
932
|
+
readonly customerGroup?: CustomerGroupResourceIdentifier;
|
|
933
|
+
}
|
|
934
|
+
export interface StagedOrderSetCustomerIdAction {
|
|
935
|
+
readonly action: 'setCustomerId';
|
|
936
|
+
/**
|
|
937
|
+
*
|
|
938
|
+
*/
|
|
939
|
+
readonly customerId?: string;
|
|
940
|
+
}
|
|
941
|
+
export interface StagedOrderSetDeliveryAddressAction {
|
|
942
|
+
readonly action: 'setDeliveryAddress';
|
|
943
|
+
/**
|
|
944
|
+
*
|
|
945
|
+
*/
|
|
946
|
+
readonly deliveryId: string;
|
|
947
|
+
/**
|
|
948
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
949
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
950
|
+
* only differ in the data type for the optional `custom` field.
|
|
951
|
+
*
|
|
952
|
+
*
|
|
953
|
+
*/
|
|
954
|
+
readonly address?: _BaseAddress;
|
|
955
|
+
}
|
|
956
|
+
export interface StagedOrderSetDeliveryAddressCustomFieldAction {
|
|
957
|
+
readonly action: 'setDeliveryAddressCustomField';
|
|
958
|
+
/**
|
|
959
|
+
*
|
|
960
|
+
*/
|
|
961
|
+
readonly deliveryId: string;
|
|
962
|
+
/**
|
|
963
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
964
|
+
*
|
|
965
|
+
*
|
|
966
|
+
*/
|
|
967
|
+
readonly name: string;
|
|
968
|
+
/**
|
|
969
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
970
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
971
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
972
|
+
*
|
|
973
|
+
*
|
|
974
|
+
*/
|
|
975
|
+
readonly value?: any;
|
|
976
|
+
}
|
|
977
|
+
export interface StagedOrderSetDeliveryAddressCustomTypeAction {
|
|
978
|
+
readonly action: 'setDeliveryAddressCustomType';
|
|
979
|
+
/**
|
|
980
|
+
*
|
|
981
|
+
*/
|
|
982
|
+
readonly deliveryId: string;
|
|
983
|
+
/**
|
|
984
|
+
* Defines the [Type](ctp:api:type:Type) that extends the `address` in a Delivery with [Custom Fields](/../api/projects/custom-fields).
|
|
985
|
+
* If absent, any existing Type and Custom Fields are removed from the `address` in a Delivery.
|
|
986
|
+
*
|
|
987
|
+
*
|
|
988
|
+
*/
|
|
989
|
+
readonly type?: TypeResourceIdentifier;
|
|
990
|
+
/**
|
|
991
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `address` in a Delivery.
|
|
992
|
+
*
|
|
993
|
+
*
|
|
994
|
+
*/
|
|
995
|
+
readonly fields?: FieldContainer;
|
|
996
|
+
}
|
|
997
|
+
export interface StagedOrderSetDeliveryCustomFieldAction {
|
|
998
|
+
readonly action: 'setDeliveryCustomField';
|
|
999
|
+
/**
|
|
1000
|
+
*
|
|
1001
|
+
*/
|
|
1002
|
+
readonly deliveryId: string;
|
|
1003
|
+
/**
|
|
1004
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
1005
|
+
*
|
|
1006
|
+
*
|
|
1007
|
+
*/
|
|
1008
|
+
readonly name: string;
|
|
1009
|
+
/**
|
|
1010
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
1011
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
1012
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
1013
|
+
*
|
|
1014
|
+
*
|
|
1015
|
+
*/
|
|
1016
|
+
readonly value?: any;
|
|
1017
|
+
}
|
|
1018
|
+
export interface StagedOrderSetDeliveryCustomTypeAction {
|
|
1019
|
+
readonly action: 'setDeliveryCustomType';
|
|
1020
|
+
/**
|
|
1021
|
+
*
|
|
1022
|
+
*/
|
|
1023
|
+
readonly deliveryId: string;
|
|
1024
|
+
/**
|
|
1025
|
+
* Defines the [Type](ctp:api:type:Type) that extends the Delivery with [Custom Fields](/../api/projects/custom-fields).
|
|
1026
|
+
* If absent, any existing Type and Custom Fields are removed from the Delivery.
|
|
1027
|
+
*
|
|
1028
|
+
*
|
|
1029
|
+
*/
|
|
1030
|
+
readonly type?: TypeResourceIdentifier;
|
|
1031
|
+
/**
|
|
1032
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Delivery.
|
|
1033
|
+
*
|
|
1034
|
+
*
|
|
1035
|
+
*/
|
|
1036
|
+
readonly fields?: FieldContainer;
|
|
1037
|
+
}
|
|
1038
|
+
export interface StagedOrderSetDeliveryItemsAction {
|
|
1039
|
+
readonly action: 'setDeliveryItems';
|
|
1040
|
+
/**
|
|
1041
|
+
*
|
|
1042
|
+
*/
|
|
1043
|
+
readonly deliveryId: string;
|
|
1044
|
+
/**
|
|
1045
|
+
*
|
|
1046
|
+
*/
|
|
1047
|
+
readonly items: DeliveryItem[];
|
|
1048
|
+
}
|
|
1049
|
+
export interface StagedOrderSetItemShippingAddressCustomFieldAction {
|
|
1050
|
+
readonly action: 'setItemShippingAddressCustomField';
|
|
1051
|
+
/**
|
|
1052
|
+
*
|
|
1053
|
+
*/
|
|
1054
|
+
readonly addressKey: string;
|
|
1055
|
+
/**
|
|
1056
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
1057
|
+
*
|
|
1058
|
+
*
|
|
1059
|
+
*/
|
|
1060
|
+
readonly name: string;
|
|
1061
|
+
/**
|
|
1062
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
1063
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
1064
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
*/
|
|
1068
|
+
readonly value?: any;
|
|
1069
|
+
}
|
|
1070
|
+
export interface StagedOrderSetItemShippingAddressCustomTypeAction {
|
|
1071
|
+
readonly action: 'setItemShippingAddressCustomType';
|
|
1072
|
+
/**
|
|
1073
|
+
*
|
|
1074
|
+
*/
|
|
1075
|
+
readonly addressKey: string;
|
|
1076
|
+
/**
|
|
1077
|
+
* Defines the [Type](ctp:api:type:Type) that extends the `itemShippingAddress` with [Custom Fields](/../api/projects/custom-fields).
|
|
1078
|
+
* If absent, any existing Type and Custom Fields are removed from the `itemShippingAddress`.
|
|
1079
|
+
*
|
|
1080
|
+
*
|
|
1081
|
+
*/
|
|
1082
|
+
readonly type?: TypeResourceIdentifier;
|
|
1083
|
+
/**
|
|
1084
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `itemShippingAddress`.
|
|
1085
|
+
*
|
|
1086
|
+
*
|
|
1087
|
+
*/
|
|
1088
|
+
readonly fields?: FieldContainer;
|
|
1089
|
+
}
|
|
1090
|
+
export interface StagedOrderSetLineItemCustomFieldAction {
|
|
1091
|
+
readonly action: 'setLineItemCustomField';
|
|
1092
|
+
/**
|
|
1093
|
+
*
|
|
1094
|
+
*/
|
|
1095
|
+
readonly lineItemId: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
1098
|
+
*
|
|
1099
|
+
*
|
|
1100
|
+
*/
|
|
1101
|
+
readonly name: string;
|
|
1102
|
+
/**
|
|
1103
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
1104
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
1105
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
1106
|
+
*
|
|
1107
|
+
*
|
|
1108
|
+
*/
|
|
1109
|
+
readonly value?: any;
|
|
1110
|
+
}
|
|
1111
|
+
export interface StagedOrderSetLineItemCustomTypeAction {
|
|
1112
|
+
readonly action: 'setLineItemCustomType';
|
|
1113
|
+
/**
|
|
1114
|
+
*
|
|
1115
|
+
*/
|
|
1116
|
+
readonly lineItemId: string;
|
|
1117
|
+
/**
|
|
1118
|
+
* Defines the [Type](ctp:api:type:Type) that extends the LineItem with [Custom Fields](/../api/projects/custom-fields).
|
|
1119
|
+
* If absent, any existing Type and Custom Fields are removed from the LineItem.
|
|
1120
|
+
*
|
|
1121
|
+
*
|
|
1122
|
+
*/
|
|
1123
|
+
readonly type?: TypeResourceIdentifier;
|
|
1124
|
+
/**
|
|
1125
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the LineItem.
|
|
1126
|
+
*
|
|
1127
|
+
*
|
|
1128
|
+
*/
|
|
1129
|
+
readonly fields?: FieldContainer;
|
|
1130
|
+
}
|
|
1131
|
+
export interface StagedOrderSetLineItemDistributionChannelAction {
|
|
1132
|
+
readonly action: 'setLineItemDistributionChannel';
|
|
1133
|
+
/**
|
|
1134
|
+
*
|
|
1135
|
+
*/
|
|
1136
|
+
readonly lineItemId: string;
|
|
1137
|
+
/**
|
|
1138
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
|
|
1139
|
+
*
|
|
1140
|
+
*
|
|
1141
|
+
*/
|
|
1142
|
+
readonly distributionChannel?: ChannelResourceIdentifier;
|
|
1143
|
+
}
|
|
1144
|
+
export interface StagedOrderSetLineItemPriceAction {
|
|
1145
|
+
readonly action: 'setLineItemPrice';
|
|
1146
|
+
/**
|
|
1147
|
+
*
|
|
1148
|
+
*/
|
|
1149
|
+
readonly lineItemId: string;
|
|
1150
|
+
/**
|
|
1151
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
1152
|
+
*
|
|
1153
|
+
*
|
|
1154
|
+
*/
|
|
1155
|
+
readonly externalPrice?: _Money;
|
|
1156
|
+
}
|
|
1157
|
+
export interface StagedOrderSetLineItemShippingDetailsAction {
|
|
1158
|
+
readonly action: 'setLineItemShippingDetails';
|
|
1159
|
+
/**
|
|
1160
|
+
*
|
|
1161
|
+
*/
|
|
1162
|
+
readonly lineItemId: string;
|
|
1163
|
+
/**
|
|
1164
|
+
* For order creation and updates, the sum of the `targets` must match the quantity of the Line Items or Custom Line Items.
|
|
1165
|
+
*
|
|
1166
|
+
*
|
|
1167
|
+
*/
|
|
1168
|
+
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
1169
|
+
}
|
|
1170
|
+
export interface StagedOrderSetLineItemTaxAmountAction {
|
|
1171
|
+
readonly action: 'setLineItemTaxAmount';
|
|
1172
|
+
/**
|
|
1173
|
+
*
|
|
1174
|
+
*/
|
|
1175
|
+
readonly lineItemId: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* Cannot be used in [LineItemDraft](ctp:api:type:LineItemDraft) or [CustomLineItemDraft](ctp:api:type:CustomLineItemDraft).
|
|
1178
|
+
*
|
|
1179
|
+
* Can only be set by these update actions:
|
|
1180
|
+
*
|
|
1181
|
+
* - [Set LineItem TaxAmount](ctp:api:type:CartSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:CartSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:CartSetShippingMethodTaxAmountAction) on Carts
|
|
1182
|
+
* - [Set LineItem TaxAmount](ctp:api:type:OrderEditSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:OrderEditSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:OrderEditSetShippingMethodTaxAmountAction) on Order Edits
|
|
1183
|
+
*
|
|
1184
|
+
*
|
|
1185
|
+
*/
|
|
1186
|
+
readonly externalTaxAmount?: ExternalTaxAmountDraft;
|
|
1187
|
+
/**
|
|
1188
|
+
* `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Line Item.```
|
|
1189
|
+
* This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
|
|
1190
|
+
*
|
|
1191
|
+
*
|
|
1192
|
+
*/
|
|
1193
|
+
readonly shippingKey?: string;
|
|
1194
|
+
}
|
|
1195
|
+
export interface StagedOrderSetLineItemTaxRateAction {
|
|
1196
|
+
readonly action: 'setLineItemTaxRate';
|
|
1197
|
+
/**
|
|
1198
|
+
*
|
|
1199
|
+
*/
|
|
1200
|
+
readonly lineItemId: string;
|
|
1201
|
+
/**
|
|
1202
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
1203
|
+
*
|
|
1204
|
+
*
|
|
1205
|
+
*/
|
|
1206
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
1207
|
+
/**
|
|
1208
|
+
* `key` of the [ShippingMethod](ctp:api:type:ShippingMethod) used for this Line Item.
|
|
1209
|
+
* This is required for Carts with `Multiple` [ShippingMode](ctp:api:type:ShippingMode).
|
|
1210
|
+
*
|
|
1211
|
+
*
|
|
1212
|
+
*/
|
|
1213
|
+
readonly shippingKey?: string;
|
|
1214
|
+
}
|
|
1215
|
+
export interface StagedOrderSetLineItemTotalPriceAction {
|
|
1216
|
+
readonly action: 'setLineItemTotalPrice';
|
|
1217
|
+
/**
|
|
1218
|
+
*
|
|
1219
|
+
*/
|
|
1220
|
+
readonly lineItemId: string;
|
|
1221
|
+
/**
|
|
1222
|
+
*
|
|
1223
|
+
*/
|
|
1224
|
+
readonly externalTotalPrice?: ExternalLineItemTotalPrice;
|
|
1225
|
+
}
|
|
1226
|
+
export interface StagedOrderSetLocaleAction {
|
|
1227
|
+
readonly action: 'setLocale';
|
|
1228
|
+
/**
|
|
1229
|
+
*
|
|
1230
|
+
*/
|
|
1231
|
+
readonly locale?: string;
|
|
1232
|
+
}
|
|
1233
|
+
export interface StagedOrderSetOrderNumberAction {
|
|
1234
|
+
readonly action: 'setOrderNumber';
|
|
1235
|
+
/**
|
|
1236
|
+
*
|
|
1237
|
+
*/
|
|
1238
|
+
readonly orderNumber?: string;
|
|
1239
|
+
}
|
|
1240
|
+
export interface StagedOrderSetOrderTotalTaxAction {
|
|
1241
|
+
readonly action: 'setOrderTotalTax';
|
|
1242
|
+
/**
|
|
1243
|
+
* Draft type that stores amounts only in cent precision for the specified currency.
|
|
1244
|
+
*
|
|
1245
|
+
*
|
|
1246
|
+
*/
|
|
1247
|
+
readonly externalTotalGross: _Money;
|
|
1248
|
+
/**
|
|
1249
|
+
*
|
|
1250
|
+
*/
|
|
1251
|
+
readonly externalTaxPortions?: TaxPortionDraft[];
|
|
1252
|
+
}
|
|
1253
|
+
export interface StagedOrderSetParcelCustomFieldAction {
|
|
1254
|
+
readonly action: 'setParcelCustomField';
|
|
1255
|
+
/**
|
|
1256
|
+
*
|
|
1257
|
+
*/
|
|
1258
|
+
readonly parcelId: string;
|
|
1259
|
+
/**
|
|
1260
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
1261
|
+
*
|
|
1262
|
+
*
|
|
1263
|
+
*/
|
|
1264
|
+
readonly name: string;
|
|
1265
|
+
/**
|
|
1266
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
1267
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
1268
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
1269
|
+
*
|
|
1270
|
+
*
|
|
1271
|
+
*/
|
|
1272
|
+
readonly value?: any;
|
|
1273
|
+
}
|
|
1274
|
+
export interface StagedOrderSetParcelCustomTypeAction {
|
|
1275
|
+
readonly action: 'setParcelCustomType';
|
|
1276
|
+
/**
|
|
1277
|
+
*
|
|
1278
|
+
*/
|
|
1279
|
+
readonly parcelId: string;
|
|
1280
|
+
/**
|
|
1281
|
+
* Defines the [Type](ctp:api:type:Type) that extends the Parcel with [Custom Fields](/../api/projects/custom-fields).
|
|
1282
|
+
* If absent, any existing Type and Custom Fields are removed from the Parcel.
|
|
1283
|
+
*
|
|
1284
|
+
*
|
|
1285
|
+
*/
|
|
1286
|
+
readonly type?: TypeResourceIdentifier;
|
|
1287
|
+
/**
|
|
1288
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the Parcel.
|
|
1289
|
+
*
|
|
1290
|
+
*
|
|
1291
|
+
*/
|
|
1292
|
+
readonly fields?: FieldContainer;
|
|
1293
|
+
}
|
|
1294
|
+
export interface StagedOrderSetParcelItemsAction {
|
|
1295
|
+
readonly action: 'setParcelItems';
|
|
1296
|
+
/**
|
|
1297
|
+
*
|
|
1298
|
+
*/
|
|
1299
|
+
readonly parcelId: string;
|
|
1300
|
+
/**
|
|
1301
|
+
*
|
|
1302
|
+
*/
|
|
1303
|
+
readonly items: DeliveryItem[];
|
|
1304
|
+
}
|
|
1305
|
+
export interface StagedOrderSetParcelMeasurementsAction {
|
|
1306
|
+
readonly action: 'setParcelMeasurements';
|
|
1307
|
+
/**
|
|
1308
|
+
*
|
|
1309
|
+
*/
|
|
1310
|
+
readonly parcelId: string;
|
|
1311
|
+
/**
|
|
1312
|
+
*
|
|
1313
|
+
*/
|
|
1314
|
+
readonly measurements?: ParcelMeasurements;
|
|
1315
|
+
}
|
|
1316
|
+
export interface StagedOrderSetParcelTrackingDataAction {
|
|
1317
|
+
readonly action: 'setParcelTrackingData';
|
|
1318
|
+
/**
|
|
1319
|
+
*
|
|
1320
|
+
*/
|
|
1321
|
+
readonly parcelId: string;
|
|
1322
|
+
/**
|
|
1323
|
+
*
|
|
1324
|
+
*/
|
|
1325
|
+
readonly trackingData?: TrackingData;
|
|
1326
|
+
}
|
|
1327
|
+
export interface StagedOrderSetPurchaseOrderNumberAction {
|
|
1328
|
+
readonly action: 'setPurchaseOrderNumber';
|
|
1329
|
+
/**
|
|
1330
|
+
* Identifier for a purchase order, usually in a B2B context.
|
|
1331
|
+
* The Purchase Order Number is typically entered by the [Buyer](/quotes-overview#buyer) and can also be used with [Quotes](/quotes-overview).
|
|
1332
|
+
*
|
|
1333
|
+
*/
|
|
1334
|
+
readonly purchaseOrderNumber?: string;
|
|
1335
|
+
}
|
|
1336
|
+
export interface StagedOrderSetReturnInfoAction {
|
|
1337
|
+
readonly action: 'setReturnInfo';
|
|
1338
|
+
/**
|
|
1339
|
+
*
|
|
1340
|
+
*/
|
|
1341
|
+
readonly items?: ReturnInfoDraft[];
|
|
1342
|
+
}
|
|
1343
|
+
export interface StagedOrderSetReturnItemCustomFieldAction {
|
|
1344
|
+
readonly action: 'setReturnItemCustomField';
|
|
1345
|
+
/**
|
|
1346
|
+
*
|
|
1347
|
+
*/
|
|
1348
|
+
readonly returnItemId: string;
|
|
1349
|
+
/**
|
|
1350
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
1351
|
+
*
|
|
1352
|
+
*
|
|
1353
|
+
*/
|
|
1354
|
+
readonly name: string;
|
|
1355
|
+
/**
|
|
1356
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
1357
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
1358
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
1359
|
+
*
|
|
1360
|
+
*
|
|
1361
|
+
*/
|
|
1362
|
+
readonly value?: any;
|
|
1363
|
+
}
|
|
1364
|
+
export interface StagedOrderSetReturnItemCustomTypeAction {
|
|
1365
|
+
readonly action: 'setReturnItemCustomType';
|
|
1366
|
+
/**
|
|
1367
|
+
*
|
|
1368
|
+
*/
|
|
1369
|
+
readonly returnItemId: string;
|
|
1370
|
+
/**
|
|
1371
|
+
* Defines the [Type](ctp:api:type:Type) that extends the ReturnItem with [Custom Fields](/../api/projects/custom-fields).
|
|
1372
|
+
* If absent, any existing Type and Custom Fields are removed from the ReturnItem.
|
|
1373
|
+
*
|
|
1374
|
+
*
|
|
1375
|
+
*/
|
|
1376
|
+
readonly type?: TypeResourceIdentifier;
|
|
1377
|
+
/**
|
|
1378
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the ReturnItem.
|
|
1379
|
+
*
|
|
1380
|
+
*
|
|
1381
|
+
*/
|
|
1382
|
+
readonly fields?: FieldContainer;
|
|
1383
|
+
}
|
|
1384
|
+
export interface StagedOrderSetReturnPaymentStateAction {
|
|
1385
|
+
readonly action: 'setReturnPaymentState';
|
|
1386
|
+
/**
|
|
1387
|
+
*
|
|
1388
|
+
*/
|
|
1389
|
+
readonly returnItemId: string;
|
|
1390
|
+
/**
|
|
1391
|
+
*
|
|
1392
|
+
*/
|
|
1393
|
+
readonly paymentState: ReturnPaymentState;
|
|
1394
|
+
}
|
|
1395
|
+
export interface StagedOrderSetReturnShipmentStateAction {
|
|
1396
|
+
readonly action: 'setReturnShipmentState';
|
|
1397
|
+
/**
|
|
1398
|
+
*
|
|
1399
|
+
*/
|
|
1400
|
+
readonly returnItemId: string;
|
|
1401
|
+
/**
|
|
1402
|
+
*
|
|
1403
|
+
*/
|
|
1404
|
+
readonly shipmentState: ReturnShipmentState;
|
|
1405
|
+
}
|
|
1406
|
+
export interface StagedOrderSetShippingAddressAction {
|
|
1407
|
+
readonly action: 'setShippingAddress';
|
|
1408
|
+
/**
|
|
1409
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
1410
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
1411
|
+
* only differ in the data type for the optional `custom` field.
|
|
1412
|
+
*
|
|
1413
|
+
*
|
|
1414
|
+
*/
|
|
1415
|
+
readonly address?: _BaseAddress;
|
|
1416
|
+
}
|
|
1417
|
+
export interface StagedOrderSetShippingAddressAndCustomShippingMethodAction {
|
|
1418
|
+
readonly action: 'setShippingAddressAndCustomShippingMethod';
|
|
1419
|
+
/**
|
|
1420
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
1421
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
1422
|
+
* only differ in the data type for the optional `custom` field.
|
|
1423
|
+
*
|
|
1424
|
+
*
|
|
1425
|
+
*/
|
|
1426
|
+
readonly address: _BaseAddress;
|
|
1427
|
+
/**
|
|
1428
|
+
*
|
|
1429
|
+
*/
|
|
1430
|
+
readonly shippingMethodName: string;
|
|
1431
|
+
/**
|
|
1432
|
+
*
|
|
1433
|
+
*/
|
|
1434
|
+
readonly shippingRate: ShippingRateDraft;
|
|
1435
|
+
/**
|
|
1436
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [TaxCategory](ctp:api:type:TaxCategory).
|
|
1437
|
+
*
|
|
1438
|
+
*
|
|
1439
|
+
*/
|
|
1440
|
+
readonly taxCategory?: TaxCategoryResourceIdentifier;
|
|
1441
|
+
/**
|
|
1442
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
1443
|
+
*
|
|
1444
|
+
*
|
|
1445
|
+
*/
|
|
1446
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
1447
|
+
}
|
|
1448
|
+
export interface StagedOrderSetShippingAddressAndShippingMethodAction {
|
|
1449
|
+
readonly action: 'setShippingAddressAndShippingMethod';
|
|
1450
|
+
/**
|
|
1451
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
1452
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
1453
|
+
* only differ in the data type for the optional `custom` field.
|
|
1454
|
+
*
|
|
1455
|
+
*
|
|
1456
|
+
*/
|
|
1457
|
+
readonly address: _BaseAddress;
|
|
1458
|
+
/**
|
|
1459
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod).
|
|
1460
|
+
*
|
|
1461
|
+
*
|
|
1462
|
+
*/
|
|
1463
|
+
readonly shippingMethod?: ShippingMethodResourceIdentifier;
|
|
1464
|
+
/**
|
|
1465
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
1466
|
+
*
|
|
1467
|
+
*
|
|
1468
|
+
*/
|
|
1469
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
1470
|
+
}
|
|
1471
|
+
export interface StagedOrderSetShippingAddressCustomFieldAction {
|
|
1472
|
+
readonly action: 'setShippingAddressCustomField';
|
|
1473
|
+
/**
|
|
1474
|
+
* Name of the [Custom Field](/../api/projects/custom-fields).
|
|
1475
|
+
*
|
|
1476
|
+
*
|
|
1477
|
+
*/
|
|
1478
|
+
readonly name: string;
|
|
1479
|
+
/**
|
|
1480
|
+
* If `value` is absent or `null`, this field will be removed if it exists.
|
|
1481
|
+
* Removing a field that does not exist returns an [InvalidOperation](ctp:api:type:InvalidOperationError) error.
|
|
1482
|
+
* If `value` is provided, it is set for the field defined by `name`.
|
|
1483
|
+
*
|
|
1484
|
+
*
|
|
1485
|
+
*/
|
|
1486
|
+
readonly value?: any;
|
|
1487
|
+
}
|
|
1488
|
+
export interface StagedOrderSetShippingAddressCustomTypeAction {
|
|
1489
|
+
readonly action: 'setShippingAddressCustomType';
|
|
1490
|
+
/**
|
|
1491
|
+
* Defines the [Type](ctp:api:type:Type) that extends the `shippingAddress` with [Custom Fields](/../api/projects/custom-fields).
|
|
1492
|
+
* If absent, any existing Type and Custom Fields are removed from the `shippingAddress`.
|
|
1493
|
+
*
|
|
1494
|
+
*
|
|
1495
|
+
*/
|
|
1496
|
+
readonly type?: TypeResourceIdentifier;
|
|
1497
|
+
/**
|
|
1498
|
+
* Sets the [Custom Fields](/../api/projects/custom-fields) fields for the `shippingAddress`.
|
|
1499
|
+
*
|
|
1500
|
+
*
|
|
1501
|
+
*/
|
|
1502
|
+
readonly fields?: FieldContainer;
|
|
1503
|
+
}
|
|
1504
|
+
export interface StagedOrderSetShippingMethodAction {
|
|
1505
|
+
readonly action: 'setShippingMethod';
|
|
1506
|
+
/**
|
|
1507
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [ShippingMethod](ctp:api:type:ShippingMethod).
|
|
1508
|
+
*
|
|
1509
|
+
*
|
|
1510
|
+
*/
|
|
1511
|
+
readonly shippingMethod?: ShippingMethodResourceIdentifier;
|
|
1512
|
+
/**
|
|
1513
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
1514
|
+
*
|
|
1515
|
+
*
|
|
1516
|
+
*/
|
|
1517
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
1518
|
+
}
|
|
1519
|
+
export interface StagedOrderSetShippingMethodTaxAmountAction {
|
|
1520
|
+
readonly action: 'setShippingMethodTaxAmount';
|
|
1521
|
+
/**
|
|
1522
|
+
* Cannot be used in [LineItemDraft](ctp:api:type:LineItemDraft) or [CustomLineItemDraft](ctp:api:type:CustomLineItemDraft).
|
|
1523
|
+
*
|
|
1524
|
+
* Can only be set by these update actions:
|
|
1525
|
+
*
|
|
1526
|
+
* - [Set LineItem TaxAmount](ctp:api:type:CartSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:CartSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:CartSetShippingMethodTaxAmountAction) on Carts
|
|
1527
|
+
* - [Set LineItem TaxAmount](ctp:api:type:OrderEditSetLineItemTaxAmountAction), [Set CustomLineItem TaxAmount](ctp:api:type:OrderEditSetCustomLineItemTaxAmountAction), or [Set ShippingMethod TaxAmount](ctp:api:type:OrderEditSetShippingMethodTaxAmountAction) on Order Edits
|
|
1528
|
+
*
|
|
1529
|
+
*
|
|
1530
|
+
*/
|
|
1531
|
+
readonly externalTaxAmount?: ExternalTaxAmountDraft;
|
|
1532
|
+
}
|
|
1533
|
+
export interface StagedOrderSetShippingMethodTaxRateAction {
|
|
1534
|
+
readonly action: 'setShippingMethodTaxRate';
|
|
1535
|
+
/**
|
|
1536
|
+
* Controls calculation of taxed prices for Line Items, Custom Line Items, and Shipping Methods as explained in [Cart tax calculation](ctp:api:type:CartTaxCalculation).
|
|
1537
|
+
*
|
|
1538
|
+
*
|
|
1539
|
+
*/
|
|
1540
|
+
readonly externalTaxRate?: ExternalTaxRateDraft;
|
|
1541
|
+
}
|
|
1542
|
+
export interface StagedOrderSetShippingRateInputAction {
|
|
1543
|
+
readonly action: 'setShippingRateInput';
|
|
1544
|
+
/**
|
|
1545
|
+
* Generic type holding specifc ShippingRateInputDraft types.
|
|
1546
|
+
*
|
|
1547
|
+
*/
|
|
1548
|
+
readonly shippingRateInput?: ShippingRateInputDraft;
|
|
1549
|
+
}
|
|
1550
|
+
export interface StagedOrderTransitionCustomLineItemStateAction {
|
|
1551
|
+
readonly action: 'transitionCustomLineItemState';
|
|
1552
|
+
/**
|
|
1553
|
+
*
|
|
1554
|
+
*/
|
|
1555
|
+
readonly customLineItemId: string;
|
|
1556
|
+
/**
|
|
1557
|
+
*
|
|
1558
|
+
*/
|
|
1559
|
+
readonly quantity: number;
|
|
1560
|
+
/**
|
|
1561
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
|
|
1562
|
+
*
|
|
1563
|
+
*
|
|
1564
|
+
*/
|
|
1565
|
+
readonly fromState: StateResourceIdentifier;
|
|
1566
|
+
/**
|
|
1567
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
|
|
1568
|
+
*
|
|
1569
|
+
*
|
|
1570
|
+
*/
|
|
1571
|
+
readonly toState: StateResourceIdentifier;
|
|
1572
|
+
/**
|
|
1573
|
+
*
|
|
1574
|
+
*/
|
|
1575
|
+
readonly actualTransitionDate?: string;
|
|
1576
|
+
}
|
|
1577
|
+
export interface StagedOrderTransitionLineItemStateAction {
|
|
1578
|
+
readonly action: 'transitionLineItemState';
|
|
1579
|
+
/**
|
|
1580
|
+
*
|
|
1581
|
+
*/
|
|
1582
|
+
readonly lineItemId: string;
|
|
1583
|
+
/**
|
|
1584
|
+
*
|
|
1585
|
+
*/
|
|
1586
|
+
readonly quantity: number;
|
|
1587
|
+
/**
|
|
1588
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
|
|
1589
|
+
*
|
|
1590
|
+
*
|
|
1591
|
+
*/
|
|
1592
|
+
readonly fromState: StateResourceIdentifier;
|
|
1593
|
+
/**
|
|
1594
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
|
|
1595
|
+
*
|
|
1596
|
+
*
|
|
1597
|
+
*/
|
|
1598
|
+
readonly toState: StateResourceIdentifier;
|
|
1599
|
+
/**
|
|
1600
|
+
*
|
|
1601
|
+
*/
|
|
1602
|
+
readonly actualTransitionDate?: string;
|
|
1603
|
+
}
|
|
1604
|
+
export interface StagedOrderTransitionStateAction {
|
|
1605
|
+
readonly action: 'transitionState';
|
|
1606
|
+
/**
|
|
1607
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [State](ctp:api:type:State).
|
|
1608
|
+
*
|
|
1609
|
+
*
|
|
1610
|
+
*/
|
|
1611
|
+
readonly state: StateResourceIdentifier;
|
|
1612
|
+
/**
|
|
1613
|
+
*
|
|
1614
|
+
*/
|
|
1615
|
+
readonly force?: boolean;
|
|
1616
|
+
}
|
|
1617
|
+
export interface StagedOrderUpdateItemShippingAddressAction {
|
|
1618
|
+
readonly action: 'updateItemShippingAddress';
|
|
1619
|
+
/**
|
|
1620
|
+
* Polymorphic base type that represents a postal address and contact details.
|
|
1621
|
+
* Depending on the read or write action, it can be either [Address](ctp:api:type:Address) or [AddressDraft](ctp:api:type:AddressDraft) that
|
|
1622
|
+
* only differ in the data type for the optional `custom` field.
|
|
1623
|
+
*
|
|
1624
|
+
*
|
|
1625
|
+
*/
|
|
1626
|
+
readonly address: _BaseAddress;
|
|
1627
|
+
}
|
|
1628
|
+
export interface StagedOrderUpdateSyncInfoAction {
|
|
1629
|
+
readonly action: 'updateSyncInfo';
|
|
1630
|
+
/**
|
|
1631
|
+
* [ResourceIdentifier](ctp:api:type:ResourceIdentifier) to a [Channel](ctp:api:type:Channel).
|
|
1632
|
+
*
|
|
1633
|
+
*
|
|
1634
|
+
*/
|
|
1635
|
+
readonly channel: ChannelResourceIdentifier;
|
|
1636
|
+
/**
|
|
1637
|
+
*
|
|
1638
|
+
*/
|
|
1639
|
+
readonly externalId?: string;
|
|
1640
|
+
/**
|
|
1641
|
+
*
|
|
1642
|
+
*/
|
|
1643
|
+
readonly syncedAt?: string;
|
|
1644
|
+
}
|
|
1645
|
+
//# sourceMappingURL=order-edit.d.ts.map
|