@gradientedge/commercetools-utils 4.30.1 → 4.30.3
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/ge-commercetools-utils-browser.cjs.js +1 -1
- package/dist/ge-commercetools-utils-browser.cjs.js.map +1 -1
- package/dist/ge-commercetools-utils-browser.esm.js +1 -1
- package/dist/ge-commercetools-utils-browser.esm.js.map +1 -1
- package/dist/ge-commercetools-utils-node.cjs.js +1 -1
- package/dist/ge-commercetools-utils-node.cjs.js.map +1 -1
- package/dist/ge-commercetools-utils-node.esm.js +1 -1
- package/dist/typings/models/cart-discount.d.ts +6 -6
- package/dist/typings/models/cart.d.ts +16 -16
- package/dist/typings/models/category.d.ts +1 -1
- package/dist/typings/models/channel.d.ts +2 -2
- package/dist/typings/models/common.d.ts +8 -8
- package/dist/typings/models/customer-group.d.ts +1 -1
- package/dist/typings/models/customer.d.ts +3 -3
- package/dist/typings/models/discount-code.d.ts +1 -1
- package/dist/typings/models/error.d.ts +1 -1
- package/dist/typings/models/extension.d.ts +5 -5
- package/dist/typings/models/inventory.d.ts +1 -1
- package/dist/typings/models/me.d.ts +5 -5
- package/dist/typings/models/message.d.ts +4 -4
- package/dist/typings/models/order-edit.d.ts +2 -2
- package/dist/typings/models/order.d.ts +8 -8
- package/dist/typings/models/payment.d.ts +3 -24
- package/dist/typings/models/product-discount.d.ts +3 -3
- package/dist/typings/models/product-selection.d.ts +5 -5
- package/dist/typings/models/product-type.d.ts +6 -6
- package/dist/typings/models/product.d.ts +6 -6
- package/dist/typings/models/project.d.ts +4 -4
- package/dist/typings/models/quote-request.d.ts +2 -2
- package/dist/typings/models/quote.d.ts +2 -2
- package/dist/typings/models/review.d.ts +1 -1
- package/dist/typings/models/scalar-types.d.ts +4 -4
- package/dist/typings/models/shipping-method.d.ts +3 -3
- package/dist/typings/models/shopping-list.d.ts +1 -1
- package/dist/typings/models/staged-quote.d.ts +2 -2
- package/dist/typings/models/standalone-price.d.ts +1 -1
- package/dist/typings/models/state.d.ts +3 -3
- package/dist/typings/models/store.d.ts +1 -1
- package/dist/typings/models/subscription.d.ts +5 -5
- package/dist/typings/models/tax-category.d.ts +1 -1
- package/dist/typings/models/type.d.ts +5 -5
- package/dist/typings/models/zone.d.ts +1 -1
- package/package.json +23 -23
|
@@ -56,7 +56,7 @@ export interface CartDiscountResourceIdentifier {
|
|
|
56
56
|
readonly id?: string;
|
|
57
57
|
readonly key?: string;
|
|
58
58
|
}
|
|
59
|
-
export
|
|
59
|
+
export type CartDiscountTarget = CartDiscountCustomLineItemsTarget | CartDiscountLineItemsTarget | CartDiscountShippingCostTarget | MultiBuyCustomLineItemsTarget | MultiBuyLineItemsTarget;
|
|
60
60
|
export interface CartDiscountCustomLineItemsTarget {
|
|
61
61
|
readonly type: 'customLineItems';
|
|
62
62
|
readonly predicate: string;
|
|
@@ -72,13 +72,13 @@ export interface CartDiscountUpdate {
|
|
|
72
72
|
readonly version: number;
|
|
73
73
|
readonly actions: CartDiscountUpdateAction[];
|
|
74
74
|
}
|
|
75
|
-
export
|
|
76
|
-
export
|
|
75
|
+
export type CartDiscountUpdateAction = CartDiscountChangeCartPredicateAction | CartDiscountChangeIsActiveAction | CartDiscountChangeNameAction | CartDiscountChangeRequiresDiscountCodeAction | CartDiscountChangeSortOrderAction | CartDiscountChangeStackingModeAction | CartDiscountChangeTargetAction | CartDiscountChangeValueAction | CartDiscountSetCustomFieldAction | CartDiscountSetCustomTypeAction | CartDiscountSetDescriptionAction | CartDiscountSetKeyAction | CartDiscountSetValidFromAction | CartDiscountSetValidFromAndUntilAction | CartDiscountSetValidUntilAction;
|
|
76
|
+
export type CartDiscountValue = CartDiscountValueAbsolute | CartDiscountValueFixed | CartDiscountValueGiftLineItem | CartDiscountValueRelative;
|
|
77
77
|
export interface CartDiscountValueAbsolute {
|
|
78
78
|
readonly type: 'absolute';
|
|
79
79
|
readonly money: CentPrecisionMoney[];
|
|
80
80
|
}
|
|
81
|
-
export
|
|
81
|
+
export type CartDiscountValueDraft = CartDiscountValueAbsoluteDraft | CartDiscountValueFixedDraft | CartDiscountValueGiftLineItemDraft | CartDiscountValueRelativeDraft;
|
|
82
82
|
export interface CartDiscountValueAbsoluteDraft {
|
|
83
83
|
readonly type: 'absolute';
|
|
84
84
|
readonly money: Money[];
|
|
@@ -129,8 +129,8 @@ export interface MultiBuyLineItemsTarget {
|
|
|
129
129
|
readonly maxOccurrence?: number;
|
|
130
130
|
readonly selectionMode: SelectionMode;
|
|
131
131
|
}
|
|
132
|
-
export
|
|
133
|
-
export
|
|
132
|
+
export type SelectionMode = 'Cheapest' | 'MostExpensive';
|
|
133
|
+
export type StackingMode = 'Stacking' | 'StopAfterThisDiscount';
|
|
134
134
|
export interface CartDiscountChangeCartPredicateAction {
|
|
135
135
|
readonly action: 'changeCartPredicate';
|
|
136
136
|
readonly cartPredicate: string;
|
|
@@ -83,7 +83,7 @@ export interface CartDraft {
|
|
|
83
83
|
readonly itemShippingAddresses?: BaseAddress[];
|
|
84
84
|
readonly discountCodes?: string[];
|
|
85
85
|
}
|
|
86
|
-
export
|
|
86
|
+
export type CartOrigin = 'Customer' | 'Merchant' | 'Quote';
|
|
87
87
|
export interface CartPagedQueryResponse {
|
|
88
88
|
readonly limit: number;
|
|
89
89
|
readonly count: number;
|
|
@@ -101,12 +101,12 @@ export interface CartResourceIdentifier {
|
|
|
101
101
|
readonly id?: string;
|
|
102
102
|
readonly key?: string;
|
|
103
103
|
}
|
|
104
|
-
export
|
|
104
|
+
export type CartState = 'Active' | 'Merged' | 'Ordered';
|
|
105
105
|
export interface CartUpdate {
|
|
106
106
|
readonly version: number;
|
|
107
107
|
readonly actions: CartUpdateAction[];
|
|
108
108
|
}
|
|
109
|
-
export
|
|
109
|
+
export type CartUpdateAction = CartAddCustomLineItemAction | CartAddCustomShippingMethodAction | CartAddDiscountCodeAction | CartAddItemShippingAddressAction | CartAddLineItemAction | CartAddPaymentAction | CartAddShippingMethodAction | CartAddShoppingListAction | CartApplyDeltaToCustomLineItemShippingDetailsTargetsAction | CartApplyDeltaToLineItemShippingDetailsTargetsAction | CartChangeCustomLineItemMoneyAction | CartChangeCustomLineItemPriceModeAction | CartChangeCustomLineItemQuantityAction | CartChangeLineItemQuantityAction | CartChangeTaxCalculationModeAction | CartChangeTaxModeAction | CartChangeTaxRoundingModeAction | CartRecalculateAction | CartRemoveCustomLineItemAction | CartRemoveDiscountCodeAction | CartRemoveItemShippingAddressAction | CartRemoveLineItemAction | CartRemovePaymentAction | CartRemoveShippingMethodAction | CartSetAnonymousIdAction | CartSetBillingAddressAction | CartSetBillingAddressCustomFieldAction | CartSetBillingAddressCustomTypeAction | CartSetCartTotalTaxAction | CartSetCountryAction | CartSetCustomFieldAction | CartSetCustomLineItemCustomFieldAction | CartSetCustomLineItemCustomTypeAction | CartSetCustomLineItemShippingDetailsAction | CartSetCustomLineItemTaxAmountAction | CartSetCustomLineItemTaxRateAction | CartSetCustomShippingMethodAction | CartSetCustomTypeAction | CartSetCustomerEmailAction | CartSetCustomerGroupAction | CartSetCustomerIdAction | CartSetDeleteDaysAfterLastModificationAction | CartSetDeliveryAddressCustomFieldAction | CartSetDeliveryAddressCustomTypeAction | CartSetDirectDiscountsAction | CartSetItemShippingAddressCustomFieldAction | CartSetItemShippingAddressCustomTypeAction | CartSetKeyAction | CartSetLineItemCustomFieldAction | CartSetLineItemCustomTypeAction | CartSetLineItemDistributionChannelAction | CartSetLineItemPriceAction | CartSetLineItemShippingDetailsAction | CartSetLineItemSupplyChannelAction | CartSetLineItemTaxAmountAction | CartSetLineItemTaxRateAction | CartSetLineItemTotalPriceAction | CartSetLocaleAction | CartSetShippingAddressAction | CartSetShippingAddressCustomFieldAction | CartSetShippingAddressCustomTypeAction | CartSetShippingCustomFieldAction | CartSetShippingCustomTypeAction | CartSetShippingMethodAction | CartSetShippingMethodTaxAmountAction | CartSetShippingMethodTaxRateAction | CartSetShippingRateInputAction | CartUpdateItemShippingAddressAction;
|
|
110
110
|
export interface CustomLineItem {
|
|
111
111
|
readonly id: string;
|
|
112
112
|
readonly name: LocalizedString;
|
|
@@ -134,7 +134,7 @@ export interface CustomLineItemDraft {
|
|
|
134
134
|
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
135
135
|
readonly priceMode: CustomLineItemPriceMode;
|
|
136
136
|
}
|
|
137
|
-
export
|
|
137
|
+
export type CustomLineItemPriceMode = 'External' | 'Standard';
|
|
138
138
|
export interface CustomShippingDraft {
|
|
139
139
|
readonly key: string;
|
|
140
140
|
readonly shippingMethodName: string;
|
|
@@ -159,7 +159,7 @@ export interface DiscountCodeInfo {
|
|
|
159
159
|
readonly discountCode: DiscountCodeReference;
|
|
160
160
|
readonly state: DiscountCodeState;
|
|
161
161
|
}
|
|
162
|
-
export
|
|
162
|
+
export type DiscountCodeState = 'ApplicationStoppedByPreviousDiscount' | 'DoesNotMatchCart' | 'MatchesCart' | 'MaxApplicationReached' | 'NotActive' | 'NotValid';
|
|
163
163
|
export interface DiscountedLineItemPortion {
|
|
164
164
|
readonly discount: CartDiscountReference;
|
|
165
165
|
readonly discountedAmount: TypedMoney;
|
|
@@ -188,7 +188,7 @@ export interface ExternalTaxRateDraft {
|
|
|
188
188
|
readonly subRates?: SubRate[];
|
|
189
189
|
readonly includedInPrice?: boolean;
|
|
190
190
|
}
|
|
191
|
-
export
|
|
191
|
+
export type InventoryMode = 'None' | 'ReserveOnOrder' | 'TrackOnly';
|
|
192
192
|
export interface ItemShippingDetails {
|
|
193
193
|
readonly targets: ItemShippingTarget[];
|
|
194
194
|
readonly valid: boolean;
|
|
@@ -243,8 +243,8 @@ export interface LineItemDraft {
|
|
|
243
243
|
readonly inventoryMode?: InventoryMode;
|
|
244
244
|
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
245
245
|
}
|
|
246
|
-
export
|
|
247
|
-
export
|
|
246
|
+
export type LineItemMode = 'GiftLineItem' | 'Standard';
|
|
247
|
+
export type LineItemPriceMode = 'ExternalPrice' | 'ExternalTotal' | 'Platform';
|
|
248
248
|
export interface MethodTaxRate {
|
|
249
249
|
readonly shippingMethodKey: string;
|
|
250
250
|
readonly taxRate?: TaxRate;
|
|
@@ -257,7 +257,7 @@ export interface ReplicaCartDraft {
|
|
|
257
257
|
readonly reference: CartReference | OrderReference;
|
|
258
258
|
readonly key?: string;
|
|
259
259
|
}
|
|
260
|
-
export
|
|
260
|
+
export type RoundingMode = 'HalfDown' | 'HalfEven' | 'HalfUp';
|
|
261
261
|
export interface Shipping {
|
|
262
262
|
readonly shippingKey: string;
|
|
263
263
|
readonly shippingInfo: ShippingInfo;
|
|
@@ -286,9 +286,9 @@ export interface ShippingInfo {
|
|
|
286
286
|
readonly discountedPrice?: DiscountedLineItemPrice;
|
|
287
287
|
readonly shippingMethodState: ShippingMethodState;
|
|
288
288
|
}
|
|
289
|
-
export
|
|
290
|
-
export
|
|
291
|
-
export
|
|
289
|
+
export type ShippingMethodState = 'DoesNotMatchCart' | 'MatchesCart';
|
|
290
|
+
export type ShippingMode = 'Multiple' | 'Single';
|
|
291
|
+
export type ShippingRateInput = ClassificationShippingRateInput | ScoreShippingRateInput;
|
|
292
292
|
export interface ClassificationShippingRateInput {
|
|
293
293
|
readonly type: 'Classification';
|
|
294
294
|
readonly key: string;
|
|
@@ -298,7 +298,7 @@ export interface ScoreShippingRateInput {
|
|
|
298
298
|
readonly type: 'Score';
|
|
299
299
|
readonly score: number;
|
|
300
300
|
}
|
|
301
|
-
export
|
|
301
|
+
export type ShippingRateInputDraft = ClassificationShippingRateInputDraft | ScoreShippingRateInputDraft;
|
|
302
302
|
export interface ClassificationShippingRateInputDraft {
|
|
303
303
|
readonly type: 'Classification';
|
|
304
304
|
readonly key: string;
|
|
@@ -307,8 +307,8 @@ export interface ScoreShippingRateInputDraft {
|
|
|
307
307
|
readonly type: 'Score';
|
|
308
308
|
readonly score: number;
|
|
309
309
|
}
|
|
310
|
-
export
|
|
311
|
-
export
|
|
310
|
+
export type TaxCalculationMode = 'LineItemLevel' | 'UnitPriceLevel';
|
|
311
|
+
export type TaxMode = 'Disabled' | 'External' | 'ExternalAmount' | 'Platform';
|
|
312
312
|
export interface TaxPortion {
|
|
313
313
|
readonly name?: string;
|
|
314
314
|
readonly rate: number;
|
|
@@ -705,4 +705,4 @@ export interface CustomLineItemImportDraft {
|
|
|
705
705
|
readonly shippingDetails?: ItemShippingDetailsDraft;
|
|
706
706
|
readonly priceMode: CustomLineItemPriceMode;
|
|
707
707
|
}
|
|
708
|
-
export
|
|
708
|
+
export type ProductPublishScope = 'All' | 'Prices';
|
|
@@ -56,7 +56,7 @@ export interface CategoryUpdate {
|
|
|
56
56
|
readonly version: number;
|
|
57
57
|
readonly actions: CategoryUpdateAction[];
|
|
58
58
|
}
|
|
59
|
-
export
|
|
59
|
+
export type CategoryUpdateAction = CategoryAddAssetAction | CategoryChangeAssetNameAction | CategoryChangeAssetOrderAction | CategoryChangeNameAction | CategoryChangeOrderHintAction | CategoryChangeParentAction | CategoryChangeSlugAction | CategoryRemoveAssetAction | CategorySetAssetCustomFieldAction | CategorySetAssetCustomTypeAction | CategorySetAssetDescriptionAction | CategorySetAssetKeyAction | CategorySetAssetSourcesAction | CategorySetAssetTagsAction | CategorySetCustomFieldAction | CategorySetCustomTypeAction | CategorySetDescriptionAction | CategorySetExternalIdAction | CategorySetKeyAction | CategorySetMetaDescriptionAction | CategorySetMetaKeywordsAction | CategorySetMetaTitleAction;
|
|
60
60
|
export interface CategoryAddAssetAction {
|
|
61
61
|
readonly action: 'addAsset';
|
|
62
62
|
readonly asset: AssetDraft;
|
|
@@ -43,12 +43,12 @@ export interface ChannelResourceIdentifier {
|
|
|
43
43
|
readonly id?: string;
|
|
44
44
|
readonly key?: string;
|
|
45
45
|
}
|
|
46
|
-
export
|
|
46
|
+
export type ChannelRoleEnum = 'InventorySupply' | 'OrderExport' | 'OrderImport' | 'Primary' | 'ProductDistribution';
|
|
47
47
|
export interface ChannelUpdate {
|
|
48
48
|
readonly version: number;
|
|
49
49
|
readonly actions: ChannelUpdateAction[];
|
|
50
50
|
}
|
|
51
|
-
export
|
|
51
|
+
export type ChannelUpdateAction = ChannelAddRolesAction | ChannelChangeDescriptionAction | ChannelChangeKeyAction | ChannelChangeNameAction | ChannelRemoveRolesAction | ChannelSetAddressAction | ChannelSetAddressCustomFieldAction | ChannelSetAddressCustomTypeAction | ChannelSetCustomFieldAction | ChannelSetCustomTypeAction | ChannelSetGeoLocationAction | ChannelSetRolesAction;
|
|
52
52
|
export interface ChannelAddRolesAction {
|
|
53
53
|
readonly action: 'addRoles';
|
|
54
54
|
readonly roles: ChannelRoleEnum[];
|
|
@@ -130,7 +130,7 @@ export interface DiscountedPriceDraft {
|
|
|
130
130
|
readonly value: Money;
|
|
131
131
|
readonly discount: ProductDiscountReference;
|
|
132
132
|
}
|
|
133
|
-
export
|
|
133
|
+
export type GeoJson = GeoJsonPoint;
|
|
134
134
|
export interface GeoJsonPoint {
|
|
135
135
|
readonly type: 'Point';
|
|
136
136
|
readonly coordinates: number[];
|
|
@@ -144,7 +144,7 @@ export interface ImageDimensions {
|
|
|
144
144
|
readonly w: number;
|
|
145
145
|
readonly h: number;
|
|
146
146
|
}
|
|
147
|
-
export
|
|
147
|
+
export type KeyReference = StoreKeyReference;
|
|
148
148
|
export interface LastModifiedBy extends ClientLogging {
|
|
149
149
|
readonly clientId?: string;
|
|
150
150
|
readonly externalUserId?: string;
|
|
@@ -158,7 +158,7 @@ export interface Money {
|
|
|
158
158
|
readonly centAmount: number;
|
|
159
159
|
readonly currencyCode: string;
|
|
160
160
|
}
|
|
161
|
-
export
|
|
161
|
+
export type MoneyType = 'centPrecision' | 'highPrecision';
|
|
162
162
|
export interface Price {
|
|
163
163
|
readonly id: string;
|
|
164
164
|
readonly value: TypedMoney;
|
|
@@ -202,9 +202,9 @@ export interface QueryPrice {
|
|
|
202
202
|
readonly custom?: CustomFields;
|
|
203
203
|
readonly tiers?: PriceTierDraft[];
|
|
204
204
|
}
|
|
205
|
-
export
|
|
206
|
-
export
|
|
207
|
-
export
|
|
205
|
+
export type Reference = CartDiscountReference | CartReference | CategoryReference | ChannelReference | CustomObjectReference | CustomerGroupReference | CustomerReference | DiscountCodeReference | InventoryEntryReference | OrderEditReference | OrderReference | PaymentReference | ProductDiscountReference | ProductReference | ProductSelectionReference | ProductTypeReference | QuoteReference | QuoteRequestReference | ReviewReference | ShippingMethodReference | ShoppingListReference | StagedQuoteReference | StandalonePriceReference | StateReference | StoreReference | TaxCategoryReference | TypeReference | ZoneReference;
|
|
206
|
+
export type ReferenceTypeId = 'cart' | 'cart-discount' | 'category' | 'channel' | 'customer' | 'customer-group' | 'discount-code' | 'extension' | 'inventory-entry' | 'key-value-document' | 'order' | 'order-edit' | 'payment' | 'product' | 'product-discount' | 'product-price' | 'product-selection' | 'product-type' | 'quote' | 'quote-request' | 'review' | 'shipping-method' | 'shopping-list' | 'staged-quote' | 'standalone-price' | 'state' | 'store' | 'subscription' | 'tax-category' | 'type' | 'zone';
|
|
207
|
+
export type ResourceIdentifier = CartDiscountResourceIdentifier | CartResourceIdentifier | CategoryResourceIdentifier | ChannelResourceIdentifier | CustomerGroupResourceIdentifier | CustomerResourceIdentifier | DiscountCodeResourceIdentifier | InventoryEntryResourceIdentifier | OrderEditResourceIdentifier | OrderResourceIdentifier | PaymentResourceIdentifier | ProductDiscountResourceIdentifier | ProductResourceIdentifier | ProductSelectionResourceIdentifier | ProductTypeResourceIdentifier | QuoteRequestResourceIdentifier | QuoteResourceIdentifier | ReviewResourceIdentifier | ShippingMethodResourceIdentifier | ShoppingListResourceIdentifier | StagedQuoteResourceIdentifier | StandalonePriceResourceIdentifier | StateResourceIdentifier | StoreResourceIdentifier | TaxCategoryResourceIdentifier | TypeResourceIdentifier | ZoneResourceIdentifier;
|
|
208
208
|
export interface ScopedPrice {
|
|
209
209
|
readonly id: string;
|
|
210
210
|
readonly value: TypedMoney;
|
|
@@ -217,7 +217,7 @@ export interface ScopedPrice {
|
|
|
217
217
|
readonly discounted?: DiscountedPrice;
|
|
218
218
|
readonly custom?: CustomFields;
|
|
219
219
|
}
|
|
220
|
-
export
|
|
220
|
+
export type TypedMoney = CentPrecisionMoney | HighPrecisionMoney;
|
|
221
221
|
export interface CentPrecisionMoney {
|
|
222
222
|
readonly type: 'centPrecision';
|
|
223
223
|
readonly centAmount: number;
|
|
@@ -231,7 +231,7 @@ export interface HighPrecisionMoney {
|
|
|
231
231
|
readonly fractionDigits: number;
|
|
232
232
|
readonly preciseAmount: number;
|
|
233
233
|
}
|
|
234
|
-
export
|
|
234
|
+
export type TypedMoneyDraft = CentPrecisionMoneyDraft | HighPrecisionMoneyDraft;
|
|
235
235
|
export interface CentPrecisionMoneyDraft {
|
|
236
236
|
readonly type: 'centPrecision';
|
|
237
237
|
readonly centAmount: number;
|
|
@@ -37,7 +37,7 @@ export interface CustomerGroupUpdate {
|
|
|
37
37
|
readonly version: number;
|
|
38
38
|
readonly actions: CustomerGroupUpdateAction[];
|
|
39
39
|
}
|
|
40
|
-
export
|
|
40
|
+
export type CustomerGroupUpdateAction = CustomerGroupChangeNameAction | CustomerGroupSetCustomFieldAction | CustomerGroupSetCustomTypeAction | CustomerGroupSetKeyAction;
|
|
41
41
|
export interface CustomerGroupChangeNameAction {
|
|
42
42
|
readonly action: 'changeName';
|
|
43
43
|
readonly name: string;
|
|
@@ -3,8 +3,8 @@ import { Address, BaseAddress, BaseResource, CreatedBy, LastModifiedBy } from '.
|
|
|
3
3
|
import { CustomerGroupReference, CustomerGroupResourceIdentifier } from './customer-group';
|
|
4
4
|
import { StoreKeyReference, StoreResourceIdentifier } from './store';
|
|
5
5
|
import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
|
|
6
|
-
export
|
|
7
|
-
export
|
|
6
|
+
export type AnonymousCartSignInMode = 'MergeWithExistingCustomerCart' | 'UseAsNewActiveCustomerCart';
|
|
7
|
+
export type AuthenticationMode = 'ExternalAuth' | 'Password';
|
|
8
8
|
export interface Customer extends BaseResource {
|
|
9
9
|
readonly id: string;
|
|
10
10
|
readonly version: number;
|
|
@@ -132,7 +132,7 @@ export interface CustomerUpdate {
|
|
|
132
132
|
readonly version: number;
|
|
133
133
|
readonly actions: CustomerUpdateAction[];
|
|
134
134
|
}
|
|
135
|
-
export
|
|
135
|
+
export type CustomerUpdateAction = CustomerAddAddressAction | CustomerAddBillingAddressIdAction | CustomerAddShippingAddressIdAction | CustomerAddStoreAction | CustomerChangeAddressAction | CustomerChangeEmailAction | CustomerRemoveAddressAction | CustomerRemoveBillingAddressIdAction | CustomerRemoveShippingAddressIdAction | CustomerRemoveStoreAction | CustomerSetAddressCustomFieldAction | CustomerSetAddressCustomTypeAction | CustomerSetAuthenticationModeAction | CustomerSetCompanyNameAction | CustomerSetCustomFieldAction | CustomerSetCustomTypeAction | CustomerSetCustomerGroupAction | CustomerSetCustomerNumberAction | CustomerSetDateOfBirthAction | CustomerSetDefaultBillingAddressAction | CustomerSetDefaultShippingAddressAction | CustomerSetExternalIdAction | CustomerSetFirstNameAction | CustomerSetKeyAction | CustomerSetLastNameAction | CustomerSetLocaleAction | CustomerSetMiddleNameAction | CustomerSetSalutationAction | CustomerSetStoresAction | CustomerSetTitleAction | CustomerSetVatIdAction;
|
|
136
136
|
export interface MyCustomerChangePassword {
|
|
137
137
|
readonly version: number;
|
|
138
138
|
readonly currentPassword: string;
|
|
@@ -58,7 +58,7 @@ export interface DiscountCodeUpdate {
|
|
|
58
58
|
readonly version: number;
|
|
59
59
|
readonly actions: DiscountCodeUpdateAction[];
|
|
60
60
|
}
|
|
61
|
-
export
|
|
61
|
+
export type DiscountCodeUpdateAction = DiscountCodeChangeCartDiscountsAction | DiscountCodeChangeGroupsAction | DiscountCodeChangeIsActiveAction | DiscountCodeSetCartPredicateAction | DiscountCodeSetCustomFieldAction | DiscountCodeSetCustomTypeAction | DiscountCodeSetDescriptionAction | DiscountCodeSetMaxApplicationsAction | DiscountCodeSetMaxApplicationsPerCustomerAction | DiscountCodeSetNameAction | DiscountCodeSetValidFromAction | DiscountCodeSetValidFromAndUntilAction | DiscountCodeSetValidUntilAction;
|
|
62
62
|
export interface DiscountCodeChangeCartDiscountsAction {
|
|
63
63
|
readonly action: 'changeCartDiscounts';
|
|
64
64
|
readonly cartDiscounts: CartDiscountResourceIdentifier[];
|
|
@@ -8,7 +8,7 @@ export interface ErrorByExtension {
|
|
|
8
8
|
readonly id: string;
|
|
9
9
|
readonly key?: string;
|
|
10
10
|
}
|
|
11
|
-
export
|
|
11
|
+
export type ErrorObject = AccessDeniedError | AnonymousIdAlreadyInUseError | AttributeDefinitionAlreadyExistsError | AttributeDefinitionTypeConflictError | AttributeNameDoesNotExistError | BadGatewayError | ConcurrentModificationError | DiscountCodeNonApplicableError | DuplicateAttributeValueError | DuplicateAttributeValuesError | DuplicateEnumValuesError | DuplicateFieldError | DuplicateFieldWithConflictingResourceError | DuplicatePriceScopeError | DuplicateStandalonePriceScopeError | DuplicateVariantValuesError | EditPreviewFailedError | EnumKeyAlreadyExistsError | EnumKeyDoesNotExistError | EnumValueIsUsedError | EnumValuesMustMatchError | ExtensionBadResponseError | ExtensionNoResponseError | ExtensionUpdateActionsFailedError | ExternalOAuthFailedError | FeatureRemovedError | GeneralError | InsufficientScopeError | InternalConstraintViolatedError | InvalidCredentialsError | InvalidCurrentPasswordError | InvalidFieldError | InvalidInputError | InvalidItemShippingDetailsError | InvalidJsonInputError | InvalidOperationError | InvalidSubjectError | InvalidTokenError | LanguageUsedInStoresError | MatchingPriceNotFoundError | MaxResourceLimitExceededError | MissingRoleOnChannelError | MissingTaxRateForCountryError | NoMatchingProductDiscountFoundError | NotEnabledError | ObjectNotFoundError | OutOfStockError | OverCapacityError | OverlappingStandalonePriceValidityError | PendingOperationError | PriceChangedError | ProjectNotConfiguredForLanguagesError | QueryComplexityLimitExceededError | QueryTimedOutError | ReferenceExistsError | ReferencedResourceNotFoundError | RequiredFieldError | ResourceNotFoundError | ResourceSizeLimitExceededError | SearchDeactivatedError | SearchExecutionFailureError | SearchFacetPathNotFoundError | SearchIndexingInProgressError | SemanticErrorError | ShippingMethodDoesNotMatchCartError | SyntaxErrorError | WeakPasswordError;
|
|
12
12
|
export interface AccessDeniedError {
|
|
13
13
|
readonly code: 'access_denied';
|
|
14
14
|
[key: string]: any;
|
|
@@ -11,8 +11,8 @@ export interface Extension extends BaseResource {
|
|
|
11
11
|
readonly triggers: ExtensionTrigger[];
|
|
12
12
|
readonly timeoutInMs?: number;
|
|
13
13
|
}
|
|
14
|
-
export
|
|
15
|
-
export
|
|
14
|
+
export type ExtensionAction = 'Create' | 'Update';
|
|
15
|
+
export type ExtensionDestination = AWSLambdaDestination | HttpDestination;
|
|
16
16
|
export interface AWSLambdaDestination {
|
|
17
17
|
readonly type: 'AWSLambda';
|
|
18
18
|
readonly arn: string;
|
|
@@ -36,7 +36,7 @@ export interface ExtensionPagedQueryResponse {
|
|
|
36
36
|
readonly total?: number;
|
|
37
37
|
readonly results: Extension[];
|
|
38
38
|
}
|
|
39
|
-
export
|
|
39
|
+
export type ExtensionResourceTypeId = 'cart' | 'customer' | 'order' | 'payment' | 'quote' | 'quote-request' | 'staged-quote';
|
|
40
40
|
export interface ExtensionTrigger {
|
|
41
41
|
readonly resourceTypeId: ExtensionResourceTypeId;
|
|
42
42
|
readonly actions: ExtensionAction[];
|
|
@@ -46,13 +46,13 @@ export interface ExtensionUpdate {
|
|
|
46
46
|
readonly version: number;
|
|
47
47
|
readonly actions: ExtensionUpdateAction[];
|
|
48
48
|
}
|
|
49
|
-
export
|
|
49
|
+
export type ExtensionUpdateAction = ExtensionChangeDestinationAction | ExtensionChangeTriggersAction | ExtensionSetKeyAction | ExtensionSetTimeoutInMsAction;
|
|
50
50
|
export interface HttpDestination {
|
|
51
51
|
readonly type: 'HTTP';
|
|
52
52
|
readonly url: string;
|
|
53
53
|
readonly authentication?: HttpDestinationAuthentication;
|
|
54
54
|
}
|
|
55
|
-
export
|
|
55
|
+
export type HttpDestinationAuthentication = AuthorizationHeaderAuthentication | AzureFunctionsAuthentication;
|
|
56
56
|
export interface AuthorizationHeaderAuthentication {
|
|
57
57
|
readonly type: 'AuthorizationHeader';
|
|
58
58
|
readonly headerValue: string;
|
|
@@ -40,7 +40,7 @@ export interface InventoryEntryUpdate {
|
|
|
40
40
|
readonly version: number;
|
|
41
41
|
readonly actions: InventoryEntryUpdateAction[];
|
|
42
42
|
}
|
|
43
|
-
export
|
|
43
|
+
export type InventoryEntryUpdateAction = InventoryEntryAddQuantityAction | InventoryEntryChangeQuantityAction | InventoryEntryRemoveQuantityAction | InventoryEntrySetCustomFieldAction | InventoryEntrySetCustomTypeAction | InventoryEntrySetExpectedDeliveryAction | InventoryEntrySetKeyAction | InventoryEntrySetRestockableInDaysAction | InventoryEntrySetSupplyChannelAction;
|
|
44
44
|
export interface InventoryPagedQueryResponse {
|
|
45
45
|
readonly limit: number;
|
|
46
46
|
readonly offset: number;
|
|
@@ -30,7 +30,7 @@ export interface MyCartUpdate {
|
|
|
30
30
|
readonly version: number;
|
|
31
31
|
readonly actions: MyCartUpdateAction[];
|
|
32
32
|
}
|
|
33
|
-
export
|
|
33
|
+
export type MyCartUpdateAction = MyCartAddDiscountCodeAction | MyCartAddItemShippingAddressAction | MyCartAddLineItemAction | MyCartAddPaymentAction | MyCartApplyDeltaToLineItemShippingDetailsTargetsAction | MyCartChangeLineItemQuantityAction | MyCartChangeTaxModeAction | MyCartRecalculateAction | MyCartRemoveDiscountCodeAction | MyCartRemoveItemShippingAddressAction | MyCartRemoveLineItemAction | MyCartRemovePaymentAction | MyCartSetBillingAddressAction | MyCartSetCountryAction | MyCartSetCustomFieldAction | MyCartSetCustomTypeAction | MyCartSetCustomerEmailAction | MyCartSetDeleteDaysAfterLastModificationAction | MyCartSetLineItemCustomFieldAction | MyCartSetLineItemCustomTypeAction | MyCartSetLineItemDistributionChannelAction | MyCartSetLineItemShippingDetailsAction | MyCartSetLineItemSupplyChannelAction | MyCartSetLocaleAction | MyCartSetShippingAddressAction | MyCartSetShippingMethodAction | MyCartUpdateItemShippingAddressAction;
|
|
34
34
|
export interface MyCustomerDraft {
|
|
35
35
|
readonly email: string;
|
|
36
36
|
readonly password: string;
|
|
@@ -52,7 +52,7 @@ export interface MyCustomerUpdate {
|
|
|
52
52
|
readonly version: number;
|
|
53
53
|
readonly actions: MyCustomerUpdateAction[];
|
|
54
54
|
}
|
|
55
|
-
export
|
|
55
|
+
export type MyCustomerUpdateAction = MyCustomerAddAddressAction | MyCustomerAddBillingAddressIdAction | MyCustomerAddShippingAddressIdAction | MyCustomerChangeAddressAction | MyCustomerChangeEmailAction | MyCustomerRemoveAddressAction | MyCustomerRemoveBillingAddressIdAction | MyCustomerRemoveShippingAddressIdAction | MyCustomerSetCompanyNameAction | MyCustomerSetCustomFieldAction | MyCustomerSetCustomTypeAction | MyCustomerSetDateOfBirthAction | MyCustomerSetDefaultBillingAddressAction | MyCustomerSetDefaultShippingAddressAction | MyCustomerSetFirstNameAction | MyCustomerSetLastNameAction | MyCustomerSetLocaleAction | MyCustomerSetMiddleNameAction | MyCustomerSetSalutationAction | MyCustomerSetTitleAction | MyCustomerSetVatIdAction;
|
|
56
56
|
export interface MyLineItemDraft {
|
|
57
57
|
readonly productId?: string;
|
|
58
58
|
readonly variantId?: number;
|
|
@@ -95,7 +95,7 @@ export interface MyPaymentUpdate {
|
|
|
95
95
|
readonly version: number;
|
|
96
96
|
readonly actions: MyPaymentUpdateAction[];
|
|
97
97
|
}
|
|
98
|
-
export
|
|
98
|
+
export type MyPaymentUpdateAction = MyPaymentAddTransactionAction | MyPaymentChangeAmountPlannedAction | MyPaymentSetCustomFieldAction | MyPaymentSetMethodInfoInterfaceAction | MyPaymentSetMethodInfoMethodAction | MyPaymentSetMethodInfoNameAction | MyPaymentSetTransactionCustomFieldAction;
|
|
99
99
|
export interface MyQuoteRequestDraft {
|
|
100
100
|
readonly cart: CartResourceIdentifier;
|
|
101
101
|
readonly version: number;
|
|
@@ -105,7 +105,7 @@ export interface MyQuoteRequestUpdate {
|
|
|
105
105
|
readonly version: number;
|
|
106
106
|
readonly actions: MyQuoteRequestUpdateAction[];
|
|
107
107
|
}
|
|
108
|
-
export
|
|
108
|
+
export type MyQuoteRequestUpdateAction = MyQuoteRequestCancelAction;
|
|
109
109
|
export interface MyShoppingListDraft {
|
|
110
110
|
readonly name: LocalizedString;
|
|
111
111
|
readonly description?: LocalizedString;
|
|
@@ -119,7 +119,7 @@ export interface MyShoppingListUpdate {
|
|
|
119
119
|
readonly version: number;
|
|
120
120
|
readonly actions: MyShoppingListUpdateAction[];
|
|
121
121
|
}
|
|
122
|
-
export
|
|
122
|
+
export type MyShoppingListUpdateAction = MyShoppingListAddLineItemAction | MyShoppingListAddTextLineItemAction | MyShoppingListChangeLineItemQuantityAction | MyShoppingListChangeLineItemsOrderAction | MyShoppingListChangeNameAction | MyShoppingListChangeTextLineItemNameAction | MyShoppingListChangeTextLineItemQuantityAction | MyShoppingListChangeTextLineItemsOrderAction | MyShoppingListRemoveLineItemAction | MyShoppingListRemoveTextLineItemAction | MyShoppingListSetCustomFieldAction | MyShoppingListSetCustomTypeAction | MyShoppingListSetDeleteDaysAfterLastModificationAction | MyShoppingListSetDescriptionAction | MyShoppingListSetLineItemCustomFieldAction | MyShoppingListSetLineItemCustomTypeAction | MyShoppingListSetTextLineItemCustomFieldAction | MyShoppingListSetTextLineItemCustomTypeAction | MyShoppingListSetTextLineItemDescriptionAction;
|
|
123
123
|
export interface MyTransactionDraft {
|
|
124
124
|
readonly timestamp?: string;
|
|
125
125
|
readonly type: TransactionType;
|
|
@@ -23,7 +23,7 @@ export interface ContainerAndKey {
|
|
|
23
23
|
readonly key: string;
|
|
24
24
|
readonly container: string;
|
|
25
25
|
}
|
|
26
|
-
export
|
|
26
|
+
export type Message = CategoryCreatedMessage | CategorySlugChangedMessage | CustomLineItemStateTransitionMessage | CustomerAddressAddedMessage | CustomerAddressChangedMessage | CustomerAddressRemovedMessage | CustomerCompanyNameSetMessage | CustomerCreatedMessage | CustomerDateOfBirthSetMessage | CustomerDeletedMessage | CustomerEmailChangedMessage | CustomerEmailVerifiedMessage | CustomerFirstNameSetMessage | CustomerGroupSetMessage | CustomerLastNameSetMessage | CustomerPasswordUpdatedMessage | CustomerTitleSetMessage | DeliveryAddedMessage | DeliveryAddressSetMessage | DeliveryItemsUpdatedMessage | DeliveryRemovedMessage | InventoryEntryCreatedMessage | InventoryEntryDeletedMessage | InventoryEntryQuantitySetMessage | LineItemStateTransitionMessage | OrderBillingAddressSetMessage | OrderCreatedMessage | OrderCustomLineItemAddedMessage | OrderCustomLineItemDiscountSetMessage | OrderCustomLineItemQuantityChangedMessage | OrderCustomLineItemRemovedMessage | OrderCustomerEmailSetMessage | OrderCustomerGroupSetMessage | OrderCustomerSetMessage | OrderDeletedMessage | OrderDiscountCodeAddedMessage | OrderDiscountCodeRemovedMessage | OrderDiscountCodeStateSetMessage | OrderEditAppliedMessage | OrderImportedMessage | OrderLineItemAddedMessage | OrderLineItemDiscountSetMessage | OrderLineItemDistributionChannelSetMessage | OrderLineItemRemovedMessage | OrderMessage | OrderPaymentAddedMessage | OrderPaymentStateChangedMessage | OrderReturnShipmentStateChangedMessage | OrderShipmentStateChangedMessage | OrderShippingAddressSetMessage | OrderShippingInfoSetMessage | OrderShippingRateInputSetMessage | OrderStateChangedMessage | OrderStateTransitionMessage | OrderStoreSetMessage | ParcelAddedToDeliveryMessage | ParcelItemsUpdatedMessage | ParcelMeasurementsUpdatedMessage | ParcelRemovedFromDeliveryMessage | ParcelTrackingDataUpdatedMessage | PaymentCreatedMessage | PaymentInteractionAddedMessage | PaymentStatusInterfaceCodeSetMessage | PaymentStatusStateTransitionMessage | PaymentTransactionAddedMessage | PaymentTransactionStateChangedMessage | ProductAddedToCategoryMessage | ProductCreatedMessage | ProductDeletedMessage | ProductImageAddedMessage | ProductPriceDiscountsSetMessage | ProductPriceExternalDiscountSetMessage | ProductPublishedMessage | ProductRemovedFromCategoryMessage | ProductRevertedStagedChangesMessage | ProductSelectionCreatedMessage | ProductSelectionDeletedMessage | ProductSelectionProductAddedMessage | ProductSelectionProductRemovedMessage | ProductSelectionVariantSelectionChangedMessage | ProductSlugChangedMessage | ProductStateTransitionMessage | ProductUnpublishedMessage | ProductVariantAddedMessage | ProductVariantDeletedMessage | QuoteCreatedMessage | QuoteDeletedMessage | QuoteRequestCreatedMessage | QuoteRequestDeletedMessage | QuoteRequestStateChangedMessage | QuoteRequestStateTransitionMessage | QuoteStateChangedMessage | QuoteStateTransitionMessage | ReturnInfoAddedMessage | ReturnInfoSetMessage | ReviewCreatedMessage | ReviewRatingSetMessage | ReviewStateTransitionMessage | StagedQuoteCreatedMessage | StagedQuoteDeletedMessage | StagedQuoteSellerCommentSetMessage | StagedQuoteStateChangedMessage | StagedQuoteStateTransitionMessage | StagedQuoteValidToSetMessage | StandalonePriceActiveChangedMessage | StandalonePriceCreatedMessage | StandalonePriceDeletedMessage | StandalonePriceDiscountSetMessage | StandalonePriceExternalDiscountSetMessage | StandalonePriceStagedChangesAppliedMessage | StandalonePriceValueChangedMessage | StoreCreatedMessage | StoreDeletedMessage | StoreDistributionChannelsChangedMessage | StoreLanguagesChangedMessage | StoreNameSetMessage | StoreProductSelectionsChangedMessage;
|
|
27
27
|
export interface CategoryCreatedMessage {
|
|
28
28
|
readonly type: 'CategoryCreated';
|
|
29
29
|
readonly id: string;
|
|
@@ -309,7 +309,7 @@ export interface MessagesConfigurationDraft {
|
|
|
309
309
|
readonly enabled: boolean;
|
|
310
310
|
readonly deleteDaysAfterCreation: number;
|
|
311
311
|
}
|
|
312
|
-
export
|
|
312
|
+
export type OrderMessage = CustomLineItemStateTransitionMessage | DeliveryAddedMessage | DeliveryAddressSetMessage | DeliveryItemsUpdatedMessage | DeliveryRemovedMessage | LineItemStateTransitionMessage | OrderBillingAddressSetMessage | OrderCreatedMessage | OrderCustomLineItemAddedMessage | OrderCustomLineItemDiscountSetMessage | OrderCustomLineItemQuantityChangedMessage | OrderCustomLineItemRemovedMessage | OrderCustomerEmailSetMessage | OrderCustomerGroupSetMessage | OrderCustomerSetMessage | OrderDeletedMessage | OrderDiscountCodeAddedMessage | OrderDiscountCodeRemovedMessage | OrderDiscountCodeStateSetMessage | OrderEditAppliedMessage | OrderImportedMessage | OrderLineItemAddedMessage | OrderLineItemDiscountSetMessage | OrderLineItemDistributionChannelSetMessage | OrderLineItemRemovedMessage | OrderPaymentStateChangedMessage | OrderReturnShipmentStateChangedMessage | OrderShipmentStateChangedMessage | OrderShippingAddressSetMessage | OrderShippingInfoSetMessage | OrderShippingRateInputSetMessage | OrderStateChangedMessage | OrderStateTransitionMessage | OrderStoreSetMessage | ParcelAddedToDeliveryMessage | ParcelItemsUpdatedMessage | ParcelMeasurementsUpdatedMessage | ParcelRemovedFromDeliveryMessage | ParcelTrackingDataUpdatedMessage | ReturnInfoAddedMessage | ReturnInfoSetMessage;
|
|
313
313
|
export interface CustomLineItemStateTransitionMessage {
|
|
314
314
|
readonly type: 'CustomLineItemStateTransition';
|
|
315
315
|
readonly id: string;
|
|
@@ -1795,7 +1795,7 @@ export interface UserProvidedIdentifiers {
|
|
|
1795
1795
|
readonly slug?: LocalizedString;
|
|
1796
1796
|
readonly containerAndKey?: ContainerAndKey;
|
|
1797
1797
|
}
|
|
1798
|
-
export
|
|
1798
|
+
export type MessagePayload = CategoryCreatedMessagePayload | CategorySlugChangedMessagePayload | CustomLineItemStateTransitionMessagePayload | CustomerAddressAddedMessagePayload | CustomerAddressChangedMessagePayload | CustomerAddressRemovedMessagePayload | CustomerCompanyNameSetMessagePayload | CustomerCreatedMessagePayload | CustomerDateOfBirthSetMessagePayload | CustomerDeletedMessagePayload | CustomerEmailChangedMessagePayload | CustomerEmailVerifiedMessagePayload | CustomerFirstNameSetMessagePayload | CustomerGroupSetMessagePayload | CustomerLastNameSetMessagePayload | CustomerPasswordUpdatedMessagePayload | CustomerTitleSetMessagePayload | DeliveryAddedMessagePayload | DeliveryAddressSetMessagePayload | DeliveryItemsUpdatedMessagePayload | DeliveryRemovedMessagePayload | InventoryEntryCreatedMessagePayload | InventoryEntryDeletedMessagePayload | InventoryEntryQuantitySetMessagePayload | LineItemStateTransitionMessagePayload | OrderBillingAddressSetMessagePayload | OrderCreatedMessagePayload | OrderCustomLineItemAddedMessagePayload | OrderCustomLineItemDiscountSetMessagePayload | OrderCustomLineItemQuantityChangedMessagePayload | OrderCustomLineItemRemovedMessagePayload | OrderCustomerEmailSetMessagePayload | OrderCustomerGroupSetMessagePayload | OrderCustomerSetMessagePayload | OrderDeletedMessagePayload | OrderDiscountCodeAddedMessagePayload | OrderDiscountCodeRemovedMessagePayload | OrderDiscountCodeStateSetMessagePayload | OrderEditAppliedMessagePayload | OrderImportedMessagePayload | OrderLineItemAddedMessagePayload | OrderLineItemDiscountSetMessagePayload | OrderLineItemDistributionChannelSetMessagePayload | OrderLineItemRemovedMessagePayload | OrderMessagePayload | OrderPaymentAddedMessagePayload | OrderPaymentStateChangedMessagePayload | OrderReturnShipmentStateChangedMessagePayload | OrderShipmentStateChangedMessagePayload | OrderShippingAddressSetMessagePayload | OrderShippingInfoSetMessagePayload | OrderShippingRateInputSetMessagePayload | OrderStateChangedMessagePayload | OrderStateTransitionMessagePayload | OrderStoreSetMessagePayload | ParcelAddedToDeliveryMessagePayload | ParcelItemsUpdatedMessagePayload | ParcelMeasurementsUpdatedMessagePayload | ParcelRemovedFromDeliveryMessagePayload | ParcelTrackingDataUpdatedMessagePayload | PaymentCreatedMessagePayload | PaymentInteractionAddedMessagePayload | PaymentStatusInterfaceCodeSetMessagePayload | PaymentStatusStateTransitionMessagePayload | PaymentTransactionAddedMessagePayload | PaymentTransactionStateChangedMessagePayload | ProductAddedToCategoryMessagePayload | ProductCreatedMessagePayload | ProductDeletedMessagePayload | ProductImageAddedMessagePayload | ProductPriceDiscountsSetMessagePayload | ProductPriceExternalDiscountSetMessagePayload | ProductPublishedMessagePayload | ProductRemovedFromCategoryMessagePayload | ProductRevertedStagedChangesMessagePayload | ProductSelectionCreatedMessagePayload | ProductSelectionDeletedMessagePayload | ProductSelectionProductAddedMessagePayload | ProductSelectionProductRemovedMessagePayload | ProductSelectionVariantSelectionChangedMessagePayload | ProductSlugChangedMessagePayload | ProductStateTransitionMessagePayload | ProductUnpublishedMessagePayload | ProductVariantAddedMessagePayload | ProductVariantDeletedMessagePayload | QuoteCreatedMessagePayload | QuoteDeletedMessagePayload | QuoteRequestCreatedMessagePayload | QuoteRequestDeletedMessagePayload | QuoteRequestStateChangedMessagePayload | QuoteRequestStateTransitionMessagePayload | QuoteStateChangedMessagePayload | QuoteStateTransitionMessagePayload | ReturnInfoAddedMessagePayload | ReturnInfoSetMessagePayload | ReviewCreatedMessagePayload | ReviewRatingSetMessagePayload | ReviewStateTransitionMessagePayload | ShoppingListStoreSetMessagePayload | StagedQuoteCreatedMessagePayload | StagedQuoteDeletedMessagePayload | StagedQuoteSellerCommentSetMessagePayload | StagedQuoteStateChangedMessagePayload | StagedQuoteStateTransitionMessagePayload | StagedQuoteValidToSetMessagePayload | StandalonePriceActiveChangedMessagePayload | StandalonePriceCreatedMessagePayload | StandalonePriceDeletedMessagePayload | StandalonePriceDiscountSetMessagePayload | StandalonePriceExternalDiscountSetMessagePayload | StandalonePriceStagedChangesAppliedMessagePayload | StandalonePriceValueChangedMessagePayload | StoreCreatedMessagePayload | StoreDeletedMessagePayload | StoreDistributionChannelsChangedMessagePayload | StoreLanguagesChangedMessagePayload | StoreNameSetMessagePayload | StoreProductSelectionsChangedMessagePayload;
|
|
1799
1799
|
export interface CategoryCreatedMessagePayload {
|
|
1800
1800
|
readonly type: 'CategoryCreated';
|
|
1801
1801
|
readonly category: Category;
|
|
@@ -1876,7 +1876,7 @@ export interface InventoryEntryQuantitySetMessagePayload {
|
|
|
1876
1876
|
readonly newAvailableQuantity: number;
|
|
1877
1877
|
readonly supplyChannel?: ChannelReference;
|
|
1878
1878
|
}
|
|
1879
|
-
export
|
|
1879
|
+
export type OrderMessagePayload = CustomLineItemStateTransitionMessagePayload | DeliveryAddedMessagePayload | DeliveryAddressSetMessagePayload | DeliveryItemsUpdatedMessagePayload | DeliveryRemovedMessagePayload | LineItemStateTransitionMessagePayload | OrderBillingAddressSetMessagePayload | OrderCreatedMessagePayload | OrderCustomLineItemAddedMessagePayload | OrderCustomLineItemDiscountSetMessagePayload | OrderCustomLineItemQuantityChangedMessagePayload | OrderCustomLineItemRemovedMessagePayload | OrderCustomerEmailSetMessagePayload | OrderCustomerGroupSetMessagePayload | OrderCustomerSetMessagePayload | OrderDeletedMessagePayload | OrderDiscountCodeAddedMessagePayload | OrderDiscountCodeRemovedMessagePayload | OrderDiscountCodeStateSetMessagePayload | OrderEditAppliedMessagePayload | OrderImportedMessagePayload | OrderLineItemAddedMessagePayload | OrderLineItemDiscountSetMessagePayload | OrderLineItemDistributionChannelSetMessagePayload | OrderLineItemRemovedMessagePayload | OrderPaymentStateChangedMessagePayload | OrderReturnShipmentStateChangedMessagePayload | OrderShipmentStateChangedMessagePayload | OrderShippingAddressSetMessagePayload | OrderShippingInfoSetMessagePayload | OrderShippingRateInputSetMessagePayload | OrderStateChangedMessagePayload | OrderStateTransitionMessagePayload | OrderStoreSetMessagePayload | ParcelAddedToDeliveryMessagePayload | ParcelItemsUpdatedMessagePayload | ParcelMeasurementsUpdatedMessagePayload | ParcelRemovedFromDeliveryMessagePayload | ParcelTrackingDataUpdatedMessagePayload | ReturnInfoAddedMessagePayload | ReturnInfoSetMessagePayload;
|
|
1880
1880
|
export interface CustomLineItemStateTransitionMessagePayload {
|
|
1881
1881
|
readonly type: 'CustomLineItemStateTransition';
|
|
1882
1882
|
readonly customLineItemId: string;
|
|
@@ -55,7 +55,7 @@ export interface OrderEditResourceIdentifier {
|
|
|
55
55
|
readonly id?: string;
|
|
56
56
|
readonly key?: string;
|
|
57
57
|
}
|
|
58
|
-
export
|
|
58
|
+
export type OrderEditResult = OrderEditApplied | OrderEditNotProcessed | OrderEditPreviewFailure | OrderEditPreviewSuccess;
|
|
59
59
|
export interface OrderEditApplied {
|
|
60
60
|
readonly type: 'Applied';
|
|
61
61
|
readonly appliedAt: string;
|
|
@@ -79,7 +79,7 @@ export interface OrderEditUpdate {
|
|
|
79
79
|
readonly actions: OrderEditUpdateAction[];
|
|
80
80
|
readonly dryRun?: boolean;
|
|
81
81
|
}
|
|
82
|
-
export
|
|
82
|
+
export type OrderEditUpdateAction = OrderEditAddStagedActionAction | OrderEditSetCommentAction | OrderEditSetCustomFieldAction | OrderEditSetCustomTypeAction | OrderEditSetKeyAction | OrderEditSetStagedActionsAction;
|
|
83
83
|
export interface OrderExcerpt {
|
|
84
84
|
readonly totalPrice: TypedMoney;
|
|
85
85
|
readonly taxedPrice?: TaxedPrice;
|
|
@@ -12,7 +12,7 @@ import { StateReference, StateResourceIdentifier } from './state';
|
|
|
12
12
|
import { StoreKeyReference, StoreResourceIdentifier } from './store';
|
|
13
13
|
import { TaxCategoryResourceIdentifier, TaxRate } from './tax-category';
|
|
14
14
|
import { CustomFields, CustomFieldsDraft, FieldContainer, TypeResourceIdentifier } from './type';
|
|
15
|
-
export
|
|
15
|
+
export type StagedOrderUpdateAction = StagedOrderAddCustomLineItemAction | StagedOrderAddDeliveryAction | StagedOrderAddDiscountCodeAction | StagedOrderAddItemShippingAddressAction | StagedOrderAddLineItemAction | StagedOrderAddParcelToDeliveryAction | StagedOrderAddPaymentAction | StagedOrderAddReturnInfoAction | StagedOrderAddShoppingListAction | StagedOrderChangeCustomLineItemMoneyAction | StagedOrderChangeCustomLineItemQuantityAction | StagedOrderChangeLineItemQuantityAction | StagedOrderChangeOrderStateAction | StagedOrderChangePaymentStateAction | StagedOrderChangeShipmentStateAction | StagedOrderChangeTaxCalculationModeAction | StagedOrderChangeTaxModeAction | StagedOrderChangeTaxRoundingModeAction | StagedOrderImportCustomLineItemStateAction | StagedOrderImportLineItemStateAction | StagedOrderRemoveCustomLineItemAction | StagedOrderRemoveDeliveryAction | StagedOrderRemoveDiscountCodeAction | StagedOrderRemoveItemShippingAddressAction | StagedOrderRemoveLineItemAction | StagedOrderRemoveParcelFromDeliveryAction | StagedOrderRemovePaymentAction | StagedOrderSetBillingAddressAction | StagedOrderSetBillingAddressCustomFieldAction | StagedOrderSetBillingAddressCustomTypeAction | StagedOrderSetCountryAction | StagedOrderSetCustomFieldAction | StagedOrderSetCustomLineItemCustomFieldAction | StagedOrderSetCustomLineItemCustomTypeAction | StagedOrderSetCustomLineItemShippingDetailsAction | StagedOrderSetCustomLineItemTaxAmountAction | StagedOrderSetCustomLineItemTaxRateAction | StagedOrderSetCustomShippingMethodAction | StagedOrderSetCustomTypeAction | StagedOrderSetCustomerEmailAction | StagedOrderSetCustomerGroupAction | StagedOrderSetCustomerIdAction | StagedOrderSetDeliveryAddressAction | StagedOrderSetDeliveryAddressCustomFieldAction | StagedOrderSetDeliveryAddressCustomTypeAction | StagedOrderSetDeliveryCustomFieldAction | StagedOrderSetDeliveryCustomTypeAction | StagedOrderSetDeliveryItemsAction | StagedOrderSetItemShippingAddressCustomFieldAction | StagedOrderSetItemShippingAddressCustomTypeAction | StagedOrderSetLineItemCustomFieldAction | StagedOrderSetLineItemCustomTypeAction | StagedOrderSetLineItemDistributionChannelAction | StagedOrderSetLineItemPriceAction | StagedOrderSetLineItemShippingDetailsAction | StagedOrderSetLineItemTaxAmountAction | StagedOrderSetLineItemTaxRateAction | StagedOrderSetLineItemTotalPriceAction | StagedOrderSetLocaleAction | StagedOrderSetOrderNumberAction | StagedOrderSetOrderTotalTaxAction | StagedOrderSetParcelCustomFieldAction | StagedOrderSetParcelCustomTypeAction | StagedOrderSetParcelItemsAction | StagedOrderSetParcelMeasurementsAction | StagedOrderSetParcelTrackingDataAction | StagedOrderSetReturnInfoAction | StagedOrderSetReturnItemCustomFieldAction | StagedOrderSetReturnItemCustomTypeAction | StagedOrderSetReturnPaymentStateAction | StagedOrderSetReturnShipmentStateAction | StagedOrderSetShippingAddressAction | StagedOrderSetShippingAddressAndCustomShippingMethodAction | StagedOrderSetShippingAddressAndShippingMethodAction | StagedOrderSetShippingAddressCustomFieldAction | StagedOrderSetShippingAddressCustomTypeAction | StagedOrderSetShippingMethodAction | StagedOrderSetShippingMethodTaxAmountAction | StagedOrderSetShippingMethodTaxRateAction | StagedOrderSetShippingRateInputAction | StagedOrderTransitionCustomLineItemStateAction | StagedOrderTransitionLineItemStateAction | StagedOrderTransitionStateAction | StagedOrderUpdateItemShippingAddressAction | StagedOrderUpdateSyncInfoAction;
|
|
16
16
|
export interface Hit {
|
|
17
17
|
readonly id: string;
|
|
18
18
|
readonly version: number;
|
|
@@ -182,12 +182,12 @@ export interface OrderSearchRequest {
|
|
|
182
182
|
readonly limit?: number;
|
|
183
183
|
readonly offset?: number;
|
|
184
184
|
}
|
|
185
|
-
export
|
|
185
|
+
export type OrderState = 'Cancelled' | 'Complete' | 'Confirmed' | 'Open';
|
|
186
186
|
export interface OrderUpdate {
|
|
187
187
|
readonly version: number;
|
|
188
188
|
readonly actions: OrderUpdateAction[];
|
|
189
189
|
}
|
|
190
|
-
export
|
|
190
|
+
export type OrderUpdateAction = OrderAddDeliveryAction | OrderAddItemShippingAddressAction | OrderAddParcelToDeliveryAction | OrderAddPaymentAction | OrderAddReturnInfoAction | OrderChangeOrderStateAction | OrderChangePaymentStateAction | OrderChangeShipmentStateAction | OrderImportCustomLineItemStateAction | OrderImportLineItemStateAction | OrderRemoveDeliveryAction | OrderRemoveItemShippingAddressAction | OrderRemoveParcelFromDeliveryAction | OrderRemovePaymentAction | OrderSetBillingAddressAction | OrderSetBillingAddressCustomFieldAction | OrderSetBillingAddressCustomTypeAction | OrderSetCustomFieldAction | OrderSetCustomLineItemCustomFieldAction | OrderSetCustomLineItemCustomTypeAction | OrderSetCustomLineItemShippingDetailsAction | OrderSetCustomTypeAction | OrderSetCustomerEmailAction | OrderSetCustomerIdAction | OrderSetDeliveryAddressAction | OrderSetDeliveryAddressCustomFieldAction | OrderSetDeliveryAddressCustomTypeAction | OrderSetDeliveryCustomFieldAction | OrderSetDeliveryCustomTypeAction | OrderSetDeliveryItemsAction | OrderSetItemShippingAddressCustomFieldAction | OrderSetItemShippingAddressCustomTypeAction | OrderSetLineItemCustomFieldAction | OrderSetLineItemCustomTypeAction | OrderSetLineItemShippingDetailsAction | OrderSetLocaleAction | OrderSetOrderNumberAction | OrderSetParcelCustomFieldAction | OrderSetParcelCustomTypeAction | OrderSetParcelItemsAction | OrderSetParcelMeasurementsAction | OrderSetParcelTrackingDataAction | OrderSetReturnInfoAction | OrderSetReturnItemCustomFieldAction | OrderSetReturnItemCustomTypeAction | OrderSetReturnPaymentStateAction | OrderSetReturnShipmentStateAction | OrderSetShippingAddressAction | OrderSetShippingAddressCustomFieldAction | OrderSetShippingAddressCustomTypeAction | OrderSetStoreAction | OrderTransitionCustomLineItemStateAction | OrderTransitionLineItemStateAction | OrderTransitionStateAction | OrderUpdateItemShippingAddressAction | OrderUpdateSyncInfoAction;
|
|
191
191
|
export interface Parcel {
|
|
192
192
|
readonly id: string;
|
|
193
193
|
readonly createdAt: string;
|
|
@@ -211,7 +211,7 @@ export interface ParcelMeasurements {
|
|
|
211
211
|
export interface PaymentInfo {
|
|
212
212
|
readonly payments: PaymentReference[];
|
|
213
213
|
}
|
|
214
|
-
export
|
|
214
|
+
export type PaymentState = 'BalanceDue' | 'CreditOwed' | 'Failed' | 'Paid' | 'Pending';
|
|
215
215
|
export interface ProductVariantImportDraft {
|
|
216
216
|
readonly id?: number;
|
|
217
217
|
readonly sku?: string;
|
|
@@ -229,7 +229,7 @@ export interface ReturnInfoDraft {
|
|
|
229
229
|
readonly returnTrackingId?: string;
|
|
230
230
|
readonly returnDate?: string;
|
|
231
231
|
}
|
|
232
|
-
export
|
|
232
|
+
export type ReturnItem = CustomLineItemReturnItem | LineItemReturnItem;
|
|
233
233
|
export interface CustomLineItemReturnItem {
|
|
234
234
|
readonly type: 'CustomLineItemReturnItem';
|
|
235
235
|
readonly id: string;
|
|
@@ -262,9 +262,9 @@ export interface ReturnItemDraft {
|
|
|
262
262
|
readonly shipmentState: ReturnShipmentState;
|
|
263
263
|
readonly custom?: CustomFieldsDraft;
|
|
264
264
|
}
|
|
265
|
-
export
|
|
266
|
-
export
|
|
267
|
-
export
|
|
265
|
+
export type ReturnPaymentState = 'Initial' | 'NonRefundable' | 'NotRefunded' | 'Refunded';
|
|
266
|
+
export type ReturnShipmentState = 'Advised' | 'BackInStock' | 'Returned' | 'Unusable';
|
|
267
|
+
export type ShipmentState = 'Backorder' | 'Delayed' | 'Partial' | 'Pending' | 'Ready' | 'Shipped';
|
|
268
268
|
export interface ShippingInfoImportDraft {
|
|
269
269
|
readonly shippingMethodName: string;
|
|
270
270
|
readonly price: Money;
|