@wix/auto_sdk_ecom_orders 1.0.53 → 1.0.54
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/build/{cjs/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-CO-UuLIK.d.mts} +640 -1079
- package/build/{es/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-CO-UuLIK.d.ts} +640 -1079
- package/build/index.d.mts +216 -0
- package/build/index.d.ts +216 -0
- package/build/index.js +3502 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +3399 -0
- package/build/index.mjs.map +1 -0
- package/build/internal/{cjs/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-DrkwwhMV.d.mts} +640 -1446
- package/build/internal/{es/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-DrkwwhMV.d.ts} +640 -1446
- package/build/internal/index.d.mts +395 -0
- package/build/internal/index.d.ts +395 -0
- package/build/internal/index.js +3502 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +3399 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/internal/meta.d.mts +3302 -0
- package/build/internal/meta.d.ts +3302 -0
- package/build/internal/meta.js +1941 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +1890 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/meta.d.mts +3302 -0
- package/build/meta.d.ts +3302 -0
- package/build/meta.js +1941 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +1890 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +12 -11
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -43
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-orders.context.d.ts +0 -34
- package/build/cjs/src/ecom-v1-order-orders.context.js +0 -117
- package/build/cjs/src/ecom-v1-order-orders.context.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-orders.http.d.ts +0 -200
- package/build/cjs/src/ecom-v1-order-orders.http.js +0 -1610
- package/build/cjs/src/ecom-v1-order-orders.http.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-orders.meta.d.ts +0 -78
- package/build/cjs/src/ecom-v1-order-orders.meta.js +0 -503
- package/build/cjs/src/ecom-v1-order-orders.meta.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-orders.public.d.ts +0 -190
- package/build/cjs/src/ecom-v1-order-orders.public.js +0 -382
- package/build/cjs/src/ecom-v1-order-orders.public.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-orders.types.d.ts +0 -6317
- package/build/cjs/src/ecom-v1-order-orders.types.js +0 -652
- package/build/cjs/src/ecom-v1-order-orders.types.js.map +0 -1
- package/build/cjs/src/ecom-v1-order-orders.universal.js +0 -2337
- package/build/cjs/src/ecom-v1-order-orders.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -43
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/ecom-v1-order-orders.context.d.ts +0 -34
- package/build/es/src/ecom-v1-order-orders.context.js +0 -62
- package/build/es/src/ecom-v1-order-orders.context.js.map +0 -1
- package/build/es/src/ecom-v1-order-orders.http.d.ts +0 -200
- package/build/es/src/ecom-v1-order-orders.http.js +0 -1582
- package/build/es/src/ecom-v1-order-orders.http.js.map +0 -1
- package/build/es/src/ecom-v1-order-orders.meta.d.ts +0 -78
- package/build/es/src/ecom-v1-order-orders.meta.js +0 -452
- package/build/es/src/ecom-v1-order-orders.meta.js.map +0 -1
- package/build/es/src/ecom-v1-order-orders.public.d.ts +0 -190
- package/build/es/src/ecom-v1-order-orders.public.js +0 -302
- package/build/es/src/ecom-v1-order-orders.public.js.map +0 -1
- package/build/es/src/ecom-v1-order-orders.types.d.ts +0 -6317
- package/build/es/src/ecom-v1-order-orders.types.js +0 -648
- package/build/es/src/ecom-v1-order-orders.types.js.map +0 -1
- package/build/es/src/ecom-v1-order-orders.universal.js +0 -2285
- package/build/es/src/ecom-v1-order-orders.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -43
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.context.d.ts +0 -62
- package/build/internal/cjs/src/ecom-v1-order-orders.context.js +0 -117
- package/build/internal/cjs/src/ecom-v1-order-orders.context.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.http.d.ts +0 -200
- package/build/internal/cjs/src/ecom-v1-order-orders.http.js +0 -1610
- package/build/internal/cjs/src/ecom-v1-order-orders.http.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.d.ts +0 -78
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.js +0 -503
- package/build/internal/cjs/src/ecom-v1-order-orders.meta.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.public.d.ts +0 -341
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js +0 -382
- package/build/internal/cjs/src/ecom-v1-order-orders.public.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.types.d.ts +0 -6317
- package/build/internal/cjs/src/ecom-v1-order-orders.types.js +0 -652
- package/build/internal/cjs/src/ecom-v1-order-orders.types.js.map +0 -1
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js +0 -2337
- package/build/internal/cjs/src/ecom-v1-order-orders.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -43
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-orders.context.d.ts +0 -62
- package/build/internal/es/src/ecom-v1-order-orders.context.js +0 -62
- package/build/internal/es/src/ecom-v1-order-orders.context.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-orders.http.d.ts +0 -200
- package/build/internal/es/src/ecom-v1-order-orders.http.js +0 -1582
- package/build/internal/es/src/ecom-v1-order-orders.http.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-orders.meta.d.ts +0 -78
- package/build/internal/es/src/ecom-v1-order-orders.meta.js +0 -452
- package/build/internal/es/src/ecom-v1-order-orders.meta.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-orders.public.d.ts +0 -341
- package/build/internal/es/src/ecom-v1-order-orders.public.js +0 -302
- package/build/internal/es/src/ecom-v1-order-orders.public.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-orders.types.d.ts +0 -6317
- package/build/internal/es/src/ecom-v1-order-orders.types.js +0 -648
- package/build/internal/es/src/ecom-v1-order-orders.types.js.map +0 -1
- package/build/internal/es/src/ecom-v1-order-orders.universal.js +0 -2285
- package/build/internal/es/src/ecom-v1-order-orders.universal.js.map +0 -1
package/build/meta.d.ts
ADDED
|
@@ -0,0 +1,3302 @@
|
|
|
1
|
+
import { cj as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, cn as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, co as RecordManuallyCollectedPaymentRequest$1, cp as RecordManuallyCollectedPaymentResponse$1, cq as MarkOrderAsPaidRequest$1, cr as MarkOrderAsPaidResponse$1, ct as BulkMarkOrdersAsPaidRequest$1, cu as BulkMarkOrdersAsPaidResponse$1, cz as GetRefundabilityStatusRequest$1, cA as GetRefundabilityStatusResponse$1, cD as CreatePaymentGatewayOrderRequest$1, cF as CreatePaymentGatewayOrderResponse$1, cG as ChargeMembershipsRequest$1, cK as ChargeMembershipsResponse$1, cL as TriggerRefundRequest$1, cV as TriggerRefundResponse$1, dk as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, dl as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, e_ as GetOrderRequest$1, e$ as GetOrderResponse$1, f3 as SearchOrdersRequest$1, S as SearchOrdersResponse$1, f7 as CreateOrderRequest$1, fa as CreateOrderResponse$1, fb as UpdateOrderRequest$1, fc as UpdateOrderResponse$1, fd as BulkUpdateOrdersRequest$1, f as BulkUpdateOrdersResponse$1, fe as CommitDeltasRequest$1, fu as CommitDeltasResponse$1, fV as UpdateOrderLineItemRequest$1, fW as UpdateOrderLineItemResponse$1, gl as AddActivityRequest$1, go as AddActivityResponse$1, gr as UpdateActivityRequest$1, gs as UpdateActivityResponse$1, gt as DeleteActivityRequest$1, gu as DeleteActivityResponse$1, gA as CancelOrderRequest$1, h as CancelOrderResponse$1, gC as UpdateOrderStatusRequest$1, gD as UpdateOrderStatusResponse$1, h0 as AggregateOrdersRequest$1, h1 as AggregateOrdersResponse$1, h5 as BulkUpdateOrderTagsRequest$1, j as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-CO-UuLIK.js';
|
|
2
|
+
import '@wix/sdk-types';
|
|
3
|
+
|
|
4
|
+
interface Order {
|
|
5
|
+
/**
|
|
6
|
+
* Order ID.
|
|
7
|
+
* @format GUID
|
|
8
|
+
* @readonly
|
|
9
|
+
*/
|
|
10
|
+
id?: string | null;
|
|
11
|
+
/**
|
|
12
|
+
* Order number displayed in the site owner's dashboard (auto-generated).
|
|
13
|
+
* @readonly
|
|
14
|
+
*/
|
|
15
|
+
number?: string;
|
|
16
|
+
/**
|
|
17
|
+
* Date and time the order was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
18
|
+
* @readonly
|
|
19
|
+
* @immutable
|
|
20
|
+
*/
|
|
21
|
+
createdDate?: Date | null;
|
|
22
|
+
/**
|
|
23
|
+
* Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
24
|
+
* @readonly
|
|
25
|
+
*/
|
|
26
|
+
updatedDate?: Date | null;
|
|
27
|
+
/**
|
|
28
|
+
* Order line items.
|
|
29
|
+
* @minSize 1
|
|
30
|
+
* @maxSize 300
|
|
31
|
+
* @readonly
|
|
32
|
+
*/
|
|
33
|
+
lineItems?: OrderLineItem[];
|
|
34
|
+
/** Buyer information. */
|
|
35
|
+
buyerInfo?: BuyerInfo;
|
|
36
|
+
/** Order payment status. */
|
|
37
|
+
paymentStatus?: PaymentStatusWithLiterals;
|
|
38
|
+
/**
|
|
39
|
+
* Order fulfillment status.
|
|
40
|
+
* @readonly
|
|
41
|
+
*/
|
|
42
|
+
fulfillmentStatus?: FulfillmentStatusWithLiterals;
|
|
43
|
+
/**
|
|
44
|
+
* Language for communication with the buyer. Defaults to the site language.
|
|
45
|
+
* For a site that supports multiple languages, this is the language the buyer selected.
|
|
46
|
+
*/
|
|
47
|
+
buyerLanguage?: string | null;
|
|
48
|
+
/** Weight measurement unit - defaults to site's weight unit. */
|
|
49
|
+
weightUnit?: WeightUnitWithLiterals;
|
|
50
|
+
/**
|
|
51
|
+
* Currency used for the pricing of this order in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
52
|
+
* @format CURRENCY
|
|
53
|
+
*/
|
|
54
|
+
currency?: string | null;
|
|
55
|
+
/** Currency conversion details. For use with multi-currency sites. */
|
|
56
|
+
currencyConversionDetails?: CurrencyConversionDetails;
|
|
57
|
+
/**
|
|
58
|
+
* Whether tax is included in line item prices.
|
|
59
|
+
* @immutable
|
|
60
|
+
*/
|
|
61
|
+
taxIncludedInPrices?: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* Site language in which original values are shown.
|
|
64
|
+
* @readonly
|
|
65
|
+
* @immutable
|
|
66
|
+
*/
|
|
67
|
+
siteLanguage?: string | null;
|
|
68
|
+
/**
|
|
69
|
+
* Order price summary.
|
|
70
|
+
* @readonly
|
|
71
|
+
*/
|
|
72
|
+
priceSummary?: PriceSummary;
|
|
73
|
+
/** Billing address and contact details. */
|
|
74
|
+
billingInfo?: AddressWithContact;
|
|
75
|
+
/** Shipping info and selected shipping option details. */
|
|
76
|
+
shippingInfo?: V1ShippingInformation;
|
|
77
|
+
/**
|
|
78
|
+
* [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
|
|
79
|
+
* @maxLength 1000
|
|
80
|
+
*/
|
|
81
|
+
buyerNote?: string | null;
|
|
82
|
+
/** Order status. */
|
|
83
|
+
status?: OrderStatusWithLiterals;
|
|
84
|
+
/** Whether order is archived. */
|
|
85
|
+
archived?: boolean | null;
|
|
86
|
+
/**
|
|
87
|
+
* Tax summary.
|
|
88
|
+
* Deprecated. Use `taxInfo` instead.
|
|
89
|
+
* This field will be removed on September 30, 2024.
|
|
90
|
+
* @deprecated Tax summary.
|
|
91
|
+
* Deprecated. Use `taxInfo` instead.
|
|
92
|
+
* This field will be removed on September 30, 2024.
|
|
93
|
+
* @replacedBy tax_info
|
|
94
|
+
* @targetRemovalDate 2024-09-30
|
|
95
|
+
*/
|
|
96
|
+
taxSummary?: TaxSummary;
|
|
97
|
+
/** Tax information. */
|
|
98
|
+
taxInfo?: OrderTaxInfo;
|
|
99
|
+
/**
|
|
100
|
+
* Applied discounts.
|
|
101
|
+
* @maxSize 320
|
|
102
|
+
*/
|
|
103
|
+
appliedDiscounts?: AppliedDiscount[];
|
|
104
|
+
/**
|
|
105
|
+
* Order activities.
|
|
106
|
+
* @readonly
|
|
107
|
+
* @maxSize 1000
|
|
108
|
+
*/
|
|
109
|
+
activities?: Activity[];
|
|
110
|
+
/** Order attribution source. */
|
|
111
|
+
attributionSource?: AttributionSourceWithLiterals;
|
|
112
|
+
/**
|
|
113
|
+
* ID of the order's initiator.
|
|
114
|
+
* @readonly
|
|
115
|
+
*/
|
|
116
|
+
createdBy?: CreatedBy;
|
|
117
|
+
/** Information about the sales channel that submitted this order. */
|
|
118
|
+
channelInfo?: ChannelInfo;
|
|
119
|
+
/** Whether a human has seen the order. Set when an order is clicked on in the dashboard. */
|
|
120
|
+
seenByAHuman?: boolean | null;
|
|
121
|
+
/**
|
|
122
|
+
* Checkout ID.
|
|
123
|
+
* @format GUID
|
|
124
|
+
*/
|
|
125
|
+
checkoutId?: string | null;
|
|
126
|
+
/** Custom fields. */
|
|
127
|
+
customFields?: CustomField[];
|
|
128
|
+
/**
|
|
129
|
+
* Balance summary.
|
|
130
|
+
* @readonly
|
|
131
|
+
*/
|
|
132
|
+
balanceSummary?: BalanceSummary;
|
|
133
|
+
/**
|
|
134
|
+
* Additional fees applied to the order.
|
|
135
|
+
* @maxSize 100
|
|
136
|
+
*/
|
|
137
|
+
additionalFees?: AdditionalFee[];
|
|
138
|
+
/**
|
|
139
|
+
* Custom field data for the order object.
|
|
140
|
+
*
|
|
141
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
142
|
+
*/
|
|
143
|
+
extendedFields?: ExtendedFields;
|
|
144
|
+
/**
|
|
145
|
+
* Persistent ID that correlates between the various eCommerce elements: cart, checkout, and order.
|
|
146
|
+
* @format GUID
|
|
147
|
+
*/
|
|
148
|
+
purchaseFlowId?: string | null;
|
|
149
|
+
/**
|
|
150
|
+
* Order recipient address and contact details.
|
|
151
|
+
*
|
|
152
|
+
* This field may differ from the address in `shippingInfo.logistics` when:
|
|
153
|
+
* + The chosen shipping option is pickup point or store pickup.
|
|
154
|
+
* + No shipping option is selected.
|
|
155
|
+
*/
|
|
156
|
+
recipientInfo?: AddressWithContact;
|
|
157
|
+
/**
|
|
158
|
+
* Order tags.
|
|
159
|
+
*
|
|
160
|
+
* [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
|
|
161
|
+
*/
|
|
162
|
+
tags?: Tags;
|
|
163
|
+
/**
|
|
164
|
+
* Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
165
|
+
* Used for migration from external systems.
|
|
166
|
+
* @immutable
|
|
167
|
+
*/
|
|
168
|
+
purchasedDate?: Date | null;
|
|
169
|
+
/** Order Location */
|
|
170
|
+
businessLocation?: Location;
|
|
171
|
+
/**
|
|
172
|
+
* Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
|
|
173
|
+
* @readonly
|
|
174
|
+
*/
|
|
175
|
+
payAfterFreeTrial?: PriceSummary;
|
|
176
|
+
}
|
|
177
|
+
interface OrderLineItem {
|
|
178
|
+
/**
|
|
179
|
+
* Line item ID.
|
|
180
|
+
* @immutable
|
|
181
|
+
*/
|
|
182
|
+
id?: string;
|
|
183
|
+
/**
|
|
184
|
+
* Item name.
|
|
185
|
+
* + Stores - `product.name`
|
|
186
|
+
* + Bookings - `service.info.name`
|
|
187
|
+
* + Events - `ticket.name`
|
|
188
|
+
*/
|
|
189
|
+
productName?: ProductName;
|
|
190
|
+
/**
|
|
191
|
+
* References to the line item's origin catalog.
|
|
192
|
+
* This field may be empty in the case of a custom line item.
|
|
193
|
+
*/
|
|
194
|
+
catalogReference?: CatalogReference;
|
|
195
|
+
/**
|
|
196
|
+
* Line item quantity.
|
|
197
|
+
* @min 1
|
|
198
|
+
* @max 100000
|
|
199
|
+
*/
|
|
200
|
+
quantity?: number;
|
|
201
|
+
/**
|
|
202
|
+
* Total discount for this line item's entire quantity.
|
|
203
|
+
* @readonly
|
|
204
|
+
*/
|
|
205
|
+
totalDiscount?: Price;
|
|
206
|
+
/**
|
|
207
|
+
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
208
|
+
* @maxSize 20
|
|
209
|
+
*/
|
|
210
|
+
descriptionLines?: DescriptionLine[];
|
|
211
|
+
/** Line item image. */
|
|
212
|
+
image?: Image;
|
|
213
|
+
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
214
|
+
physicalProperties?: PhysicalProperties;
|
|
215
|
+
/** Item type. Either a preset type or custom. */
|
|
216
|
+
itemType?: ItemType;
|
|
217
|
+
/**
|
|
218
|
+
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
219
|
+
* To get fulfillment information, pass the order ID to [List Fulfillments For Single Order](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
220
|
+
* @format GUID
|
|
221
|
+
*/
|
|
222
|
+
fulfillerId?: string | null;
|
|
223
|
+
/**
|
|
224
|
+
* Number of items that were refunded.
|
|
225
|
+
* @max 100000
|
|
226
|
+
*/
|
|
227
|
+
refundQuantity?: number | null;
|
|
228
|
+
/**
|
|
229
|
+
* Number of items restocked.
|
|
230
|
+
* @max 100000
|
|
231
|
+
*/
|
|
232
|
+
restockQuantity?: number | null;
|
|
233
|
+
/** Line item price after line item discounts for display purposes. */
|
|
234
|
+
price?: Price;
|
|
235
|
+
/**
|
|
236
|
+
* Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
|
|
237
|
+
* @readonly
|
|
238
|
+
*/
|
|
239
|
+
priceBeforeDiscounts?: Price;
|
|
240
|
+
/**
|
|
241
|
+
* Total price after discounts, and before tax.
|
|
242
|
+
* @readonly
|
|
243
|
+
*/
|
|
244
|
+
totalPriceBeforeTax?: Price;
|
|
245
|
+
/**
|
|
246
|
+
* Total price after all discounts and tax.
|
|
247
|
+
* @readonly
|
|
248
|
+
*/
|
|
249
|
+
totalPriceAfterTax?: Price;
|
|
250
|
+
/**
|
|
251
|
+
* Type of selected payment option for current item.
|
|
252
|
+
*
|
|
253
|
+
* Default: `FULL_PAYMENT_ONLINE`
|
|
254
|
+
*/
|
|
255
|
+
paymentOption?: PaymentOptionTypeWithLiterals;
|
|
256
|
+
/**
|
|
257
|
+
* Deprecated. Use `taxInfo` instead.
|
|
258
|
+
* This field will be removed on September 30, 2024.
|
|
259
|
+
* Tax details for this line item.
|
|
260
|
+
* @deprecated Deprecated. Use `taxInfo` instead.
|
|
261
|
+
* This field will be removed on September 30, 2024.
|
|
262
|
+
* Tax details for this line item.
|
|
263
|
+
* @replacedBy tax_info
|
|
264
|
+
* @targetRemovalDate 2024-09-30
|
|
265
|
+
*/
|
|
266
|
+
taxDetails?: ItemTaxFullDetails;
|
|
267
|
+
/** Represents all the relevant tax details for a specific line item. */
|
|
268
|
+
taxInfo?: LineItemTaxInfo;
|
|
269
|
+
/** Digital file identifier, relevant only for items with type DIGITAL. */
|
|
270
|
+
digitalFile?: DigitalFile;
|
|
271
|
+
/** Subscription info. */
|
|
272
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
273
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
274
|
+
priceDescription?: PriceDescription;
|
|
275
|
+
/**
|
|
276
|
+
* Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
|
|
277
|
+
* @readonly
|
|
278
|
+
*/
|
|
279
|
+
depositAmount?: Price;
|
|
280
|
+
/**
|
|
281
|
+
* Line item locations.
|
|
282
|
+
*
|
|
283
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
284
|
+
* @maxSize 5
|
|
285
|
+
*/
|
|
286
|
+
locations?: LocationAndQuantity[];
|
|
287
|
+
/** Address used for tax calculation. */
|
|
288
|
+
taxableAddress?: TaxableAddress;
|
|
289
|
+
/**
|
|
290
|
+
* Custom extended fields for the line item object.
|
|
291
|
+
*
|
|
292
|
+
* [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields) must be configured in the app dashboard before they can be accessed with API calls.
|
|
293
|
+
*/
|
|
294
|
+
extendedFields?: ExtendedFields;
|
|
295
|
+
}
|
|
296
|
+
interface ProductName {
|
|
297
|
+
/**
|
|
298
|
+
* __Required.__ Item name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
299
|
+
*
|
|
300
|
+
* Min: 1 character.
|
|
301
|
+
* Max: 200 characters.
|
|
302
|
+
* @minLength 1
|
|
303
|
+
* @maxLength 200
|
|
304
|
+
*/
|
|
305
|
+
original?: string;
|
|
306
|
+
/**
|
|
307
|
+
* Item name translated into the buyer's language.
|
|
308
|
+
*
|
|
309
|
+
* Min: 1 character.
|
|
310
|
+
* Max: 400 characters.
|
|
311
|
+
* Default: Same as `original`.
|
|
312
|
+
* @minLength 1
|
|
313
|
+
* @maxLength 400
|
|
314
|
+
*/
|
|
315
|
+
translated?: string | null;
|
|
316
|
+
}
|
|
317
|
+
/** Used for grouping line items. Sent when an item is added to a cart, checkout, or order. */
|
|
318
|
+
interface CatalogReference {
|
|
319
|
+
/**
|
|
320
|
+
* ID of the item within the catalog it belongs to.
|
|
321
|
+
* @minLength 1
|
|
322
|
+
* @maxLength 36
|
|
323
|
+
*/
|
|
324
|
+
catalogItemId?: string;
|
|
325
|
+
/**
|
|
326
|
+
* ID of the app providing the catalog.
|
|
327
|
+
*
|
|
328
|
+
* You can get your app's ID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/).
|
|
329
|
+
*
|
|
330
|
+
* For items from Wix catalogs, the following values always apply:
|
|
331
|
+
* + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"`
|
|
332
|
+
* + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"`
|
|
333
|
+
* + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
|
|
334
|
+
* @minLength 1
|
|
335
|
+
*/
|
|
336
|
+
appId?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Additional item details in key:value pairs. Use this optional field to provide more specificity with item selection. The `options` field values differ depending on which catalog is providing the items.
|
|
339
|
+
*
|
|
340
|
+
* For products and variants from a Wix Stores catalog, learn more about eCommerce integration ([SDK](https://dev.wix.com/docs/sdk/backend-modules/stores/catalog-v3/e-commerce-integration) | [REST](https://dev.wix.com/docs/rest/business-solutions/stores/catalog/e-commerce-integration)).
|
|
341
|
+
*/
|
|
342
|
+
options?: Record<string, any> | null;
|
|
343
|
+
}
|
|
344
|
+
interface Price {
|
|
345
|
+
/**
|
|
346
|
+
* Amount.
|
|
347
|
+
* @decimalValue options { gte:0, lte:1000000000000000 }
|
|
348
|
+
*/
|
|
349
|
+
amount?: string;
|
|
350
|
+
/**
|
|
351
|
+
* Amount formatted with currency symbol.
|
|
352
|
+
* @readonly
|
|
353
|
+
*/
|
|
354
|
+
formattedAmount?: string;
|
|
355
|
+
}
|
|
356
|
+
interface DescriptionLine extends DescriptionLineValueOneOf, DescriptionLineDescriptionLineValueOneOf {
|
|
357
|
+
/** Description line plain text value. */
|
|
358
|
+
plainText?: PlainTextValue;
|
|
359
|
+
/** Description line color value. */
|
|
360
|
+
colorInfo?: Color;
|
|
361
|
+
/** Description line name. */
|
|
362
|
+
name?: DescriptionLineName;
|
|
363
|
+
}
|
|
364
|
+
/** @oneof */
|
|
365
|
+
interface DescriptionLineValueOneOf {
|
|
366
|
+
/** Description line plain text value. */
|
|
367
|
+
plainText?: PlainTextValue;
|
|
368
|
+
/** Description line color value. */
|
|
369
|
+
colorInfo?: Color;
|
|
370
|
+
}
|
|
371
|
+
/** @oneof */
|
|
372
|
+
interface DescriptionLineDescriptionLineValueOneOf {
|
|
373
|
+
}
|
|
374
|
+
interface DescriptionLineName {
|
|
375
|
+
/**
|
|
376
|
+
* Description line name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
377
|
+
* @maxLength 100
|
|
378
|
+
*/
|
|
379
|
+
original?: string;
|
|
380
|
+
/**
|
|
381
|
+
* Description line name translated into the buyer's language.
|
|
382
|
+
*
|
|
383
|
+
* Default: Same as `original`.
|
|
384
|
+
* @maxLength 200
|
|
385
|
+
*/
|
|
386
|
+
translated?: string | null;
|
|
387
|
+
}
|
|
388
|
+
interface PlainTextValue {
|
|
389
|
+
/**
|
|
390
|
+
* Description line plain text value in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
391
|
+
* @maxLength 600
|
|
392
|
+
*/
|
|
393
|
+
original?: string;
|
|
394
|
+
/**
|
|
395
|
+
* Description line plain text value translated into the buyer's language.
|
|
396
|
+
*
|
|
397
|
+
* Default: Same as `original`.
|
|
398
|
+
* @maxLength 600
|
|
399
|
+
*/
|
|
400
|
+
translated?: string | null;
|
|
401
|
+
}
|
|
402
|
+
interface Color {
|
|
403
|
+
/**
|
|
404
|
+
* Description line color name in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
405
|
+
* @maxLength 500
|
|
406
|
+
*/
|
|
407
|
+
original?: string;
|
|
408
|
+
/**
|
|
409
|
+
* Description line color name translated into the buyer's language.
|
|
410
|
+
*
|
|
411
|
+
* Default: Same as `original`.
|
|
412
|
+
* @maxLength 500
|
|
413
|
+
*/
|
|
414
|
+
translated?: string | null;
|
|
415
|
+
/** HEX or RGB color code for display. */
|
|
416
|
+
code?: string | null;
|
|
417
|
+
}
|
|
418
|
+
interface Image {
|
|
419
|
+
/** WixMedia image ID. */
|
|
420
|
+
id?: string;
|
|
421
|
+
/** Image URL. */
|
|
422
|
+
url?: string;
|
|
423
|
+
/**
|
|
424
|
+
* Original image height.
|
|
425
|
+
* @readonly
|
|
426
|
+
*/
|
|
427
|
+
height?: number;
|
|
428
|
+
/**
|
|
429
|
+
* Original image width.
|
|
430
|
+
* @readonly
|
|
431
|
+
*/
|
|
432
|
+
width?: number;
|
|
433
|
+
/** Image alt text. */
|
|
434
|
+
altText?: string | null;
|
|
435
|
+
/**
|
|
436
|
+
* Image filename.
|
|
437
|
+
* @readonly
|
|
438
|
+
*/
|
|
439
|
+
filename?: string | null;
|
|
440
|
+
}
|
|
441
|
+
interface PhysicalProperties {
|
|
442
|
+
/** Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request. */
|
|
443
|
+
weight?: number | null;
|
|
444
|
+
/**
|
|
445
|
+
* Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
|
|
446
|
+
* @maxLength 40
|
|
447
|
+
*/
|
|
448
|
+
sku?: string | null;
|
|
449
|
+
/** Whether this line item is shippable. */
|
|
450
|
+
shippable?: boolean;
|
|
451
|
+
}
|
|
452
|
+
interface ItemType extends ItemTypeItemTypeDataOneOf {
|
|
453
|
+
/** Preset item type. */
|
|
454
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
455
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
456
|
+
custom?: string;
|
|
457
|
+
}
|
|
458
|
+
/** @oneof */
|
|
459
|
+
interface ItemTypeItemTypeDataOneOf {
|
|
460
|
+
/** Preset item type. */
|
|
461
|
+
preset?: ItemTypeItemTypeWithLiterals;
|
|
462
|
+
/** Custom item type. When none of the preset types are suitable, specifies the custom type. */
|
|
463
|
+
custom?: string;
|
|
464
|
+
}
|
|
465
|
+
declare enum ItemTypeItemType {
|
|
466
|
+
UNRECOGNISED = "UNRECOGNISED",
|
|
467
|
+
PHYSICAL = "PHYSICAL",
|
|
468
|
+
DIGITAL = "DIGITAL",
|
|
469
|
+
GIFT_CARD = "GIFT_CARD",
|
|
470
|
+
SERVICE = "SERVICE"
|
|
471
|
+
}
|
|
472
|
+
/** @enumType */
|
|
473
|
+
type ItemTypeItemTypeWithLiterals = ItemTypeItemType | 'UNRECOGNISED' | 'PHYSICAL' | 'DIGITAL' | 'GIFT_CARD' | 'SERVICE';
|
|
474
|
+
/** Type of selected payment option for catalog item */
|
|
475
|
+
declare enum PaymentOptionType {
|
|
476
|
+
/** The entire payment for this item happens as part of the checkout. */
|
|
477
|
+
FULL_PAYMENT_ONLINE = "FULL_PAYMENT_ONLINE",
|
|
478
|
+
/** The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods. */
|
|
479
|
+
FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
|
|
480
|
+
/** Payment for this item is done by charging a membership. When selected, `price` is `0`. */
|
|
481
|
+
MEMBERSHIP = "MEMBERSHIP",
|
|
482
|
+
/** Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`. */
|
|
483
|
+
DEPOSIT_ONLINE = "DEPOSIT_ONLINE",
|
|
484
|
+
/** Payment for this item can only be done by charging a membership and must be manually redeemed in the dashboard by the site admin. When selected, `price` is `0`. */
|
|
485
|
+
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
486
|
+
}
|
|
487
|
+
/** @enumType */
|
|
488
|
+
type PaymentOptionTypeWithLiterals = PaymentOptionType | 'FULL_PAYMENT_ONLINE' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP' | 'DEPOSIT_ONLINE' | 'MEMBERSHIP_OFFLINE';
|
|
489
|
+
interface ItemTaxFullDetails {
|
|
490
|
+
/** Taxable amount of this line item. */
|
|
491
|
+
taxableAmount?: Price;
|
|
492
|
+
/**
|
|
493
|
+
* Tax rate percentage, as a decimal numeral between 0 and 1. For example, `"0.13"`.
|
|
494
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
495
|
+
*/
|
|
496
|
+
taxRate?: string;
|
|
497
|
+
/** The calculated tax, based on the `taxableAmount` and `taxRate`. */
|
|
498
|
+
totalTax?: Price;
|
|
499
|
+
}
|
|
500
|
+
interface LineItemTaxInfo {
|
|
501
|
+
/** Calculated tax, based on `taxable_amount` and `tax_rate`. */
|
|
502
|
+
taxAmount?: Price;
|
|
503
|
+
/** Amount for which tax is calculated. */
|
|
504
|
+
taxableAmount?: Price;
|
|
505
|
+
/**
|
|
506
|
+
* Tax rate %, as a decimal point.
|
|
507
|
+
* @format DECIMAL_VALUE
|
|
508
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
509
|
+
*/
|
|
510
|
+
taxRate?: string | null;
|
|
511
|
+
/**
|
|
512
|
+
* Tax group ID.
|
|
513
|
+
* @format GUID
|
|
514
|
+
*/
|
|
515
|
+
taxGroupId?: string | null;
|
|
516
|
+
/** Indicates whether the price already includes tax. */
|
|
517
|
+
taxIncludedInPrice?: boolean;
|
|
518
|
+
/**
|
|
519
|
+
* Tax information for a line item.
|
|
520
|
+
* @maxSize 7
|
|
521
|
+
*/
|
|
522
|
+
taxBreakdown?: LineItemTaxBreakdown[];
|
|
523
|
+
}
|
|
524
|
+
/**
|
|
525
|
+
* TaxBreakdown represents tax information for a line item.
|
|
526
|
+
* It holds the tax amount and the tax rate for each tax authority that apply on the line item.
|
|
527
|
+
*/
|
|
528
|
+
interface LineItemTaxBreakdown {
|
|
529
|
+
/**
|
|
530
|
+
* Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
|
|
531
|
+
* @maxLength 200
|
|
532
|
+
*/
|
|
533
|
+
jurisdiction?: string | null;
|
|
534
|
+
/**
|
|
535
|
+
* Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
|
|
536
|
+
* @format DECIMAL_VALUE
|
|
537
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
538
|
+
*/
|
|
539
|
+
rate?: string | null;
|
|
540
|
+
/** Amount of tax calculated for this line item. */
|
|
541
|
+
taxAmount?: Price;
|
|
542
|
+
/**
|
|
543
|
+
* The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
|
|
544
|
+
* @maxLength 200
|
|
545
|
+
*/
|
|
546
|
+
taxType?: string | null;
|
|
547
|
+
/**
|
|
548
|
+
* The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc.
|
|
549
|
+
* This name should be explicit enough to allow the merchant to understand what tax was calculated.
|
|
550
|
+
* @maxLength 200
|
|
551
|
+
*/
|
|
552
|
+
taxName?: string | null;
|
|
553
|
+
/** Type of jurisdiction that taxes were calculated for. */
|
|
554
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
555
|
+
/** Non-taxable amount of the line item price. */
|
|
556
|
+
nonTaxableAmount?: Price;
|
|
557
|
+
/** Taxable amount of the line item price. */
|
|
558
|
+
taxableAmount?: Price;
|
|
559
|
+
}
|
|
560
|
+
/** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
561
|
+
declare enum JurisdictionType {
|
|
562
|
+
UNDEFINED = "UNDEFINED",
|
|
563
|
+
COUNTRY = "COUNTRY",
|
|
564
|
+
STATE = "STATE",
|
|
565
|
+
COUNTY = "COUNTY",
|
|
566
|
+
CITY = "CITY",
|
|
567
|
+
SPECIAL = "SPECIAL"
|
|
568
|
+
}
|
|
569
|
+
/** @enumType */
|
|
570
|
+
type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
|
|
571
|
+
interface DigitalFile {
|
|
572
|
+
/**
|
|
573
|
+
* ID of the secure file in media.
|
|
574
|
+
* @minLength 1
|
|
575
|
+
* @maxLength 100
|
|
576
|
+
*/
|
|
577
|
+
fileId?: string;
|
|
578
|
+
/**
|
|
579
|
+
* Link will exist after the digital links have been generated on the order.
|
|
580
|
+
* @format WEB_URL
|
|
581
|
+
* @minLength 1
|
|
582
|
+
* @maxLength 2000
|
|
583
|
+
*/
|
|
584
|
+
link?: string | null;
|
|
585
|
+
/**
|
|
586
|
+
* Link expiration time and date.
|
|
587
|
+
* @readonly
|
|
588
|
+
*/
|
|
589
|
+
expirationDate?: Date | null;
|
|
590
|
+
}
|
|
591
|
+
interface SubscriptionInfo {
|
|
592
|
+
/**
|
|
593
|
+
* Subscription ID.
|
|
594
|
+
* @format GUID
|
|
595
|
+
*/
|
|
596
|
+
id?: string | null;
|
|
597
|
+
/**
|
|
598
|
+
* Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
|
|
599
|
+
* @min 1
|
|
600
|
+
*/
|
|
601
|
+
cycleNumber?: number;
|
|
602
|
+
/**
|
|
603
|
+
* Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
604
|
+
* @maxLength 20
|
|
605
|
+
* @deprecated Subscription option title. For example, `"Monthly coffee Subscription"`.
|
|
606
|
+
* @replacedBy title
|
|
607
|
+
* @targetRemovalDate 2025-10-01
|
|
608
|
+
*/
|
|
609
|
+
subscriptionOptionTitle?: string;
|
|
610
|
+
/**
|
|
611
|
+
* Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
612
|
+
* @maxLength 60
|
|
613
|
+
* @deprecated Subscription option description. For example, `"1kg of selected coffee, once a month"`.
|
|
614
|
+
* @replacedBy description
|
|
615
|
+
* @targetRemovalDate 2025-10-01
|
|
616
|
+
*/
|
|
617
|
+
subscriptionOptionDescription?: string | null;
|
|
618
|
+
/**
|
|
619
|
+
* Subscription detailed information.
|
|
620
|
+
* @immutable
|
|
621
|
+
*/
|
|
622
|
+
subscriptionSettings?: SubscriptionSettings;
|
|
623
|
+
/**
|
|
624
|
+
* Description of the charges that will be applied for subscription.
|
|
625
|
+
* @maxLength 1000
|
|
626
|
+
*/
|
|
627
|
+
chargesDescription?: string | null;
|
|
628
|
+
}
|
|
629
|
+
interface SubscriptionSettings {
|
|
630
|
+
/** Frequency of recurring payment. */
|
|
631
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
632
|
+
/**
|
|
633
|
+
* Interval of recurring payment.
|
|
634
|
+
* @min 1
|
|
635
|
+
* @max 50
|
|
636
|
+
*/
|
|
637
|
+
interval?: number | null;
|
|
638
|
+
/** Whether subscription is renewed automatically at the end of each period. */
|
|
639
|
+
autoRenewal?: boolean;
|
|
640
|
+
/**
|
|
641
|
+
* Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
|
|
642
|
+
* @min 1
|
|
643
|
+
*/
|
|
644
|
+
billingCycles?: number | null;
|
|
645
|
+
/** Whether to allow the customer to cancel the subscription. */
|
|
646
|
+
enableCustomerCancellation?: boolean;
|
|
647
|
+
/** Period until first cycle starts. If None => no free trial */
|
|
648
|
+
freeTrialPeriod?: FreeTrialPeriod;
|
|
649
|
+
}
|
|
650
|
+
/** Frequency unit of recurring payment */
|
|
651
|
+
declare enum SubscriptionFrequency {
|
|
652
|
+
UNDEFINED = "UNDEFINED",
|
|
653
|
+
DAY = "DAY",
|
|
654
|
+
WEEK = "WEEK",
|
|
655
|
+
MONTH = "MONTH",
|
|
656
|
+
YEAR = "YEAR"
|
|
657
|
+
}
|
|
658
|
+
/** @enumType */
|
|
659
|
+
type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
|
|
660
|
+
interface FreeTrialPeriod {
|
|
661
|
+
/** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
|
|
662
|
+
frequency?: SubscriptionFrequencyWithLiterals;
|
|
663
|
+
/**
|
|
664
|
+
* interval of period
|
|
665
|
+
* @min 1
|
|
666
|
+
* @max 999
|
|
667
|
+
*/
|
|
668
|
+
interval?: number;
|
|
669
|
+
}
|
|
670
|
+
interface PriceDescription {
|
|
671
|
+
/**
|
|
672
|
+
* __Required.__ Price description in the site's default language as defined in the [request envelope](https://dev.wix.com/docs/build-apps/develop-your-app/frameworks/self-hosting/supported-extensions/backend-extensions/add-self-hosted-service-plugin-extensions#request-envelope).
|
|
673
|
+
* @minLength 1
|
|
674
|
+
* @maxLength 100
|
|
675
|
+
*/
|
|
676
|
+
original?: string;
|
|
677
|
+
/**
|
|
678
|
+
* Price description translated into the buyer's language.
|
|
679
|
+
*
|
|
680
|
+
* Default: Same as `original`.
|
|
681
|
+
* @minLength 1
|
|
682
|
+
* @maxLength 100
|
|
683
|
+
*/
|
|
684
|
+
translated?: string | null;
|
|
685
|
+
}
|
|
686
|
+
interface LocationAndQuantity {
|
|
687
|
+
/**
|
|
688
|
+
* Location id in the associated owner app.
|
|
689
|
+
* @format GUID
|
|
690
|
+
*/
|
|
691
|
+
id?: string;
|
|
692
|
+
/**
|
|
693
|
+
* Location owner app, if not provided then the site business info locations will be used.
|
|
694
|
+
* @format GUID
|
|
695
|
+
* @deprecated Location owner app, if not provided then the site business info locations will be used.
|
|
696
|
+
* @targetRemovalDate 2025-03-01
|
|
697
|
+
*/
|
|
698
|
+
appId?: string | null;
|
|
699
|
+
/**
|
|
700
|
+
* Quantity for specific location.
|
|
701
|
+
* @min 1
|
|
702
|
+
* @max 100000
|
|
703
|
+
*/
|
|
704
|
+
quantity?: number;
|
|
705
|
+
/**
|
|
706
|
+
* Location name.
|
|
707
|
+
* @maxLength 500
|
|
708
|
+
* @readonly
|
|
709
|
+
*/
|
|
710
|
+
name?: string | null;
|
|
711
|
+
}
|
|
712
|
+
interface TaxableAddress extends TaxableAddressTaxableAddressDataOneOf {
|
|
713
|
+
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
714
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
715
|
+
}
|
|
716
|
+
/** @oneof */
|
|
717
|
+
interface TaxableAddressTaxableAddressDataOneOf {
|
|
718
|
+
/** taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly. */
|
|
719
|
+
addressType?: TaxableAddressTypeWithLiterals;
|
|
720
|
+
}
|
|
721
|
+
declare enum TaxableAddressType {
|
|
722
|
+
UNKNOWN_TAXABLE_ADDRESS = "UNKNOWN_TAXABLE_ADDRESS",
|
|
723
|
+
BUSINESS = "BUSINESS",
|
|
724
|
+
BILLING = "BILLING",
|
|
725
|
+
SHIPPING = "SHIPPING"
|
|
726
|
+
}
|
|
727
|
+
/** @enumType */
|
|
728
|
+
type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS' | 'BUSINESS' | 'BILLING' | 'SHIPPING';
|
|
729
|
+
interface ExtendedFields {
|
|
730
|
+
/**
|
|
731
|
+
* Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
|
|
732
|
+
* The value of each key is structured according to the schema defined when the extended fields were configured.
|
|
733
|
+
*
|
|
734
|
+
* You can only access fields for which you have the appropriate permissions.
|
|
735
|
+
*
|
|
736
|
+
* Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
|
|
737
|
+
*/
|
|
738
|
+
namespaces?: Record<string, Record<string, any>>;
|
|
739
|
+
}
|
|
740
|
+
/** Buyer Info */
|
|
741
|
+
interface BuyerInfo extends BuyerInfoIdOneOf {
|
|
742
|
+
/**
|
|
743
|
+
* Visitor ID (if site visitor is not a member).
|
|
744
|
+
* @format GUID
|
|
745
|
+
*/
|
|
746
|
+
visitorId?: string;
|
|
747
|
+
/**
|
|
748
|
+
* Member ID (if site visitor is a site member).
|
|
749
|
+
* @format GUID
|
|
750
|
+
*/
|
|
751
|
+
memberId?: string;
|
|
752
|
+
/**
|
|
753
|
+
* Contact ID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://dev.wix.com/api/rest/contacts/contacts/introduction).
|
|
754
|
+
* @format GUID
|
|
755
|
+
*/
|
|
756
|
+
contactId?: string | null;
|
|
757
|
+
/**
|
|
758
|
+
* Buyer email address.
|
|
759
|
+
* @format EMAIL
|
|
760
|
+
*/
|
|
761
|
+
email?: string | null;
|
|
762
|
+
}
|
|
763
|
+
/** @oneof */
|
|
764
|
+
interface BuyerInfoIdOneOf {
|
|
765
|
+
/**
|
|
766
|
+
* Visitor ID (if site visitor is not a member).
|
|
767
|
+
* @format GUID
|
|
768
|
+
*/
|
|
769
|
+
visitorId?: string;
|
|
770
|
+
/**
|
|
771
|
+
* Member ID (if site visitor is a site member).
|
|
772
|
+
* @format GUID
|
|
773
|
+
*/
|
|
774
|
+
memberId?: string;
|
|
775
|
+
}
|
|
776
|
+
declare enum PaymentStatus {
|
|
777
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
778
|
+
/**
|
|
779
|
+
* `NOT_PAID` can apply to an order made online, but not yet paid. In such cases `order.status` will be `INITIALIZED`.
|
|
780
|
+
* This status also applies when an offline order needs to be manually marked as paid. In such cases `order.status` will be `APPROVED`.
|
|
781
|
+
*/
|
|
782
|
+
NOT_PAID = "NOT_PAID",
|
|
783
|
+
/** All required payments associated with this order are paid. */
|
|
784
|
+
PAID = "PAID",
|
|
785
|
+
/** Order partially refunded, but the refunded amount is less than the order's total price. See `order.balanceSummary` for more details. */
|
|
786
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
787
|
+
/** Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details. */
|
|
788
|
+
FULLY_REFUNDED = "FULLY_REFUNDED",
|
|
789
|
+
/**
|
|
790
|
+
* All payments pending.
|
|
791
|
+
*
|
|
792
|
+
* This can happen with two-step payments, when a payment requires manual review, or when a payment is in progress and will be concluded shortly.
|
|
793
|
+
* Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
|
|
794
|
+
*/
|
|
795
|
+
PENDING = "PENDING",
|
|
796
|
+
/** At least one payment received and approved, but it covers less than the order's total price. See `order.balanceSummary` for more details. */
|
|
797
|
+
PARTIALLY_PAID = "PARTIALLY_PAID",
|
|
798
|
+
/**
|
|
799
|
+
* Payment received, but not yet confirmed by the payment provider.
|
|
800
|
+
*
|
|
801
|
+
* In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner.
|
|
802
|
+
* To solve this, the merchant/site owner should log in to the payment provider's dashboard and make sure their account is set up correctly, or contact their support for further assistance.
|
|
803
|
+
* @documentationMaturity preview
|
|
804
|
+
*/
|
|
805
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
806
|
+
/**
|
|
807
|
+
* One or more payments canceled.
|
|
808
|
+
* @documentationMaturity preview
|
|
809
|
+
*/
|
|
810
|
+
CANCELED = "CANCELED",
|
|
811
|
+
/**
|
|
812
|
+
* One or more payments declined.
|
|
813
|
+
* @documentationMaturity preview
|
|
814
|
+
*/
|
|
815
|
+
DECLINED = "DECLINED"
|
|
816
|
+
}
|
|
817
|
+
/** @enumType */
|
|
818
|
+
type PaymentStatusWithLiterals = PaymentStatus | 'UNSPECIFIED' | 'NOT_PAID' | 'PAID' | 'PARTIALLY_REFUNDED' | 'FULLY_REFUNDED' | 'PENDING' | 'PARTIALLY_PAID' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED';
|
|
819
|
+
declare enum FulfillmentStatus {
|
|
820
|
+
/** None of the order items are fulfilled or the order was manually marked as unfulfilled. */
|
|
821
|
+
NOT_FULFILLED = "NOT_FULFILLED",
|
|
822
|
+
/**
|
|
823
|
+
* All of the order items are fulfilled or the order was manually marked as fulfilled.
|
|
824
|
+
* Orders without shipping info are fulfilled automatically.
|
|
825
|
+
*/
|
|
826
|
+
FULFILLED = "FULFILLED",
|
|
827
|
+
/** Some, but not all, of the order items are fulfilled. */
|
|
828
|
+
PARTIALLY_FULFILLED = "PARTIALLY_FULFILLED"
|
|
829
|
+
}
|
|
830
|
+
/** @enumType */
|
|
831
|
+
type FulfillmentStatusWithLiterals = FulfillmentStatus | 'NOT_FULFILLED' | 'FULFILLED' | 'PARTIALLY_FULFILLED';
|
|
832
|
+
declare enum WeightUnit {
|
|
833
|
+
/** Weight unit can't be classified due to an error. */
|
|
834
|
+
UNSPECIFIED_WEIGHT_UNIT = "UNSPECIFIED_WEIGHT_UNIT",
|
|
835
|
+
/** Kilograms. */
|
|
836
|
+
KG = "KG",
|
|
837
|
+
/** Pounds. */
|
|
838
|
+
LB = "LB"
|
|
839
|
+
}
|
|
840
|
+
/** @enumType */
|
|
841
|
+
type WeightUnitWithLiterals = WeightUnit | 'UNSPECIFIED_WEIGHT_UNIT' | 'KG' | 'LB';
|
|
842
|
+
interface CurrencyConversionDetails {
|
|
843
|
+
/**
|
|
844
|
+
* Currency used for the pricing of this order, in [ISO-4217](https://en.wikipedia.org/wiki/ISO_4217#List_of_ISO_4217_currency_codes) format.
|
|
845
|
+
*
|
|
846
|
+
* This currency is used to calculate the pricing before conversion to the buyer's payment currency.
|
|
847
|
+
* @readonly
|
|
848
|
+
* @immutable
|
|
849
|
+
* @format CURRENCY
|
|
850
|
+
*/
|
|
851
|
+
originalCurrency?: string | null;
|
|
852
|
+
/**
|
|
853
|
+
* The rate used for converting the original currency to the currency used for payment.
|
|
854
|
+
* @readonly
|
|
855
|
+
* @immutable
|
|
856
|
+
* @decimalValue options { gt:0, lte:1000000000000000 }
|
|
857
|
+
*/
|
|
858
|
+
conversionRate?: string | null;
|
|
859
|
+
}
|
|
860
|
+
interface PriceSummary {
|
|
861
|
+
/** Subtotal of all the line items, before discounts and before tax. */
|
|
862
|
+
subtotal?: Price;
|
|
863
|
+
/** Total shipping price, before discounts and before tax. */
|
|
864
|
+
shipping?: Price;
|
|
865
|
+
/** Total tax on this order. */
|
|
866
|
+
tax?: Price;
|
|
867
|
+
/** Total calculated discount value. */
|
|
868
|
+
discount?: Price;
|
|
869
|
+
/** Order’s total price after discounts and tax. */
|
|
870
|
+
total?: Price;
|
|
871
|
+
/** Total price of additional fees before tax. */
|
|
872
|
+
totalAdditionalFees?: Price;
|
|
873
|
+
}
|
|
874
|
+
/** Billing Info and shipping details */
|
|
875
|
+
interface AddressWithContact {
|
|
876
|
+
/** Address. */
|
|
877
|
+
address?: Address;
|
|
878
|
+
/** Contact details. */
|
|
879
|
+
contactDetails?: FullAddressContactDetails;
|
|
880
|
+
}
|
|
881
|
+
/** Physical address */
|
|
882
|
+
interface Address {
|
|
883
|
+
/**
|
|
884
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
885
|
+
* @format COUNTRY
|
|
886
|
+
*/
|
|
887
|
+
country?: string | null;
|
|
888
|
+
/**
|
|
889
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
890
|
+
* @maxLength 50
|
|
891
|
+
*/
|
|
892
|
+
subdivision?: string | null;
|
|
893
|
+
/**
|
|
894
|
+
* City name.
|
|
895
|
+
* @maxLength 50
|
|
896
|
+
*/
|
|
897
|
+
city?: string | null;
|
|
898
|
+
/**
|
|
899
|
+
* Postal or zip code.
|
|
900
|
+
* @maxLength 50
|
|
901
|
+
*/
|
|
902
|
+
postalCode?: string | null;
|
|
903
|
+
/** Street address. */
|
|
904
|
+
streetAddress?: StreetAddress;
|
|
905
|
+
/**
|
|
906
|
+
* Main address line (usually street name and number).
|
|
907
|
+
* @maxLength 150
|
|
908
|
+
*/
|
|
909
|
+
addressLine?: string | null;
|
|
910
|
+
/**
|
|
911
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
912
|
+
* @maxLength 100
|
|
913
|
+
*/
|
|
914
|
+
addressLine2?: string | null;
|
|
915
|
+
/**
|
|
916
|
+
* Country's full name.
|
|
917
|
+
* @readonly
|
|
918
|
+
*/
|
|
919
|
+
countryFullname?: string | null;
|
|
920
|
+
/**
|
|
921
|
+
* Subdivision full-name.
|
|
922
|
+
* @readonly
|
|
923
|
+
*/
|
|
924
|
+
subdivisionFullname?: string | null;
|
|
925
|
+
}
|
|
926
|
+
interface StreetAddress {
|
|
927
|
+
/** Street number. */
|
|
928
|
+
number?: string;
|
|
929
|
+
/** Street name. */
|
|
930
|
+
name?: string;
|
|
931
|
+
}
|
|
932
|
+
/** Full contact details for an address */
|
|
933
|
+
interface FullAddressContactDetails {
|
|
934
|
+
/**
|
|
935
|
+
* First name.
|
|
936
|
+
* @maxLength 100
|
|
937
|
+
*/
|
|
938
|
+
firstName?: string | null;
|
|
939
|
+
/**
|
|
940
|
+
* Last name.
|
|
941
|
+
* @maxLength 100
|
|
942
|
+
*/
|
|
943
|
+
lastName?: string | null;
|
|
944
|
+
/**
|
|
945
|
+
* Phone number.
|
|
946
|
+
* @format PHONE
|
|
947
|
+
*/
|
|
948
|
+
phone?: string | null;
|
|
949
|
+
/**
|
|
950
|
+
* Company name.
|
|
951
|
+
* @maxLength 1000
|
|
952
|
+
*/
|
|
953
|
+
company?: string | null;
|
|
954
|
+
/** Tax information (for Brazil only). If ID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed. */
|
|
955
|
+
vatId?: VatId;
|
|
956
|
+
}
|
|
957
|
+
interface VatId {
|
|
958
|
+
/** Customer's tax ID. */
|
|
959
|
+
id?: string;
|
|
960
|
+
/**
|
|
961
|
+
* Tax type.
|
|
962
|
+
*
|
|
963
|
+
* Supported values:
|
|
964
|
+
* + `CPF`: for individual tax payers
|
|
965
|
+
* + `CNPJ`: for corporations
|
|
966
|
+
*/
|
|
967
|
+
type?: VatTypeWithLiterals;
|
|
968
|
+
}
|
|
969
|
+
/** tax info types */
|
|
970
|
+
declare enum VatType {
|
|
971
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
972
|
+
/** CPF - for individual tax payers. */
|
|
973
|
+
CPF = "CPF",
|
|
974
|
+
/** CNPJ - for corporations */
|
|
975
|
+
CNPJ = "CNPJ"
|
|
976
|
+
}
|
|
977
|
+
/** @enumType */
|
|
978
|
+
type VatTypeWithLiterals = VatType | 'UNSPECIFIED' | 'CPF' | 'CNPJ';
|
|
979
|
+
interface V1ShippingInformation {
|
|
980
|
+
/**
|
|
981
|
+
* App Def Id of external provider which was a source of shipping info
|
|
982
|
+
* @minLength 1
|
|
983
|
+
* @maxLength 100
|
|
984
|
+
*/
|
|
985
|
+
carrierId?: string | null;
|
|
986
|
+
/**
|
|
987
|
+
* Unique code (or ID) of selected shipping option. For example, `"usps_std_overnight"`.
|
|
988
|
+
* @minLength 1
|
|
989
|
+
* @maxLength 100
|
|
990
|
+
*/
|
|
991
|
+
code?: string | null;
|
|
992
|
+
/**
|
|
993
|
+
* Shipping option title.
|
|
994
|
+
* For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
|
|
995
|
+
* @maxLength 250
|
|
996
|
+
*/
|
|
997
|
+
title?: string;
|
|
998
|
+
/** Shipping logistics. */
|
|
999
|
+
logistics?: DeliveryLogistics;
|
|
1000
|
+
/** Shipping costs. */
|
|
1001
|
+
cost?: ShippingPrice;
|
|
1002
|
+
/** Shipping region. */
|
|
1003
|
+
region?: ShippingRegion;
|
|
1004
|
+
}
|
|
1005
|
+
interface DeliveryLogistics extends DeliveryLogisticsAddressOneOf {
|
|
1006
|
+
/** Shipping address and contact details. */
|
|
1007
|
+
shippingDestination?: AddressWithContact;
|
|
1008
|
+
/** Pickup details. */
|
|
1009
|
+
pickupDetails?: PickupDetails;
|
|
1010
|
+
/**
|
|
1011
|
+
* Expected delivery time in free text. For example, `"3-5 business days"`.
|
|
1012
|
+
* @maxLength 500
|
|
1013
|
+
*/
|
|
1014
|
+
deliveryTime?: string | null;
|
|
1015
|
+
/**
|
|
1016
|
+
* Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
|
|
1017
|
+
* @maxLength 1000
|
|
1018
|
+
*/
|
|
1019
|
+
instructions?: string | null;
|
|
1020
|
+
/**
|
|
1021
|
+
* Deprecated - Latest expected delivery date and time in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
1022
|
+
* @deprecated
|
|
1023
|
+
*/
|
|
1024
|
+
deliverByDate?: Date | null;
|
|
1025
|
+
/** Expected delivery time. */
|
|
1026
|
+
deliveryTimeSlot?: DeliveryTimeSlot;
|
|
1027
|
+
}
|
|
1028
|
+
/** @oneof */
|
|
1029
|
+
interface DeliveryLogisticsAddressOneOf {
|
|
1030
|
+
/** Shipping address and contact details. */
|
|
1031
|
+
shippingDestination?: AddressWithContact;
|
|
1032
|
+
/** Pickup details. */
|
|
1033
|
+
pickupDetails?: PickupDetails;
|
|
1034
|
+
}
|
|
1035
|
+
interface PickupDetails {
|
|
1036
|
+
/** Pickup address. */
|
|
1037
|
+
address?: PickupAddress;
|
|
1038
|
+
/** Pickup method */
|
|
1039
|
+
pickupMethod?: PickupMethodWithLiterals;
|
|
1040
|
+
}
|
|
1041
|
+
/** Physical address */
|
|
1042
|
+
interface PickupAddress {
|
|
1043
|
+
/**
|
|
1044
|
+
* Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
|
|
1045
|
+
* @format COUNTRY
|
|
1046
|
+
*/
|
|
1047
|
+
country?: string | null;
|
|
1048
|
+
/**
|
|
1049
|
+
* Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
|
|
1050
|
+
* @maxLength 50
|
|
1051
|
+
*/
|
|
1052
|
+
subdivision?: string | null;
|
|
1053
|
+
/**
|
|
1054
|
+
* City name.
|
|
1055
|
+
* @maxLength 1000
|
|
1056
|
+
*/
|
|
1057
|
+
city?: string | null;
|
|
1058
|
+
/**
|
|
1059
|
+
* Postal or zip code.
|
|
1060
|
+
* @maxLength 1000
|
|
1061
|
+
*/
|
|
1062
|
+
postalCode?: string | null;
|
|
1063
|
+
/** Street address object, with number, name, and apartment number in separate fields. */
|
|
1064
|
+
streetAddress?: StreetAddress;
|
|
1065
|
+
/**
|
|
1066
|
+
* Main address line (usually street name and number).
|
|
1067
|
+
* @maxLength 1000
|
|
1068
|
+
*/
|
|
1069
|
+
addressLine?: string | null;
|
|
1070
|
+
/**
|
|
1071
|
+
* Free text providing more detailed address info. Usually contains apt, suite, floor.
|
|
1072
|
+
* @maxLength 1000
|
|
1073
|
+
*/
|
|
1074
|
+
addressLine2?: string | null;
|
|
1075
|
+
/**
|
|
1076
|
+
* Country's full name.
|
|
1077
|
+
* @readonly
|
|
1078
|
+
*/
|
|
1079
|
+
countryFullname?: string | null;
|
|
1080
|
+
/**
|
|
1081
|
+
* Subdivision full-name.
|
|
1082
|
+
* @readonly
|
|
1083
|
+
*/
|
|
1084
|
+
subdivisionFullname?: string | null;
|
|
1085
|
+
}
|
|
1086
|
+
declare enum PickupMethod {
|
|
1087
|
+
UNKNOWN_METHOD = "UNKNOWN_METHOD",
|
|
1088
|
+
STORE_PICKUP = "STORE_PICKUP",
|
|
1089
|
+
PICKUP_POINT = "PICKUP_POINT"
|
|
1090
|
+
}
|
|
1091
|
+
/** @enumType */
|
|
1092
|
+
type PickupMethodWithLiterals = PickupMethod | 'UNKNOWN_METHOD' | 'STORE_PICKUP' | 'PICKUP_POINT';
|
|
1093
|
+
interface DeliveryTimeSlot {
|
|
1094
|
+
/** Delivery slot starting time. */
|
|
1095
|
+
from?: Date | null;
|
|
1096
|
+
/** Delivery slot ending time. */
|
|
1097
|
+
to?: Date | null;
|
|
1098
|
+
}
|
|
1099
|
+
interface ShippingPrice {
|
|
1100
|
+
/** Shipping price for display purposes. */
|
|
1101
|
+
price?: Price;
|
|
1102
|
+
/**
|
|
1103
|
+
* Total price of shipping after discounts (when relevant), and before tax.
|
|
1104
|
+
* @readonly
|
|
1105
|
+
*/
|
|
1106
|
+
totalPriceBeforeTax?: Price;
|
|
1107
|
+
/**
|
|
1108
|
+
* Shipping price after all discounts (if any exist), and after tax.
|
|
1109
|
+
* @readonly
|
|
1110
|
+
*/
|
|
1111
|
+
totalPriceAfterTax?: Price;
|
|
1112
|
+
/** Tax details. */
|
|
1113
|
+
taxDetails?: ItemTaxFullDetails;
|
|
1114
|
+
/**
|
|
1115
|
+
* Shipping discount before tax.
|
|
1116
|
+
* @readonly
|
|
1117
|
+
*/
|
|
1118
|
+
discount?: Price;
|
|
1119
|
+
}
|
|
1120
|
+
interface ShippingRegion {
|
|
1121
|
+
/**
|
|
1122
|
+
* Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
|
|
1123
|
+
* @maxLength 100
|
|
1124
|
+
*/
|
|
1125
|
+
name?: string | null;
|
|
1126
|
+
}
|
|
1127
|
+
declare enum OrderStatus {
|
|
1128
|
+
/** Order created, but not yet approved or canceled. */
|
|
1129
|
+
INITIALIZED = "INITIALIZED",
|
|
1130
|
+
/**
|
|
1131
|
+
* Order approved.
|
|
1132
|
+
*
|
|
1133
|
+
* This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order).
|
|
1134
|
+
* Offline orders (cash payment) are automatically approved.
|
|
1135
|
+
*/
|
|
1136
|
+
APPROVED = "APPROVED",
|
|
1137
|
+
/** Order canceled by the user. */
|
|
1138
|
+
CANCELED = "CANCELED",
|
|
1139
|
+
/**
|
|
1140
|
+
* Order pending.
|
|
1141
|
+
* @documentationMaturity preview
|
|
1142
|
+
*/
|
|
1143
|
+
PENDING = "PENDING",
|
|
1144
|
+
/**
|
|
1145
|
+
* Order rejected.
|
|
1146
|
+
*
|
|
1147
|
+
* This happens when pending payments fail.
|
|
1148
|
+
* @documentationMaturity preview
|
|
1149
|
+
*/
|
|
1150
|
+
REJECTED = "REJECTED"
|
|
1151
|
+
}
|
|
1152
|
+
/** @enumType */
|
|
1153
|
+
type OrderStatusWithLiterals = OrderStatus | 'INITIALIZED' | 'APPROVED' | 'CANCELED' | 'PENDING' | 'REJECTED';
|
|
1154
|
+
interface TaxSummary {
|
|
1155
|
+
/**
|
|
1156
|
+
* Total tax.
|
|
1157
|
+
* @readonly
|
|
1158
|
+
*/
|
|
1159
|
+
totalTax?: Price;
|
|
1160
|
+
}
|
|
1161
|
+
interface OrderTaxInfo {
|
|
1162
|
+
/** Calculated tax, added from line items. */
|
|
1163
|
+
totalTax?: Price;
|
|
1164
|
+
/**
|
|
1165
|
+
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1166
|
+
* @maxSize 50
|
|
1167
|
+
*/
|
|
1168
|
+
taxBreakdown?: OrderTaxBreakdown[];
|
|
1169
|
+
/**
|
|
1170
|
+
* Whether the order is exempt from tax calculations.
|
|
1171
|
+
*
|
|
1172
|
+
* Default: `false`
|
|
1173
|
+
* @readonly
|
|
1174
|
+
*/
|
|
1175
|
+
taxExempt?: boolean | null;
|
|
1176
|
+
}
|
|
1177
|
+
/**
|
|
1178
|
+
* The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
|
|
1179
|
+
* Tax breakdown is the tax amount split to the tax authorities that applied on the line item.
|
|
1180
|
+
*/
|
|
1181
|
+
interface OrderTaxBreakdown {
|
|
1182
|
+
/**
|
|
1183
|
+
* The name of the tax against which this tax amount was calculated.
|
|
1184
|
+
* @maxLength 200
|
|
1185
|
+
*/
|
|
1186
|
+
taxName?: string;
|
|
1187
|
+
/**
|
|
1188
|
+
* The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
|
|
1189
|
+
* @maxLength 200
|
|
1190
|
+
*/
|
|
1191
|
+
taxType?: string;
|
|
1192
|
+
/**
|
|
1193
|
+
* The name of the jurisdiction in which this tax detail applies.
|
|
1194
|
+
* @maxLength 200
|
|
1195
|
+
*/
|
|
1196
|
+
jurisdiction?: string;
|
|
1197
|
+
/** The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
|
|
1198
|
+
jurisdictionType?: JurisdictionTypeWithLiterals;
|
|
1199
|
+
/**
|
|
1200
|
+
* The rate at which this tax detail was calculated.
|
|
1201
|
+
* @format DECIMAL_VALUE
|
|
1202
|
+
* @decimalValue options { gte:0, maxScale:6 }
|
|
1203
|
+
*/
|
|
1204
|
+
rate?: string;
|
|
1205
|
+
/** The sum of all the tax from line items that calculated by the tax identifiers. */
|
|
1206
|
+
aggregatedTaxAmount?: Price;
|
|
1207
|
+
}
|
|
1208
|
+
interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
|
|
1209
|
+
/** Applied coupon info. */
|
|
1210
|
+
coupon?: Coupon;
|
|
1211
|
+
/** Merchant discount. */
|
|
1212
|
+
merchantDiscount?: MerchantDiscount;
|
|
1213
|
+
/** Automatic Discount */
|
|
1214
|
+
discountRule?: DiscountRule;
|
|
1215
|
+
/**
|
|
1216
|
+
* Discount type.
|
|
1217
|
+
* * `"GLOBAL"` - discount applies to entire order.
|
|
1218
|
+
* * `"SPECIFIC-ITEMS"` - discount applies to specific items.
|
|
1219
|
+
* * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
|
|
1220
|
+
*/
|
|
1221
|
+
discountType?: DiscountTypeWithLiterals;
|
|
1222
|
+
/**
|
|
1223
|
+
* IDs of line items discount applies to.
|
|
1224
|
+
* Deprecated. Use `line_item_discounts` instead.
|
|
1225
|
+
* @format GUID
|
|
1226
|
+
* @maxSize 1
|
|
1227
|
+
* @deprecated IDs of line items discount applies to.
|
|
1228
|
+
* Deprecated. Use `line_item_discounts` instead.
|
|
1229
|
+
* @replacedBy line_item_discounts
|
|
1230
|
+
* @targetRemovalDate 2024-10-30
|
|
1231
|
+
*/
|
|
1232
|
+
lineItemIds?: string[];
|
|
1233
|
+
/**
|
|
1234
|
+
* Discount id.
|
|
1235
|
+
* @format GUID
|
|
1236
|
+
* @immutable
|
|
1237
|
+
*/
|
|
1238
|
+
id?: string | null;
|
|
1239
|
+
}
|
|
1240
|
+
/** @oneof */
|
|
1241
|
+
interface AppliedDiscountDiscountSourceOneOf {
|
|
1242
|
+
/** Applied coupon info. */
|
|
1243
|
+
coupon?: Coupon;
|
|
1244
|
+
/** Merchant discount. */
|
|
1245
|
+
merchantDiscount?: MerchantDiscount;
|
|
1246
|
+
/** Automatic Discount */
|
|
1247
|
+
discountRule?: DiscountRule;
|
|
1248
|
+
}
|
|
1249
|
+
declare enum DiscountType {
|
|
1250
|
+
GLOBAL = "GLOBAL",
|
|
1251
|
+
SPECIFIC_ITEMS = "SPECIFIC_ITEMS",
|
|
1252
|
+
SHIPPING = "SHIPPING"
|
|
1253
|
+
}
|
|
1254
|
+
/** @enumType */
|
|
1255
|
+
type DiscountTypeWithLiterals = DiscountType | 'GLOBAL' | 'SPECIFIC_ITEMS' | 'SHIPPING';
|
|
1256
|
+
/** Coupon */
|
|
1257
|
+
interface Coupon {
|
|
1258
|
+
/** Coupon ID. */
|
|
1259
|
+
id?: string;
|
|
1260
|
+
/** Coupon code. */
|
|
1261
|
+
code?: string;
|
|
1262
|
+
/** Coupon name. */
|
|
1263
|
+
name?: string;
|
|
1264
|
+
/** Coupon value. */
|
|
1265
|
+
amount?: Price;
|
|
1266
|
+
}
|
|
1267
|
+
interface MerchantDiscount extends MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1268
|
+
/**
|
|
1269
|
+
* Pre-defined discount reason (optional).
|
|
1270
|
+
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1271
|
+
*/
|
|
1272
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1273
|
+
/**
|
|
1274
|
+
* Discount description as free text (optional).
|
|
1275
|
+
* @maxLength 200
|
|
1276
|
+
*/
|
|
1277
|
+
description?: string | null;
|
|
1278
|
+
/** Discount amount. */
|
|
1279
|
+
amount?: Price;
|
|
1280
|
+
}
|
|
1281
|
+
/** @oneof */
|
|
1282
|
+
interface MerchantDiscountMerchantDiscountReasonOneOf {
|
|
1283
|
+
/**
|
|
1284
|
+
* Pre-defined discount reason (optional).
|
|
1285
|
+
* * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
|
|
1286
|
+
*/
|
|
1287
|
+
discountReason?: DiscountReasonWithLiterals;
|
|
1288
|
+
/**
|
|
1289
|
+
* Discount description as free text (optional).
|
|
1290
|
+
* @maxLength 200
|
|
1291
|
+
*/
|
|
1292
|
+
description?: string | null;
|
|
1293
|
+
}
|
|
1294
|
+
declare enum DiscountReason {
|
|
1295
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
1296
|
+
EXCHANGED_ITEMS = "EXCHANGED_ITEMS",
|
|
1297
|
+
BILLING_ADJUSTMENT = "BILLING_ADJUSTMENT"
|
|
1298
|
+
}
|
|
1299
|
+
/** @enumType */
|
|
1300
|
+
type DiscountReasonWithLiterals = DiscountReason | 'UNSPECIFIED' | 'EXCHANGED_ITEMS' | 'BILLING_ADJUSTMENT';
|
|
1301
|
+
interface DiscountRule {
|
|
1302
|
+
/**
|
|
1303
|
+
* Discount rule ID
|
|
1304
|
+
* @format GUID
|
|
1305
|
+
*/
|
|
1306
|
+
id?: string;
|
|
1307
|
+
/** Discount rule name */
|
|
1308
|
+
name?: DiscountRuleName;
|
|
1309
|
+
/** Discount value. */
|
|
1310
|
+
amount?: Price;
|
|
1311
|
+
}
|
|
1312
|
+
interface DiscountRuleName {
|
|
1313
|
+
/**
|
|
1314
|
+
* Original discount rule name (in site's default language).
|
|
1315
|
+
* @minLength 1
|
|
1316
|
+
* @maxLength 256
|
|
1317
|
+
*/
|
|
1318
|
+
original?: string;
|
|
1319
|
+
/**
|
|
1320
|
+
* Translated discount rule name according to buyer language. Defaults to `original` when not provided.
|
|
1321
|
+
* @minLength 1
|
|
1322
|
+
* @maxLength 500
|
|
1323
|
+
*/
|
|
1324
|
+
translated?: string | null;
|
|
1325
|
+
}
|
|
1326
|
+
interface Activity extends ActivityContentOneOf {
|
|
1327
|
+
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1328
|
+
customActivity?: CustomActivity;
|
|
1329
|
+
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
1330
|
+
merchantComment?: MerchantComment;
|
|
1331
|
+
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1332
|
+
orderRefunded?: OrderRefunded;
|
|
1333
|
+
/**
|
|
1334
|
+
* Activity ID.
|
|
1335
|
+
* @format GUID
|
|
1336
|
+
* @readonly
|
|
1337
|
+
*/
|
|
1338
|
+
id?: string | null;
|
|
1339
|
+
/**
|
|
1340
|
+
* Activity author's email.
|
|
1341
|
+
* @format EMAIL
|
|
1342
|
+
* @readonly
|
|
1343
|
+
*/
|
|
1344
|
+
authorEmail?: string | null;
|
|
1345
|
+
/**
|
|
1346
|
+
* Activity creation date and time.
|
|
1347
|
+
* @readonly
|
|
1348
|
+
*/
|
|
1349
|
+
createdDate?: Date | null;
|
|
1350
|
+
/** Activity type. */
|
|
1351
|
+
type?: ActivityTypeWithLiterals;
|
|
1352
|
+
}
|
|
1353
|
+
/** @oneof */
|
|
1354
|
+
interface ActivityContentOneOf {
|
|
1355
|
+
/** Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`. */
|
|
1356
|
+
customActivity?: CustomActivity;
|
|
1357
|
+
/** Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`. */
|
|
1358
|
+
merchantComment?: MerchantComment;
|
|
1359
|
+
/** Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`. */
|
|
1360
|
+
orderRefunded?: OrderRefunded;
|
|
1361
|
+
}
|
|
1362
|
+
interface CustomActivity {
|
|
1363
|
+
/**
|
|
1364
|
+
* ID of the app that created the custom activity.
|
|
1365
|
+
* @format GUID
|
|
1366
|
+
*/
|
|
1367
|
+
appId?: string;
|
|
1368
|
+
/**
|
|
1369
|
+
* Custom activity type. For example, `"Ticket number set"`.
|
|
1370
|
+
* @maxLength 100
|
|
1371
|
+
*/
|
|
1372
|
+
type?: string;
|
|
1373
|
+
/** Additional data in key-value form. For example, `{ "Ticket number": "123456" }`. */
|
|
1374
|
+
additionalData?: Record<string, string>;
|
|
1375
|
+
}
|
|
1376
|
+
/** Store owner added a comment */
|
|
1377
|
+
interface MerchantComment {
|
|
1378
|
+
/**
|
|
1379
|
+
* Merchant comment message.
|
|
1380
|
+
* @minLength 1
|
|
1381
|
+
* @maxLength 5000
|
|
1382
|
+
*/
|
|
1383
|
+
message?: string;
|
|
1384
|
+
}
|
|
1385
|
+
interface OrderRefunded {
|
|
1386
|
+
/** Whether order was refunded manually. For example, via payment provider or using cash. */
|
|
1387
|
+
manual?: boolean;
|
|
1388
|
+
/** Refund amount. */
|
|
1389
|
+
amount?: Price;
|
|
1390
|
+
/**
|
|
1391
|
+
* Reason for refund.
|
|
1392
|
+
* @maxLength 200
|
|
1393
|
+
*/
|
|
1394
|
+
reason?: string;
|
|
1395
|
+
}
|
|
1396
|
+
declare enum ActivityType {
|
|
1397
|
+
ORDER_REFUNDED = "ORDER_REFUNDED",
|
|
1398
|
+
ORDER_PLACED = "ORDER_PLACED",
|
|
1399
|
+
ORDER_PAID = "ORDER_PAID",
|
|
1400
|
+
ORDER_FULFILLED = "ORDER_FULFILLED",
|
|
1401
|
+
ORDER_NOT_FULFILLED = "ORDER_NOT_FULFILLED",
|
|
1402
|
+
ORDER_CANCELED = "ORDER_CANCELED",
|
|
1403
|
+
DOWNLOAD_LINK_SENT = "DOWNLOAD_LINK_SENT",
|
|
1404
|
+
TRACKING_NUMBER_ADDED = "TRACKING_NUMBER_ADDED",
|
|
1405
|
+
TRACKING_NUMBER_EDITED = "TRACKING_NUMBER_EDITED",
|
|
1406
|
+
TRACKING_LINK_ADDED = "TRACKING_LINK_ADDED",
|
|
1407
|
+
SHIPPING_CONFIRMATION_EMAIL_SENT = "SHIPPING_CONFIRMATION_EMAIL_SENT",
|
|
1408
|
+
INVOICE_ADDED = "INVOICE_ADDED",
|
|
1409
|
+
INVOICE_REMOVED = "INVOICE_REMOVED",
|
|
1410
|
+
INVOICE_SENT = "INVOICE_SENT",
|
|
1411
|
+
FULFILLER_EMAIL_SENT = "FULFILLER_EMAIL_SENT",
|
|
1412
|
+
SHIPPING_ADDRESS_EDITED = "SHIPPING_ADDRESS_EDITED",
|
|
1413
|
+
EMAIL_EDITED = "EMAIL_EDITED",
|
|
1414
|
+
PICKUP_READY_EMAIL_SENT = "PICKUP_READY_EMAIL_SENT",
|
|
1415
|
+
CUSTOM_ACTIVITY = "CUSTOM_ACTIVITY",
|
|
1416
|
+
MERCHANT_COMMENT = "MERCHANT_COMMENT",
|
|
1417
|
+
ORDER_CREATED_FROM_EXCHANGE = "ORDER_CREATED_FROM_EXCHANGE",
|
|
1418
|
+
NEW_EXCHANGE_ORDER_CREATED = "NEW_EXCHANGE_ORDER_CREATED",
|
|
1419
|
+
ORDER_PARTIALLY_PAID = "ORDER_PARTIALLY_PAID",
|
|
1420
|
+
DRAFT_ORDER_CHANGES_APPLIED = "DRAFT_ORDER_CHANGES_APPLIED",
|
|
1421
|
+
SAVED_PAYMENT_METHOD = "SAVED_PAYMENT_METHOD",
|
|
1422
|
+
/** @documentationMaturity preview */
|
|
1423
|
+
PAYMENT_PENDING = "PAYMENT_PENDING",
|
|
1424
|
+
/** @documentationMaturity preview */
|
|
1425
|
+
PAYMENT_CANCELED = "PAYMENT_CANCELED",
|
|
1426
|
+
/** @documentationMaturity preview */
|
|
1427
|
+
PAYMENT_DECLINED = "PAYMENT_DECLINED",
|
|
1428
|
+
/** @documentationMaturity preview */
|
|
1429
|
+
ORDER_PENDING = "ORDER_PENDING",
|
|
1430
|
+
/** @documentationMaturity preview */
|
|
1431
|
+
ORDER_REJECTED = "ORDER_REJECTED"
|
|
1432
|
+
}
|
|
1433
|
+
/** @enumType */
|
|
1434
|
+
type ActivityTypeWithLiterals = ActivityType | 'ORDER_REFUNDED' | 'ORDER_PLACED' | 'ORDER_PAID' | 'ORDER_FULFILLED' | 'ORDER_NOT_FULFILLED' | 'ORDER_CANCELED' | 'DOWNLOAD_LINK_SENT' | 'TRACKING_NUMBER_ADDED' | 'TRACKING_NUMBER_EDITED' | 'TRACKING_LINK_ADDED' | 'SHIPPING_CONFIRMATION_EMAIL_SENT' | 'INVOICE_ADDED' | 'INVOICE_REMOVED' | 'INVOICE_SENT' | 'FULFILLER_EMAIL_SENT' | 'SHIPPING_ADDRESS_EDITED' | 'EMAIL_EDITED' | 'PICKUP_READY_EMAIL_SENT' | 'CUSTOM_ACTIVITY' | 'MERCHANT_COMMENT' | 'ORDER_CREATED_FROM_EXCHANGE' | 'NEW_EXCHANGE_ORDER_CREATED' | 'ORDER_PARTIALLY_PAID' | 'DRAFT_ORDER_CHANGES_APPLIED' | 'SAVED_PAYMENT_METHOD' | 'PAYMENT_PENDING' | 'PAYMENT_CANCELED' | 'PAYMENT_DECLINED' | 'ORDER_PENDING' | 'ORDER_REJECTED';
|
|
1435
|
+
declare enum AttributionSource {
|
|
1436
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
1437
|
+
FACEBOOK_ADS = "FACEBOOK_ADS"
|
|
1438
|
+
}
|
|
1439
|
+
/** @enumType */
|
|
1440
|
+
type AttributionSourceWithLiterals = AttributionSource | 'UNSPECIFIED' | 'FACEBOOK_ADS';
|
|
1441
|
+
interface CreatedBy extends CreatedByStringOneOf {
|
|
1442
|
+
/**
|
|
1443
|
+
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1444
|
+
* For example, via POS (point of service).
|
|
1445
|
+
* @format GUID
|
|
1446
|
+
*/
|
|
1447
|
+
userId?: string;
|
|
1448
|
+
/**
|
|
1449
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
1450
|
+
* @format GUID
|
|
1451
|
+
*/
|
|
1452
|
+
memberId?: string;
|
|
1453
|
+
/**
|
|
1454
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
1455
|
+
* @format GUID
|
|
1456
|
+
*/
|
|
1457
|
+
visitorId?: string;
|
|
1458
|
+
/**
|
|
1459
|
+
* App ID - when the order was created by an external application.
|
|
1460
|
+
* @format GUID
|
|
1461
|
+
*/
|
|
1462
|
+
appId?: string;
|
|
1463
|
+
}
|
|
1464
|
+
/** @oneof */
|
|
1465
|
+
interface CreatedByStringOneOf {
|
|
1466
|
+
/**
|
|
1467
|
+
* User ID - when the order was created by a Wix user on behalf of a buyer.
|
|
1468
|
+
* For example, via POS (point of service).
|
|
1469
|
+
* @format GUID
|
|
1470
|
+
*/
|
|
1471
|
+
userId?: string;
|
|
1472
|
+
/**
|
|
1473
|
+
* Member ID - when the order was created by a **logged in** site visitor.
|
|
1474
|
+
* @format GUID
|
|
1475
|
+
*/
|
|
1476
|
+
memberId?: string;
|
|
1477
|
+
/**
|
|
1478
|
+
* Visitor ID - when the order was created by a site visitor that was **not** logged in.
|
|
1479
|
+
* @format GUID
|
|
1480
|
+
*/
|
|
1481
|
+
visitorId?: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* App ID - when the order was created by an external application.
|
|
1484
|
+
* @format GUID
|
|
1485
|
+
*/
|
|
1486
|
+
appId?: string;
|
|
1487
|
+
}
|
|
1488
|
+
interface ChannelInfo {
|
|
1489
|
+
/** Sales channel that submitted the order. */
|
|
1490
|
+
type?: ChannelTypeWithLiterals;
|
|
1491
|
+
/**
|
|
1492
|
+
* Reference to an order ID from an external system.
|
|
1493
|
+
* @maxLength 100
|
|
1494
|
+
*/
|
|
1495
|
+
externalOrderId?: string | null;
|
|
1496
|
+
/**
|
|
1497
|
+
* URL to the order in the external system.
|
|
1498
|
+
* @maxLength 300
|
|
1499
|
+
*/
|
|
1500
|
+
externalOrderUrl?: string | null;
|
|
1501
|
+
}
|
|
1502
|
+
declare enum ChannelType {
|
|
1503
|
+
/** Unspecified sales channel. This value is not supported. */
|
|
1504
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
1505
|
+
/** A web client. */
|
|
1506
|
+
WEB = "WEB",
|
|
1507
|
+
/** [Point of sale solutions](https://support.wix.com/en/wix-mobile-pos-2196395). */
|
|
1508
|
+
POS = "POS",
|
|
1509
|
+
/** [eBay shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-ebay-shop). */
|
|
1510
|
+
EBAY = "EBAY",
|
|
1511
|
+
/** [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop). */
|
|
1512
|
+
AMAZON = "AMAZON",
|
|
1513
|
+
/** Other sales platform. */
|
|
1514
|
+
OTHER_PLATFORM = "OTHER_PLATFORM",
|
|
1515
|
+
/** [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview). */
|
|
1516
|
+
WIX_APP_STORE = "WIX_APP_STORE",
|
|
1517
|
+
/** Wix Invoices app in [your dashboard](https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Finvoices/settings/general-settings) */
|
|
1518
|
+
WIX_INVOICES = "WIX_INVOICES",
|
|
1519
|
+
/** Wix merchant backoffice. */
|
|
1520
|
+
BACKOFFICE_MERCHANT = "BACKOFFICE_MERCHANT",
|
|
1521
|
+
/** Wish sales channel. */
|
|
1522
|
+
WISH = "WISH",
|
|
1523
|
+
/** [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass). */
|
|
1524
|
+
CLASS_PASS = "CLASS_PASS",
|
|
1525
|
+
/** Global-E sales channel. */
|
|
1526
|
+
GLOBAL_E = "GLOBAL_E",
|
|
1527
|
+
/** [Facebook shop](https://support.wix.com/en/article/wix-stores-changes-to-facebook-shops). */
|
|
1528
|
+
FACEBOOK = "FACEBOOK",
|
|
1529
|
+
/** [Etsy sales channel](https://support.wix.com/en/article/wix-stores-request-adding-etsy-as-a-sales-channel). */
|
|
1530
|
+
ETSY = "ETSY",
|
|
1531
|
+
/** [TikTok sales channel](https://support.wix.com/en/article/wix-stores-request-adding-tiktok-as-a-sales-channel). */
|
|
1532
|
+
TIKTOK = "TIKTOK",
|
|
1533
|
+
/** [Faire marketplace integration](https://support.wix.com/en/article/wix-stores-creating-a-faire-store-using-the-faire-integration-app). */
|
|
1534
|
+
FAIRE_COM = "FAIRE_COM"
|
|
1535
|
+
}
|
|
1536
|
+
/** @enumType */
|
|
1537
|
+
type ChannelTypeWithLiterals = ChannelType | 'UNSPECIFIED' | 'WEB' | 'POS' | 'EBAY' | 'AMAZON' | 'OTHER_PLATFORM' | 'WIX_APP_STORE' | 'WIX_INVOICES' | 'BACKOFFICE_MERCHANT' | 'WISH' | 'CLASS_PASS' | 'GLOBAL_E' | 'FACEBOOK' | 'ETSY' | 'TIKTOK' | 'FAIRE_COM';
|
|
1538
|
+
interface CustomField {
|
|
1539
|
+
/** Custom field value. */
|
|
1540
|
+
value?: any;
|
|
1541
|
+
/**
|
|
1542
|
+
* Custom field title.
|
|
1543
|
+
* @minLength 1
|
|
1544
|
+
* @maxLength 500
|
|
1545
|
+
*/
|
|
1546
|
+
title?: string;
|
|
1547
|
+
/**
|
|
1548
|
+
* Translated custom field title.
|
|
1549
|
+
* @minLength 1
|
|
1550
|
+
* @maxLength 500
|
|
1551
|
+
*/
|
|
1552
|
+
translatedTitle?: string | null;
|
|
1553
|
+
}
|
|
1554
|
+
interface BalanceSummary {
|
|
1555
|
+
/**
|
|
1556
|
+
* Current amount left to pay.
|
|
1557
|
+
* @readonly
|
|
1558
|
+
*/
|
|
1559
|
+
balance?: Balance;
|
|
1560
|
+
/**
|
|
1561
|
+
* Sum of all approved and successful payments.
|
|
1562
|
+
*
|
|
1563
|
+
* The value includes payments that have subsequently been fully or partially refunded.
|
|
1564
|
+
* @readonly
|
|
1565
|
+
*/
|
|
1566
|
+
paid?: Price;
|
|
1567
|
+
/**
|
|
1568
|
+
* Sum of all successfully refunded payments.
|
|
1569
|
+
* @readonly
|
|
1570
|
+
*/
|
|
1571
|
+
refunded?: Price;
|
|
1572
|
+
/**
|
|
1573
|
+
* Sum of all authorized payments.
|
|
1574
|
+
* @readonly
|
|
1575
|
+
*/
|
|
1576
|
+
authorized?: Price;
|
|
1577
|
+
/**
|
|
1578
|
+
* Sum of all pending transactions.
|
|
1579
|
+
* @readonly
|
|
1580
|
+
*/
|
|
1581
|
+
pending?: Price;
|
|
1582
|
+
}
|
|
1583
|
+
/**
|
|
1584
|
+
* Order balance. Reflects amount left to be paid on order and is calculated dynamically. Can be negative per balance definition.
|
|
1585
|
+
* `amount` field depends on order payment status:
|
|
1586
|
+
* + UNSPECIFIED, NOT_PAID: price_summary.total_price
|
|
1587
|
+
* + PARTIALLY_PAID : price_summary.total_price - pay_now.total_price
|
|
1588
|
+
* + PENDING, REFUNDED, PARTIALLY_REFUNDED, PAID : 0
|
|
1589
|
+
*/
|
|
1590
|
+
interface Balance {
|
|
1591
|
+
/**
|
|
1592
|
+
* Balance amount.
|
|
1593
|
+
*
|
|
1594
|
+
* A negative `amount` represents the amount to be refunded. This can happen due to overcharging or the order being modified after a payment has been made.
|
|
1595
|
+
* @decimalValue options { }
|
|
1596
|
+
* @readonly
|
|
1597
|
+
*/
|
|
1598
|
+
amount?: string;
|
|
1599
|
+
/**
|
|
1600
|
+
* Amount formatted with currency symbol.
|
|
1601
|
+
* @readonly
|
|
1602
|
+
*/
|
|
1603
|
+
formattedAmount?: string;
|
|
1604
|
+
}
|
|
1605
|
+
interface AdditionalFee {
|
|
1606
|
+
/**
|
|
1607
|
+
* Additional fee's unique code for future processing.
|
|
1608
|
+
* @minLength 1
|
|
1609
|
+
* @maxLength 100
|
|
1610
|
+
*/
|
|
1611
|
+
code?: string | null;
|
|
1612
|
+
/**
|
|
1613
|
+
* Name of additional fee.
|
|
1614
|
+
* @minLength 1
|
|
1615
|
+
* @maxLength 50
|
|
1616
|
+
*/
|
|
1617
|
+
name?: string;
|
|
1618
|
+
/** Additional fee's price. */
|
|
1619
|
+
price?: Price;
|
|
1620
|
+
/** Tax details. */
|
|
1621
|
+
taxDetails?: ItemTaxFullDetails;
|
|
1622
|
+
/**
|
|
1623
|
+
* SPI implementer's `appId`.
|
|
1624
|
+
* @format GUID
|
|
1625
|
+
*/
|
|
1626
|
+
providerAppId?: string | null;
|
|
1627
|
+
/** Additional fee's price before tax. */
|
|
1628
|
+
priceBeforeTax?: Price;
|
|
1629
|
+
/** Additional fee's price after tax. */
|
|
1630
|
+
priceAfterTax?: Price;
|
|
1631
|
+
/**
|
|
1632
|
+
* Additional fee's id.
|
|
1633
|
+
* @format GUID
|
|
1634
|
+
* @immutable
|
|
1635
|
+
*/
|
|
1636
|
+
id?: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* Optional - Line items associated with this additional fee.
|
|
1639
|
+
* If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
|
|
1640
|
+
* @format GUID
|
|
1641
|
+
*/
|
|
1642
|
+
lineItemIds?: string[];
|
|
1643
|
+
}
|
|
1644
|
+
/**
|
|
1645
|
+
* Common object for tags.
|
|
1646
|
+
* Should be use as in this example:
|
|
1647
|
+
* message Foo {
|
|
1648
|
+
* string id = 1;
|
|
1649
|
+
* ...
|
|
1650
|
+
* Tags tags = 5
|
|
1651
|
+
* }
|
|
1652
|
+
*
|
|
1653
|
+
* example of taggable entity
|
|
1654
|
+
* {
|
|
1655
|
+
* id: "123"
|
|
1656
|
+
* tags: {
|
|
1657
|
+
* tags: {
|
|
1658
|
+
* tag_ids:["11","22"]
|
|
1659
|
+
* },
|
|
1660
|
+
* private_tags: {
|
|
1661
|
+
* tag_ids: ["33", "44"]
|
|
1662
|
+
* }
|
|
1663
|
+
* }
|
|
1664
|
+
* }
|
|
1665
|
+
*/
|
|
1666
|
+
interface Tags {
|
|
1667
|
+
/** Tags that require an additional permission in order to access them, normally not given to site members or visitors. */
|
|
1668
|
+
privateTags?: TagList;
|
|
1669
|
+
/** Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors. */
|
|
1670
|
+
tags?: TagList;
|
|
1671
|
+
}
|
|
1672
|
+
interface TagList {
|
|
1673
|
+
/**
|
|
1674
|
+
* List of tag IDs
|
|
1675
|
+
* @maxSize 100
|
|
1676
|
+
* @maxLength 5
|
|
1677
|
+
*/
|
|
1678
|
+
tagIds?: string[];
|
|
1679
|
+
}
|
|
1680
|
+
interface Location {
|
|
1681
|
+
/**
|
|
1682
|
+
* Location ID.
|
|
1683
|
+
* Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
|
|
1684
|
+
* @format GUID
|
|
1685
|
+
*/
|
|
1686
|
+
id?: string;
|
|
1687
|
+
/**
|
|
1688
|
+
* Location name.
|
|
1689
|
+
* @minLength 1
|
|
1690
|
+
* @maxLength 500
|
|
1691
|
+
* @readonly
|
|
1692
|
+
*/
|
|
1693
|
+
name?: string;
|
|
1694
|
+
}
|
|
1695
|
+
interface PreparePaymentCollectionRequest {
|
|
1696
|
+
/**
|
|
1697
|
+
* Ecom order ID.
|
|
1698
|
+
* @minLength 1
|
|
1699
|
+
* @maxLength 100
|
|
1700
|
+
*/
|
|
1701
|
+
ecomOrderId: string;
|
|
1702
|
+
/** Amount to collect */
|
|
1703
|
+
amount: Price;
|
|
1704
|
+
/**
|
|
1705
|
+
* Optional parameter. When present, payment collection will be performed using given payment gateway order.
|
|
1706
|
+
* Existing payment gateway order will be updated with a new amount.
|
|
1707
|
+
* When parameter is absent, new payment gateway order will be created and used for payment collection.
|
|
1708
|
+
*/
|
|
1709
|
+
paymentGatewayOrderId?: string | null;
|
|
1710
|
+
/**
|
|
1711
|
+
* Whether to delay capture of the payment.
|
|
1712
|
+
* Default: false
|
|
1713
|
+
* @deprecated Whether to delay capture of the payment.
|
|
1714
|
+
* Default: false
|
|
1715
|
+
* @replacedBy delayed_capture_settings.scheduled_action
|
|
1716
|
+
* @targetRemovalDate 2024-09-30
|
|
1717
|
+
*/
|
|
1718
|
+
delayedCapture?: boolean;
|
|
1719
|
+
/** Delayed capture payment settings */
|
|
1720
|
+
delayedCaptureSettings?: DelayedCaptureSettings;
|
|
1721
|
+
}
|
|
1722
|
+
interface DelayedCaptureSettings {
|
|
1723
|
+
/** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
|
|
1724
|
+
scheduledAction?: ScheduledActionWithLiterals;
|
|
1725
|
+
/** Delay duration before execution. Optional - if not set, providers default period will be used */
|
|
1726
|
+
delayDuration?: Duration;
|
|
1727
|
+
}
|
|
1728
|
+
declare enum ScheduledAction {
|
|
1729
|
+
UNSPECIFIED = "UNSPECIFIED",
|
|
1730
|
+
/** Whether payment will be auto-voided when duration passes */
|
|
1731
|
+
VOID = "VOID",
|
|
1732
|
+
/** Whether payment will be auto-captured when duration passes */
|
|
1733
|
+
CAPTURE = "CAPTURE"
|
|
1734
|
+
}
|
|
1735
|
+
/** @enumType */
|
|
1736
|
+
type ScheduledActionWithLiterals = ScheduledAction | 'UNSPECIFIED' | 'VOID' | 'CAPTURE';
|
|
1737
|
+
interface Duration {
|
|
1738
|
+
/**
|
|
1739
|
+
* Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
|
|
1740
|
+
* @min 1
|
|
1741
|
+
*/
|
|
1742
|
+
count?: number;
|
|
1743
|
+
/** Duration unit: MINUTES, HOURS and DAYS */
|
|
1744
|
+
unit?: DurationUnitWithLiterals;
|
|
1745
|
+
}
|
|
1746
|
+
declare enum DurationUnit {
|
|
1747
|
+
UNKNOWN_DURATION_UNIT = "UNKNOWN_DURATION_UNIT",
|
|
1748
|
+
MINUTES = "MINUTES",
|
|
1749
|
+
HOURS = "HOURS",
|
|
1750
|
+
DAYS = "DAYS"
|
|
1751
|
+
}
|
|
1752
|
+
/** @enumType */
|
|
1753
|
+
type DurationUnitWithLiterals = DurationUnit | 'UNKNOWN_DURATION_UNIT' | 'MINUTES' | 'HOURS' | 'DAYS';
|
|
1754
|
+
interface PreparePaymentCollectionResponse {
|
|
1755
|
+
/** Payment gateway order id which is associated with given payment */
|
|
1756
|
+
paymentGatewayOrderId?: string;
|
|
1757
|
+
}
|
|
1758
|
+
interface GetPaymentCollectabilityStatusRequest {
|
|
1759
|
+
/**
|
|
1760
|
+
* Ecom order ID.
|
|
1761
|
+
* @minLength 1
|
|
1762
|
+
* @maxLength 100
|
|
1763
|
+
*/
|
|
1764
|
+
ecomOrderId: string;
|
|
1765
|
+
}
|
|
1766
|
+
interface GetPaymentCollectabilityStatusResponse {
|
|
1767
|
+
/** Payment collectability status */
|
|
1768
|
+
status?: PaymentCollectabilityStatusWithLiterals;
|
|
1769
|
+
/** Collectable order amount */
|
|
1770
|
+
amount?: Price;
|
|
1771
|
+
}
|
|
1772
|
+
declare enum PaymentCollectabilityStatus {
|
|
1773
|
+
UNKNOWN = "UNKNOWN",
|
|
1774
|
+
COLLECTABLE = "COLLECTABLE",
|
|
1775
|
+
NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
|
|
1776
|
+
NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
|
|
1777
|
+
NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
|
|
1778
|
+
NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
|
|
1779
|
+
NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
|
|
1780
|
+
NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS"
|
|
1781
|
+
}
|
|
1782
|
+
/** @enumType */
|
|
1783
|
+
type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS';
|
|
1784
|
+
interface RecordManuallyCollectedPaymentRequest {
|
|
1785
|
+
/**
|
|
1786
|
+
* Order ID.
|
|
1787
|
+
* @minLength 1
|
|
1788
|
+
* @maxLength 100
|
|
1789
|
+
*/
|
|
1790
|
+
orderId: string;
|
|
1791
|
+
/** Amount to be recorded as approved manual payment for given order */
|
|
1792
|
+
amount: Price;
|
|
1793
|
+
}
|
|
1794
|
+
interface RecordManuallyCollectedPaymentResponse {
|
|
1795
|
+
}
|
|
1796
|
+
interface MarkOrderAsPaidRequest {
|
|
1797
|
+
/**
|
|
1798
|
+
* Ecom order ID.
|
|
1799
|
+
* @minLength 1
|
|
1800
|
+
* @maxLength 100
|
|
1801
|
+
*/
|
|
1802
|
+
ecomOrderId: string;
|
|
1803
|
+
}
|
|
1804
|
+
interface MarkOrderAsPaidResponse {
|
|
1805
|
+
/** Updated order. */
|
|
1806
|
+
order?: Order;
|
|
1807
|
+
}
|
|
1808
|
+
interface BulkMarkOrdersAsPaidRequest {
|
|
1809
|
+
/**
|
|
1810
|
+
* IDs of orders to mark as paid.
|
|
1811
|
+
* @minSize 1
|
|
1812
|
+
* @maxSize 100
|
|
1813
|
+
* @minLength 1
|
|
1814
|
+
* @maxLength 100
|
|
1815
|
+
*/
|
|
1816
|
+
ecomOrderIds: string[];
|
|
1817
|
+
}
|
|
1818
|
+
interface BulkMarkOrdersAsPaidResponse {
|
|
1819
|
+
/**
|
|
1820
|
+
* Items updated by the bulk action.
|
|
1821
|
+
* The Order entity within the results optimistically changes its payment status to paid, however this process is async.
|
|
1822
|
+
*/
|
|
1823
|
+
results?: BulkOrderResult[];
|
|
1824
|
+
/** Bulk action metadata. */
|
|
1825
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
1826
|
+
}
|
|
1827
|
+
interface BulkOrderResult {
|
|
1828
|
+
/** Item metadata. */
|
|
1829
|
+
itemMetadata?: ItemMetadata;
|
|
1830
|
+
/**
|
|
1831
|
+
* Updated order.
|
|
1832
|
+
*
|
|
1833
|
+
* Returned when `returnFullEntity = true`.
|
|
1834
|
+
*/
|
|
1835
|
+
item?: Order;
|
|
1836
|
+
}
|
|
1837
|
+
interface ItemMetadata {
|
|
1838
|
+
/** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
|
|
1839
|
+
id?: string | null;
|
|
1840
|
+
/** Index of the item within the request array. Allows for correlation between request and response items. */
|
|
1841
|
+
originalIndex?: number;
|
|
1842
|
+
/** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
|
|
1843
|
+
success?: boolean;
|
|
1844
|
+
/** Details about the error in case of failure. */
|
|
1845
|
+
error?: ApplicationError;
|
|
1846
|
+
}
|
|
1847
|
+
interface ApplicationError {
|
|
1848
|
+
/** Error code. */
|
|
1849
|
+
code?: string;
|
|
1850
|
+
/** Description of the error. */
|
|
1851
|
+
description?: string;
|
|
1852
|
+
/** Data related to the error. */
|
|
1853
|
+
data?: Record<string, any> | null;
|
|
1854
|
+
}
|
|
1855
|
+
interface BulkActionMetadata {
|
|
1856
|
+
/** Number of items that were successfully processed. */
|
|
1857
|
+
totalSuccesses?: number;
|
|
1858
|
+
/** Number of items that couldn't be processed. */
|
|
1859
|
+
totalFailures?: number;
|
|
1860
|
+
/** Number of failures without details because detailed failure threshold was exceeded. */
|
|
1861
|
+
undetailedFailures?: number;
|
|
1862
|
+
}
|
|
1863
|
+
interface GetRefundabilityStatusRequest {
|
|
1864
|
+
/**
|
|
1865
|
+
* Order ID.
|
|
1866
|
+
* @minLength 1
|
|
1867
|
+
* @maxLength 100
|
|
1868
|
+
*/
|
|
1869
|
+
ecomOrderId: string;
|
|
1870
|
+
}
|
|
1871
|
+
interface GetRefundabilityStatusResponse {
|
|
1872
|
+
/**
|
|
1873
|
+
* Refundability details.
|
|
1874
|
+
* @maxSize 300
|
|
1875
|
+
*/
|
|
1876
|
+
refundabilities?: Refundability[];
|
|
1877
|
+
/**
|
|
1878
|
+
* Whether the order supports refunding per item.
|
|
1879
|
+
* @deprecated
|
|
1880
|
+
*/
|
|
1881
|
+
refundablePerItem?: boolean;
|
|
1882
|
+
}
|
|
1883
|
+
interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
1884
|
+
/** Reason why payment is not refundable. */
|
|
1885
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
1886
|
+
/** Reason why payment is only refundable manually. */
|
|
1887
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
1888
|
+
/** Payment ID. */
|
|
1889
|
+
paymentId?: string;
|
|
1890
|
+
/** Payment refundability status. */
|
|
1891
|
+
refundabilityStatus?: RefundableStatusWithLiterals;
|
|
1892
|
+
/** Link to payment provider dashboard. */
|
|
1893
|
+
providerLink?: string | null;
|
|
1894
|
+
}
|
|
1895
|
+
/** @oneof */
|
|
1896
|
+
interface RefundabilityAdditionalRefundabilityInfoOneOf {
|
|
1897
|
+
/** Reason why payment is not refundable. */
|
|
1898
|
+
nonRefundableReason?: NonRefundableReasonWithLiterals;
|
|
1899
|
+
/** Reason why payment is only refundable manually. */
|
|
1900
|
+
manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
|
|
1901
|
+
}
|
|
1902
|
+
declare enum RefundableStatus {
|
|
1903
|
+
NOT_REFUNDABLE = "NOT_REFUNDABLE",
|
|
1904
|
+
MANUAL = "MANUAL",
|
|
1905
|
+
REFUNDABLE = "REFUNDABLE"
|
|
1906
|
+
}
|
|
1907
|
+
/** @enumType */
|
|
1908
|
+
type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
|
|
1909
|
+
declare enum NonRefundableReason {
|
|
1910
|
+
NONE = "NONE",
|
|
1911
|
+
ALREADY_REFUNDED = "ALREADY_REFUNDED",
|
|
1912
|
+
PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
|
|
1913
|
+
INTERNAL_ERROR = "INTERNAL_ERROR",
|
|
1914
|
+
NOT_PAID = "NOT_PAID",
|
|
1915
|
+
ACCESS_DENIED = "ACCESS_DENIED",
|
|
1916
|
+
ZERO_PRICE = "ZERO_PRICE",
|
|
1917
|
+
DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
|
|
1918
|
+
PENDING_REFUND = "PENDING_REFUND",
|
|
1919
|
+
FORBIDDEN = "FORBIDDEN",
|
|
1920
|
+
TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
|
|
1921
|
+
ORDER_IS_PENDING = "ORDER_IS_PENDING",
|
|
1922
|
+
ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
|
|
1923
|
+
}
|
|
1924
|
+
/** @enumType */
|
|
1925
|
+
type NonRefundableReasonWithLiterals = NonRefundableReason | 'NONE' | 'ALREADY_REFUNDED' | 'PROVIDER_IS_DOWN' | 'INTERNAL_ERROR' | 'NOT_PAID' | 'ACCESS_DENIED' | 'ZERO_PRICE' | 'DISABLED_BY_PROVIDER' | 'PENDING_REFUND' | 'FORBIDDEN' | 'TRANSACTION_NOT_FOUND' | 'ORDER_IS_PENDING' | 'ORDER_IS_REJECTED';
|
|
1926
|
+
declare enum ManuallyRefundableReason {
|
|
1927
|
+
EXPIRED = "EXPIRED",
|
|
1928
|
+
NOT_SUPPORTED = "NOT_SUPPORTED",
|
|
1929
|
+
OFFLINE = "OFFLINE",
|
|
1930
|
+
REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
|
|
1931
|
+
}
|
|
1932
|
+
/** @enumType */
|
|
1933
|
+
type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
|
|
1934
|
+
interface CreatePaymentGatewayOrderRequest {
|
|
1935
|
+
/**
|
|
1936
|
+
* Ecom order ID.
|
|
1937
|
+
* @minLength 1
|
|
1938
|
+
* @maxLength 100
|
|
1939
|
+
*/
|
|
1940
|
+
ecomOrderId: string;
|
|
1941
|
+
/** Information about the user who initiated the payment. */
|
|
1942
|
+
chargedBy?: ChargedBy;
|
|
1943
|
+
}
|
|
1944
|
+
interface ChargedBy {
|
|
1945
|
+
/**
|
|
1946
|
+
* ID - id of the user who initiated the payment
|
|
1947
|
+
* @format GUID
|
|
1948
|
+
*/
|
|
1949
|
+
id?: string;
|
|
1950
|
+
/**
|
|
1951
|
+
* Full name - name of the user who initiated the payment
|
|
1952
|
+
* @minLength 1
|
|
1953
|
+
* @maxLength 200
|
|
1954
|
+
*/
|
|
1955
|
+
fullName?: string | null;
|
|
1956
|
+
}
|
|
1957
|
+
interface CreatePaymentGatewayOrderResponse {
|
|
1958
|
+
/** ID of the order created in the payment gateway */
|
|
1959
|
+
paymentGatewayOrderId?: string;
|
|
1960
|
+
}
|
|
1961
|
+
interface ChargeMembershipsRequest {
|
|
1962
|
+
/**
|
|
1963
|
+
* Order ID.
|
|
1964
|
+
* @minLength 1
|
|
1965
|
+
* @maxLength 100
|
|
1966
|
+
*/
|
|
1967
|
+
ecomOrderId: string;
|
|
1968
|
+
/**
|
|
1969
|
+
* The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
1970
|
+
* but a user which is using the membership on behalf of the a member
|
|
1971
|
+
* @format GUID
|
|
1972
|
+
*/
|
|
1973
|
+
memberId: string;
|
|
1974
|
+
/**
|
|
1975
|
+
* List of items to be paid by memberships
|
|
1976
|
+
* @minSize 1
|
|
1977
|
+
* @maxSize 300
|
|
1978
|
+
*/
|
|
1979
|
+
membershipCharges?: MembershipChargeItem[];
|
|
1980
|
+
}
|
|
1981
|
+
interface MembershipChargeItem {
|
|
1982
|
+
/**
|
|
1983
|
+
* The id of used membership
|
|
1984
|
+
* @minLength 1
|
|
1985
|
+
* @maxLength 100
|
|
1986
|
+
*/
|
|
1987
|
+
membershipId?: string;
|
|
1988
|
+
/**
|
|
1989
|
+
* ID of the application providing this payment option
|
|
1990
|
+
* @format GUID
|
|
1991
|
+
*/
|
|
1992
|
+
appId?: string;
|
|
1993
|
+
/** The name of used membership */
|
|
1994
|
+
membershipName?: MembershipName;
|
|
1995
|
+
/** Additional data about this membership */
|
|
1996
|
+
membershipAdditionalData?: Record<string, any> | null;
|
|
1997
|
+
/** Catalog and item reference info. */
|
|
1998
|
+
catalogReference?: CatalogReference;
|
|
1999
|
+
/** Properties of the service. When relevant, contains information such as date and number of participants. */
|
|
2000
|
+
serviceProperties?: ServiceProperties;
|
|
2001
|
+
/**
|
|
2002
|
+
* Usually would be the same as catalogReference.catalogItemId
|
|
2003
|
+
* For cases when these are not the same, this field would return the actual id of the item in the catalog
|
|
2004
|
+
* For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
|
|
2005
|
+
* @minLength 1
|
|
2006
|
+
* @maxLength 36
|
|
2007
|
+
*/
|
|
2008
|
+
rootCatalogItemId?: string | null;
|
|
2009
|
+
/**
|
|
2010
|
+
* line item id of Checkout/Order line item
|
|
2011
|
+
* @minLength 1
|
|
2012
|
+
* @maxLength 100
|
|
2013
|
+
*/
|
|
2014
|
+
lineItemId?: string;
|
|
2015
|
+
}
|
|
2016
|
+
interface MembershipName {
|
|
2017
|
+
/**
|
|
2018
|
+
* Membership name.
|
|
2019
|
+
* @maxLength 100
|
|
2020
|
+
*/
|
|
2021
|
+
original?: string;
|
|
2022
|
+
/**
|
|
2023
|
+
* Translated membership name. Defaults to `original` when not provided.
|
|
2024
|
+
* @maxLength 100
|
|
2025
|
+
*/
|
|
2026
|
+
translated?: string | null;
|
|
2027
|
+
}
|
|
2028
|
+
interface ServiceProperties {
|
|
2029
|
+
/**
|
|
2030
|
+
* Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2031
|
+
* For example, the start time of a class.
|
|
2032
|
+
*/
|
|
2033
|
+
scheduledDate?: Date | null;
|
|
2034
|
+
/**
|
|
2035
|
+
* The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
|
|
2036
|
+
* @min 1
|
|
2037
|
+
* @max 10000
|
|
2038
|
+
*/
|
|
2039
|
+
numberOfParticipants?: number | null;
|
|
2040
|
+
}
|
|
2041
|
+
interface ChargeMembershipsResponse {
|
|
2042
|
+
}
|
|
2043
|
+
interface TriggerRefundRequest {
|
|
2044
|
+
/**
|
|
2045
|
+
* The order this refund related to
|
|
2046
|
+
* @minLength 1
|
|
2047
|
+
* @maxLength 100
|
|
2048
|
+
*/
|
|
2049
|
+
ecomOrderId: string;
|
|
2050
|
+
/**
|
|
2051
|
+
* Refund operations information
|
|
2052
|
+
* @minSize 1
|
|
2053
|
+
* @maxSize 1
|
|
2054
|
+
*/
|
|
2055
|
+
payments: PaymentRefund[];
|
|
2056
|
+
/** Business model of a refund */
|
|
2057
|
+
details?: RefundDetails;
|
|
2058
|
+
/** Side effect details related to refund */
|
|
2059
|
+
sideEffects?: RefundSideEffects;
|
|
2060
|
+
}
|
|
2061
|
+
interface PaymentRefund {
|
|
2062
|
+
/**
|
|
2063
|
+
* Specific payment within the order to refund
|
|
2064
|
+
* @format GUID
|
|
2065
|
+
*/
|
|
2066
|
+
paymentId?: string;
|
|
2067
|
+
/** Refund amount. Not relevant for membership and gift card refunds. */
|
|
2068
|
+
amount?: Price;
|
|
2069
|
+
/**
|
|
2070
|
+
* Whether refund is made externally and manually (on the payment provider's side)
|
|
2071
|
+
* When false (default), the payment gateway will be called in order to make an actual refund, and then the payment will be marked as refunded.
|
|
2072
|
+
* When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
|
|
2073
|
+
*/
|
|
2074
|
+
externalRefund?: boolean;
|
|
2075
|
+
}
|
|
2076
|
+
/** Business model of a refund request */
|
|
2077
|
+
interface RefundDetails {
|
|
2078
|
+
/**
|
|
2079
|
+
* Order line item IDs and quantities that were refunded.
|
|
2080
|
+
* @maxSize 300
|
|
2081
|
+
*/
|
|
2082
|
+
items?: RefundItem[];
|
|
2083
|
+
/** Whether the shipping fee was also refunded. */
|
|
2084
|
+
shippingIncluded?: boolean;
|
|
2085
|
+
/**
|
|
2086
|
+
* Reason for the refund, provided by customer (optional).
|
|
2087
|
+
* @maxLength 200
|
|
2088
|
+
*/
|
|
2089
|
+
reason?: string | null;
|
|
2090
|
+
/**
|
|
2091
|
+
* Line items that were refunded.
|
|
2092
|
+
* @maxSize 300
|
|
2093
|
+
*/
|
|
2094
|
+
lineItems?: LineItemRefund[];
|
|
2095
|
+
/**
|
|
2096
|
+
* Additional fees that were refunded.
|
|
2097
|
+
* @maxSize 100
|
|
2098
|
+
*/
|
|
2099
|
+
additionalFees?: AdditionalFeeRefund[];
|
|
2100
|
+
/** Shipping amount that was refunded. */
|
|
2101
|
+
shipping?: ShippingRefund;
|
|
2102
|
+
}
|
|
2103
|
+
interface RefundItem {
|
|
2104
|
+
/**
|
|
2105
|
+
* Line item ID the refunded line item.
|
|
2106
|
+
* @format GUID
|
|
2107
|
+
*/
|
|
2108
|
+
lineItemId?: string;
|
|
2109
|
+
/**
|
|
2110
|
+
* Line item quantity refunded.
|
|
2111
|
+
* @min 1
|
|
2112
|
+
* @max 100000
|
|
2113
|
+
*/
|
|
2114
|
+
quantity?: number;
|
|
2115
|
+
}
|
|
2116
|
+
interface LineItemRefund {
|
|
2117
|
+
/**
|
|
2118
|
+
* Line item ID.
|
|
2119
|
+
* @format GUID
|
|
2120
|
+
* @immutable
|
|
2121
|
+
*/
|
|
2122
|
+
lineItemId?: string;
|
|
2123
|
+
/**
|
|
2124
|
+
* Refund quantity.
|
|
2125
|
+
* @min 1
|
|
2126
|
+
* @max 100000
|
|
2127
|
+
* @immutable
|
|
2128
|
+
*/
|
|
2129
|
+
quantity?: number;
|
|
2130
|
+
}
|
|
2131
|
+
interface AdditionalFeeRefund {
|
|
2132
|
+
/**
|
|
2133
|
+
* Additional fee ID.
|
|
2134
|
+
* @format GUID
|
|
2135
|
+
* @immutable
|
|
2136
|
+
*/
|
|
2137
|
+
additionalFeeId?: string;
|
|
2138
|
+
/**
|
|
2139
|
+
* Refund amount.
|
|
2140
|
+
* @immutable
|
|
2141
|
+
*/
|
|
2142
|
+
amount?: Price;
|
|
2143
|
+
}
|
|
2144
|
+
interface ShippingRefund {
|
|
2145
|
+
/**
|
|
2146
|
+
* Refund amount.
|
|
2147
|
+
* @immutable
|
|
2148
|
+
*/
|
|
2149
|
+
amount?: Price;
|
|
2150
|
+
}
|
|
2151
|
+
interface RefundSideEffects {
|
|
2152
|
+
/** Inventory restock details as part of this refund. */
|
|
2153
|
+
restockInfo?: RestockInfo;
|
|
2154
|
+
/** Whether to send a refund confirmation email to the customer. */
|
|
2155
|
+
sendOrderRefundedEmail?: boolean;
|
|
2156
|
+
/**
|
|
2157
|
+
* Custom message added to the refund confirmation email.
|
|
2158
|
+
* @minLength 1
|
|
2159
|
+
* @maxLength 1000
|
|
2160
|
+
*/
|
|
2161
|
+
customMessage?: string | null;
|
|
2162
|
+
}
|
|
2163
|
+
interface RestockInfo {
|
|
2164
|
+
/** Restock type. */
|
|
2165
|
+
type?: RestockTypeWithLiterals;
|
|
2166
|
+
/**
|
|
2167
|
+
* Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
|
|
2168
|
+
* @maxSize 300
|
|
2169
|
+
*/
|
|
2170
|
+
items?: RestockItem[];
|
|
2171
|
+
}
|
|
2172
|
+
declare enum RestockType {
|
|
2173
|
+
NO_ITEMS = "NO_ITEMS",
|
|
2174
|
+
ALL_ITEMS = "ALL_ITEMS",
|
|
2175
|
+
SOME_ITEMS = "SOME_ITEMS"
|
|
2176
|
+
}
|
|
2177
|
+
/** @enumType */
|
|
2178
|
+
type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
|
|
2179
|
+
interface RestockItem {
|
|
2180
|
+
/**
|
|
2181
|
+
* ID of the line item being restocked.
|
|
2182
|
+
* @format GUID
|
|
2183
|
+
*/
|
|
2184
|
+
lineItemId?: string;
|
|
2185
|
+
/**
|
|
2186
|
+
* Line item quantity being restocked.
|
|
2187
|
+
* @min 1
|
|
2188
|
+
* @max 100000
|
|
2189
|
+
*/
|
|
2190
|
+
quantity?: number;
|
|
2191
|
+
}
|
|
2192
|
+
interface TriggerRefundResponse {
|
|
2193
|
+
/** All order's transactions after the refunds were added */
|
|
2194
|
+
orderTransactions?: OrderTransactions;
|
|
2195
|
+
/** Created refund ID */
|
|
2196
|
+
refundId?: string | null;
|
|
2197
|
+
/** Payment ID's that the refund execution had failed for */
|
|
2198
|
+
failedPaymentIds?: ItemMetadata[];
|
|
2199
|
+
}
|
|
2200
|
+
interface OrderTransactions {
|
|
2201
|
+
/**
|
|
2202
|
+
* Order ID.
|
|
2203
|
+
* @format GUID
|
|
2204
|
+
*/
|
|
2205
|
+
orderId?: string;
|
|
2206
|
+
/**
|
|
2207
|
+
* Record of payments made to the merchant.
|
|
2208
|
+
* @maxSize 100
|
|
2209
|
+
*/
|
|
2210
|
+
payments?: Payment[];
|
|
2211
|
+
/**
|
|
2212
|
+
* Record of refunds made to the buyer.
|
|
2213
|
+
* @maxSize 300
|
|
2214
|
+
*/
|
|
2215
|
+
refunds?: Refund[];
|
|
2216
|
+
}
|
|
2217
|
+
interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
|
|
2218
|
+
/** Regular payment details. */
|
|
2219
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
2220
|
+
/** Gift card payment details. */
|
|
2221
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2222
|
+
/**
|
|
2223
|
+
* Payment ID.
|
|
2224
|
+
* @format GUID
|
|
2225
|
+
* @readonly
|
|
2226
|
+
*/
|
|
2227
|
+
id?: string | null;
|
|
2228
|
+
/** Date and time the payment was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided. */
|
|
2229
|
+
createdDate?: Date | null;
|
|
2230
|
+
/**
|
|
2231
|
+
* Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
|
|
2232
|
+
* @readonly
|
|
2233
|
+
*/
|
|
2234
|
+
updatedDate?: Date | null;
|
|
2235
|
+
/** Payment amount. */
|
|
2236
|
+
amount?: Price;
|
|
2237
|
+
/**
|
|
2238
|
+
* Whether refunds for this payment are disabled.
|
|
2239
|
+
* + `true`: This payment is not refundable.
|
|
2240
|
+
* + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
|
|
2241
|
+
*/
|
|
2242
|
+
refundDisabled?: boolean;
|
|
2243
|
+
}
|
|
2244
|
+
/** @oneof */
|
|
2245
|
+
interface PaymentPaymentDetailsOneOf {
|
|
2246
|
+
/** Regular payment details. */
|
|
2247
|
+
regularPaymentDetails?: RegularPaymentDetails;
|
|
2248
|
+
/** Gift card payment details. */
|
|
2249
|
+
giftcardPaymentDetails?: GiftCardPaymentDetails;
|
|
2250
|
+
}
|
|
2251
|
+
/** @oneof */
|
|
2252
|
+
interface PaymentReceiptInfoOneOf {
|
|
2253
|
+
}
|
|
2254
|
+
interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2255
|
+
/** Whether regular card used */
|
|
2256
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2257
|
+
/**
|
|
2258
|
+
* Wix Payments order ID.
|
|
2259
|
+
* @maxLength 100
|
|
2260
|
+
*/
|
|
2261
|
+
paymentOrderId?: string | null;
|
|
2262
|
+
/**
|
|
2263
|
+
* Payment gateway's transaction ID.
|
|
2264
|
+
* This field is only returned when the value of `offline_payment` is `false`.
|
|
2265
|
+
* @maxLength 100
|
|
2266
|
+
*/
|
|
2267
|
+
gatewayTransactionId?: string | null;
|
|
2268
|
+
/**
|
|
2269
|
+
* Payment method. Non-exhaustive list of supported values:
|
|
2270
|
+
* + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
|
|
2271
|
+
* @maxLength 100
|
|
2272
|
+
*/
|
|
2273
|
+
paymentMethod?: string | null;
|
|
2274
|
+
/**
|
|
2275
|
+
* Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
|
|
2276
|
+
* @maxLength 100
|
|
2277
|
+
*/
|
|
2278
|
+
providerTransactionId?: string | null;
|
|
2279
|
+
/** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
|
|
2280
|
+
offlinePayment?: boolean;
|
|
2281
|
+
/** Payment status. */
|
|
2282
|
+
status?: TransactionStatusWithLiterals;
|
|
2283
|
+
/**
|
|
2284
|
+
* Whether there is a payment agreement that allows for future charges.
|
|
2285
|
+
* @immutable
|
|
2286
|
+
*/
|
|
2287
|
+
savedPaymentMethod?: boolean;
|
|
2288
|
+
/** Authorization details. */
|
|
2289
|
+
authorizationDetails?: AuthorizationDetails;
|
|
2290
|
+
}
|
|
2291
|
+
/** @oneof */
|
|
2292
|
+
interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
|
|
2293
|
+
/** Whether regular card used */
|
|
2294
|
+
creditCardDetails?: CreditCardPaymentMethodDetails;
|
|
2295
|
+
}
|
|
2296
|
+
declare enum TransactionStatus {
|
|
2297
|
+
UNDEFINED = "UNDEFINED",
|
|
2298
|
+
APPROVED = "APPROVED",
|
|
2299
|
+
PENDING = "PENDING",
|
|
2300
|
+
PENDING_MERCHANT = "PENDING_MERCHANT",
|
|
2301
|
+
CANCELED = "CANCELED",
|
|
2302
|
+
DECLINED = "DECLINED",
|
|
2303
|
+
REFUNDED = "REFUNDED",
|
|
2304
|
+
PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
|
|
2305
|
+
AUTHORIZED = "AUTHORIZED",
|
|
2306
|
+
VOIDED = "VOIDED"
|
|
2307
|
+
}
|
|
2308
|
+
/** @enumType */
|
|
2309
|
+
type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
|
|
2310
|
+
interface CreditCardPaymentMethodDetails {
|
|
2311
|
+
/**
|
|
2312
|
+
* The last 4 digits of the card number.
|
|
2313
|
+
* @maxLength 4
|
|
2314
|
+
*/
|
|
2315
|
+
lastFourDigits?: string | null;
|
|
2316
|
+
/**
|
|
2317
|
+
* Card issuer's brand.
|
|
2318
|
+
* @maxLength 100
|
|
2319
|
+
*/
|
|
2320
|
+
brand?: string | null;
|
|
2321
|
+
}
|
|
2322
|
+
interface AuthorizationDetails {
|
|
2323
|
+
/**
|
|
2324
|
+
* Whether the authorized payment is of a delayed capture.
|
|
2325
|
+
* @readonly
|
|
2326
|
+
*/
|
|
2327
|
+
delayedCapture?: boolean;
|
|
2328
|
+
/** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2329
|
+
authorizedDate?: Date | null;
|
|
2330
|
+
/**
|
|
2331
|
+
* List of captures associated with payment
|
|
2332
|
+
* In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
|
|
2333
|
+
* @maxSize 1
|
|
2334
|
+
*/
|
|
2335
|
+
captures?: AuthorizationCapture[];
|
|
2336
|
+
/** Void associated with payment */
|
|
2337
|
+
void?: AuthorizationVoid;
|
|
2338
|
+
/** Scheduled action for this transaction */
|
|
2339
|
+
scheduledAction?: V1ScheduledAction;
|
|
2340
|
+
}
|
|
2341
|
+
interface AuthorizationCapture {
|
|
2342
|
+
/**
|
|
2343
|
+
* Capture ID.
|
|
2344
|
+
* @format GUID
|
|
2345
|
+
* @readonly
|
|
2346
|
+
*/
|
|
2347
|
+
id?: string | null;
|
|
2348
|
+
/** Status of this capture action */
|
|
2349
|
+
status?: AuthorizationCaptureStatusWithLiterals;
|
|
2350
|
+
/**
|
|
2351
|
+
* Amount of this capture
|
|
2352
|
+
* @immutable
|
|
2353
|
+
*/
|
|
2354
|
+
amount?: Price;
|
|
2355
|
+
/** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2356
|
+
createdDate?: Date | null;
|
|
2357
|
+
/** In case of status is FAILED may contain failure details */
|
|
2358
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
2359
|
+
}
|
|
2360
|
+
declare enum AuthorizationCaptureStatus {
|
|
2361
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2362
|
+
/** Capture operation still in progress. */
|
|
2363
|
+
PENDING = "PENDING",
|
|
2364
|
+
/** Capture operation succeeded. */
|
|
2365
|
+
SUCCEEDED = "SUCCEEDED",
|
|
2366
|
+
/** Capture operation failed. */
|
|
2367
|
+
FAILED = "FAILED"
|
|
2368
|
+
}
|
|
2369
|
+
/** @enumType */
|
|
2370
|
+
type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
2371
|
+
interface AuthorizationActionFailureDetails {
|
|
2372
|
+
/** @maxLength 100 */
|
|
2373
|
+
failureCode?: string;
|
|
2374
|
+
}
|
|
2375
|
+
interface AuthorizationVoid {
|
|
2376
|
+
/** Status of this void action */
|
|
2377
|
+
status?: AuthorizationVoidStatusWithLiterals;
|
|
2378
|
+
/** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
|
|
2379
|
+
voidedDate?: Date | null;
|
|
2380
|
+
/** In case of status is FAILED may contain failure details */
|
|
2381
|
+
failureDetails?: AuthorizationActionFailureDetails;
|
|
2382
|
+
/** Reason of void action */
|
|
2383
|
+
reason?: ReasonWithLiterals;
|
|
2384
|
+
}
|
|
2385
|
+
declare enum AuthorizationVoidStatus {
|
|
2386
|
+
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
2387
|
+
/** Void operation still in progress. */
|
|
2388
|
+
PENDING = "PENDING",
|
|
2389
|
+
/** Void operation succeeded. */
|
|
2390
|
+
SUCCEEDED = "SUCCEEDED",
|
|
2391
|
+
/** Void operation failed. */
|
|
2392
|
+
FAILED = "FAILED"
|
|
2393
|
+
}
|
|
2394
|
+
/** @enumType */
|
|
2395
|
+
type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'UNKNOWN_STATUS' | 'PENDING' | 'SUCCEEDED' | 'FAILED';
|
|
2396
|
+
/** Reason the authorization was voided. */
|
|
2397
|
+
declare enum Reason {
|
|
2398
|
+
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
2399
|
+
/** Authorization was voided by user. */
|
|
2400
|
+
MANUAL = "MANUAL",
|
|
2401
|
+
/** Authorization passed execution date. */
|
|
2402
|
+
SCHEDULED = "SCHEDULED"
|
|
2403
|
+
}
|
|
2404
|
+
/** @enumType */
|
|
2405
|
+
type ReasonWithLiterals = Reason | 'UNKNOWN_REASON' | 'MANUAL' | 'SCHEDULED';
|
|
2406
|
+
interface V1ScheduledAction {
|
|
2407
|
+
/** Type of the action. */
|
|
2408
|
+
actionType?: ActionTypeWithLiterals;
|
|
2409
|
+
/** The date and time of the action. */
|
|
2410
|
+
executionDate?: Date | null;
|
|
2411
|
+
}
|
|
2412
|
+
declare enum ActionType {
|
|
2413
|
+
UNKNOWN_ACTION_TYPE = "UNKNOWN_ACTION_TYPE",
|
|
2414
|
+
VOID = "VOID",
|
|
2415
|
+
CAPTURE = "CAPTURE"
|
|
2416
|
+
}
|
|
2417
|
+
/** @enumType */
|
|
2418
|
+
type ActionTypeWithLiterals = ActionType | 'UNKNOWN_ACTION_TYPE' | 'VOID' | 'CAPTURE';
|
|
2419
|
+
interface GiftCardPaymentDetails {
|
|
2420
|
+
/**
|
|
2421
|
+
* Gift card payment ID.
|
|
2422
|
+
* @minLength 1
|
|
2423
|
+
* @maxLength 100
|
|
2424
|
+
*/
|
|
2425
|
+
giftCardPaymentId?: string;
|
|
2426
|
+
/**
|
|
2427
|
+
* ID of the app that created the gift card.
|
|
2428
|
+
* @format GUID
|
|
2429
|
+
*/
|
|
2430
|
+
appId?: string;
|
|
2431
|
+
/**
|
|
2432
|
+
* Whether the gift card is voided.
|
|
2433
|
+
* @readonly
|
|
2434
|
+
*/
|
|
2435
|
+
voided?: boolean;
|
|
2436
|
+
}
|
|
2437
|
+
interface Refund {
|
|
2438
|
+
/**
|
|
2439
|
+
* Refund ID.
|
|
2440
|
+
* @format GUID
|
|
2441
|
+
* @readonly
|
|
2442
|
+
*/
|
|
2443
|
+
id?: string;
|
|
2444
|
+
/**
|
|
2445
|
+
* List of transactions.
|
|
2446
|
+
* @maxSize 50
|
|
2447
|
+
*/
|
|
2448
|
+
transactions?: RefundTransaction[];
|
|
2449
|
+
/** Refund business details. */
|
|
2450
|
+
details?: RefundDetails;
|
|
2451
|
+
/**
|
|
2452
|
+
* Date and time the refund was created in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Defaults to current time when not provided.
|
|
2453
|
+
* @readonly
|
|
2454
|
+
* @immutable
|
|
2455
|
+
*/
|
|
2456
|
+
createdDate?: Date | null;
|
|
2457
|
+
/**
|
|
2458
|
+
* Aggregated refund summary.
|
|
2459
|
+
* @readonly
|
|
2460
|
+
*/
|
|
2461
|
+
summary?: AggregatedRefundSummary;
|
|
2462
|
+
/**
|
|
2463
|
+
* ID of the app that initiated this refund.
|
|
2464
|
+
* @format GUID
|
|
2465
|
+
* @readonly
|
|
2466
|
+
* @immutable
|
|
2467
|
+
*/
|
|
2468
|
+
requestingServiceAppId?: string | null;
|
|
2469
|
+
}
|
|
2470
|
+
interface RefundTransaction {
|
|
2471
|
+
/**
|
|
2472
|
+
* ID of the payment associated with this refund.
|
|
2473
|
+
* @format GUID
|
|
2474
|
+
* @immutable
|
|
2475
|
+
*/
|
|
2476
|
+
paymentId?: string;
|
|
2477
|
+
/**
|
|
2478
|
+
* Refund amount.
|
|
2479
|
+
* @immutable
|
|
2480
|
+
*/
|
|
2481
|
+
amount?: Price;
|
|
2482
|
+
/** Refund status. */
|
|
2483
|
+
refundStatus?: RefundStatusWithLiterals;
|
|
2484
|
+
/** Optional details of current refund status. */
|
|
2485
|
+
refundStatusInfo?: RefundStatusInfo;
|
|
2486
|
+
/**
|
|
2487
|
+
* Payment gateway's refund ID.
|
|
2488
|
+
* This field is only returned when the value of `external_refund` is `false`.
|
|
2489
|
+
* @format GUID
|
|
2490
|
+
*/
|
|
2491
|
+
gatewayRefundId?: string | null;
|
|
2492
|
+
/** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
|
|
2493
|
+
providerRefundId?: string | null;
|
|
2494
|
+
/**
|
|
2495
|
+
* Whether refund was made externally and manually on the payment provider's side.
|
|
2496
|
+
* @immutable
|
|
2497
|
+
*/
|
|
2498
|
+
externalRefund?: boolean;
|
|
2499
|
+
}
|
|
2500
|
+
/** Refund transaction status. */
|
|
2501
|
+
declare enum RefundStatus {
|
|
2502
|
+
/** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
|
|
2503
|
+
PENDING = "PENDING",
|
|
2504
|
+
/** Refund transaction succeeded. */
|
|
2505
|
+
SUCCEEDED = "SUCCEEDED",
|
|
2506
|
+
/** Refund transaction failed. */
|
|
2507
|
+
FAILED = "FAILED",
|
|
2508
|
+
/** Refund request acknowledged, and will be executed soon. */
|
|
2509
|
+
SCHEDULED = "SCHEDULED",
|
|
2510
|
+
/** Refund was initiated on payment provider side. */
|
|
2511
|
+
STARTED = "STARTED"
|
|
2512
|
+
}
|
|
2513
|
+
/** @enumType */
|
|
2514
|
+
type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
|
|
2515
|
+
interface RefundStatusInfo {
|
|
2516
|
+
/**
|
|
2517
|
+
* Reason code for the refund's current status.
|
|
2518
|
+
*
|
|
2519
|
+
* Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
|
|
2520
|
+
* @minLength 1
|
|
2521
|
+
* @maxLength 10
|
|
2522
|
+
*/
|
|
2523
|
+
paymentGatewayReasonCode?: string | null;
|
|
2524
|
+
/**
|
|
2525
|
+
* Free text explanation of current refund status.
|
|
2526
|
+
* @minLength 1
|
|
2527
|
+
* @maxLength 1000
|
|
2528
|
+
*/
|
|
2529
|
+
description?: string | null;
|
|
2530
|
+
}
|
|
2531
|
+
interface AggregatedRefundSummary {
|
|
2532
|
+
/** Total amount requested for refund. */
|
|
2533
|
+
requestedRefund?: Price;
|
|
2534
|
+
/** Pending refund amount - the portion of `requestedRefund` that is still pending. */
|
|
2535
|
+
pendingRefund?: Price;
|
|
2536
|
+
/** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
|
|
2537
|
+
refunded?: Price;
|
|
2538
|
+
/** Failed refund amount - the portion of `requestedRefund` that failed. */
|
|
2539
|
+
failedRefundAmount?: Price;
|
|
2540
|
+
/** Whether at least one refund transaction is still in `"PENDING"` status. */
|
|
2541
|
+
pending?: boolean;
|
|
2542
|
+
/** Breakdown of refunded items. Available only after refund is complete. */
|
|
2543
|
+
breakdown?: RefundItemsBreakdown;
|
|
2544
|
+
}
|
|
2545
|
+
interface RefundItemsBreakdown {
|
|
2546
|
+
/**
|
|
2547
|
+
* Refunded line items and the amount refunded for each.
|
|
2548
|
+
* @maxSize 300
|
|
2549
|
+
*/
|
|
2550
|
+
lineItems?: LineItemRefundSummary[];
|
|
2551
|
+
}
|
|
2552
|
+
interface LineItemRefundSummary {
|
|
2553
|
+
/**
|
|
2554
|
+
* ID of the refunded line item.
|
|
2555
|
+
* @format GUID
|
|
2556
|
+
*/
|
|
2557
|
+
lineItemId?: string;
|
|
2558
|
+
/** Total refunded amount for the line item. */
|
|
2559
|
+
totalRefundedAmount?: Price;
|
|
2560
|
+
}
|
|
2561
|
+
interface VoidAuthorizedPaymentsRequest {
|
|
2562
|
+
/**
|
|
2563
|
+
* Wix eCommerce order ID
|
|
2564
|
+
* @minLength 1
|
|
2565
|
+
* @maxLength 100
|
|
2566
|
+
*/
|
|
2567
|
+
ecomOrderId: string;
|
|
2568
|
+
/**
|
|
2569
|
+
* Payment IDs
|
|
2570
|
+
* @minSize 1
|
|
2571
|
+
* @maxSize 100
|
|
2572
|
+
* @format GUID
|
|
2573
|
+
*/
|
|
2574
|
+
paymentIds: string[];
|
|
2575
|
+
}
|
|
2576
|
+
interface VoidAuthorizedPaymentsResponse {
|
|
2577
|
+
/** All order's transactions after the void was triggered */
|
|
2578
|
+
orderTransactions?: OrderTransactions;
|
|
2579
|
+
}
|
|
2580
|
+
interface CaptureAuthorizedPaymentsRequest {
|
|
2581
|
+
/**
|
|
2582
|
+
* Wix eCommerce order ID
|
|
2583
|
+
* @minLength 1
|
|
2584
|
+
* @maxLength 100
|
|
2585
|
+
*/
|
|
2586
|
+
ecomOrderId: string;
|
|
2587
|
+
/**
|
|
2588
|
+
* Capture payments information
|
|
2589
|
+
* @minSize 1
|
|
2590
|
+
* @maxSize 100
|
|
2591
|
+
*/
|
|
2592
|
+
payments: PaymentCapture[];
|
|
2593
|
+
}
|
|
2594
|
+
interface PaymentCapture {
|
|
2595
|
+
/**
|
|
2596
|
+
* Payment ID
|
|
2597
|
+
* @format GUID
|
|
2598
|
+
*/
|
|
2599
|
+
paymentId?: string | null;
|
|
2600
|
+
/**
|
|
2601
|
+
* Capture amount.
|
|
2602
|
+
* If not provided - full authorized amount will be captured.
|
|
2603
|
+
*/
|
|
2604
|
+
amount?: Price;
|
|
2605
|
+
}
|
|
2606
|
+
interface CaptureAuthorizedPaymentsResponse {
|
|
2607
|
+
/** All order's transactions after the capture was triggered */
|
|
2608
|
+
orderTransactions?: OrderTransactions;
|
|
2609
|
+
}
|
|
2610
|
+
interface Sorting {
|
|
2611
|
+
/**
|
|
2612
|
+
* Name of the field to sort by.
|
|
2613
|
+
* @maxLength 512
|
|
2614
|
+
*/
|
|
2615
|
+
fieldName?: string;
|
|
2616
|
+
/** Sort order. */
|
|
2617
|
+
order?: SortOrderWithLiterals;
|
|
2618
|
+
}
|
|
2619
|
+
declare enum SortOrder {
|
|
2620
|
+
ASC = "ASC",
|
|
2621
|
+
DESC = "DESC"
|
|
2622
|
+
}
|
|
2623
|
+
/** @enumType */
|
|
2624
|
+
type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
2625
|
+
interface CursorPaging {
|
|
2626
|
+
/**
|
|
2627
|
+
* Maximum number of items to return in the results.
|
|
2628
|
+
* @max 100
|
|
2629
|
+
*/
|
|
2630
|
+
limit?: number | null;
|
|
2631
|
+
/**
|
|
2632
|
+
* Pointer to the next or previous page in the list of results.
|
|
2633
|
+
*
|
|
2634
|
+
* Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
|
|
2635
|
+
* Not relevant for the first request.
|
|
2636
|
+
* @maxLength 16000
|
|
2637
|
+
*/
|
|
2638
|
+
cursor?: string | null;
|
|
2639
|
+
}
|
|
2640
|
+
interface Cursors {
|
|
2641
|
+
/**
|
|
2642
|
+
* Cursor string pointing to the next page in the list of results.
|
|
2643
|
+
* @maxLength 16000
|
|
2644
|
+
*/
|
|
2645
|
+
next?: string | null;
|
|
2646
|
+
/**
|
|
2647
|
+
* Cursor pointing to the previous page in the list of results.
|
|
2648
|
+
* @maxLength 16000
|
|
2649
|
+
*/
|
|
2650
|
+
prev?: string | null;
|
|
2651
|
+
}
|
|
2652
|
+
interface GetOrderRequest {
|
|
2653
|
+
/**
|
|
2654
|
+
* ID of the order to retrieve.
|
|
2655
|
+
* @minLength 1
|
|
2656
|
+
* @maxLength 100
|
|
2657
|
+
*/
|
|
2658
|
+
id: string;
|
|
2659
|
+
}
|
|
2660
|
+
interface GetOrderResponse {
|
|
2661
|
+
/** The requested order. */
|
|
2662
|
+
order?: Order;
|
|
2663
|
+
}
|
|
2664
|
+
interface SearchOrdersRequest {
|
|
2665
|
+
/** Search options. */
|
|
2666
|
+
search?: CursorSearch;
|
|
2667
|
+
}
|
|
2668
|
+
interface CursorSearch extends CursorSearchPagingMethodOneOf {
|
|
2669
|
+
/**
|
|
2670
|
+
* Cursor paging options.
|
|
2671
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
2672
|
+
*/
|
|
2673
|
+
cursorPaging?: CursorPaging;
|
|
2674
|
+
/**
|
|
2675
|
+
* Filter object.
|
|
2676
|
+
*
|
|
2677
|
+
* For example, the following `filter` object will only return orders with payment statuses of paid and/or partially paid:
|
|
2678
|
+
*
|
|
2679
|
+
* `"filter": {"paymentStatus": {"$in": ["PAID", "PARTIALLY_PAID"]}}`
|
|
2680
|
+
*
|
|
2681
|
+
* Learn more about the [filter format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section).
|
|
2682
|
+
*/
|
|
2683
|
+
filter?: Record<string, any> | null;
|
|
2684
|
+
/**
|
|
2685
|
+
* Array of sort objects that specify the order in which results should be sorted.
|
|
2686
|
+
*
|
|
2687
|
+
* For example, the following `sort` array will sort by `createdDate` in descending order:
|
|
2688
|
+
*
|
|
2689
|
+
* `"sort": [{"fieldName": "createdDate", "order":"DESC"}]`.
|
|
2690
|
+
*
|
|
2691
|
+
* Learn more about the [sort format](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-sort-section).
|
|
2692
|
+
* @maxSize 4
|
|
2693
|
+
*/
|
|
2694
|
+
sort?: Sorting[];
|
|
2695
|
+
}
|
|
2696
|
+
/** @oneof */
|
|
2697
|
+
interface CursorSearchPagingMethodOneOf {
|
|
2698
|
+
/**
|
|
2699
|
+
* Cursor paging options.
|
|
2700
|
+
* Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging).
|
|
2701
|
+
*/
|
|
2702
|
+
cursorPaging?: CursorPaging;
|
|
2703
|
+
}
|
|
2704
|
+
interface SearchOrdersResponse {
|
|
2705
|
+
/** List of orders. */
|
|
2706
|
+
orders?: Order[];
|
|
2707
|
+
/** Details on the paged set of results returned. */
|
|
2708
|
+
metadata?: CursorPagingMetadata;
|
|
2709
|
+
}
|
|
2710
|
+
interface CursorPagingMetadata {
|
|
2711
|
+
/** Number of items returned in current page. */
|
|
2712
|
+
count?: number | null;
|
|
2713
|
+
/** Cursor strings that point to the next page, previous page, or both. */
|
|
2714
|
+
cursors?: Cursors;
|
|
2715
|
+
/**
|
|
2716
|
+
* Whether there are more pages to retrieve following the current page.
|
|
2717
|
+
*
|
|
2718
|
+
* + `true`: Another page of results can be retrieved.
|
|
2719
|
+
* + `false`: This is the last page.
|
|
2720
|
+
*/
|
|
2721
|
+
hasNext?: boolean | null;
|
|
2722
|
+
}
|
|
2723
|
+
interface CreateOrderRequest {
|
|
2724
|
+
/** Order info. */
|
|
2725
|
+
order: Order;
|
|
2726
|
+
/** Determine order lifecycle */
|
|
2727
|
+
settings?: OrderCreationSettings;
|
|
2728
|
+
}
|
|
2729
|
+
interface OrderCreationSettings {
|
|
2730
|
+
/**
|
|
2731
|
+
* Condition for the order to be approved.
|
|
2732
|
+
* Default: `DEFAULT`
|
|
2733
|
+
*/
|
|
2734
|
+
orderApprovalStrategy?: OrderApprovalStrategyWithLiterals;
|
|
2735
|
+
/** Notification settings to be applied on order creation */
|
|
2736
|
+
notifications?: OrderCreateNotifications;
|
|
2737
|
+
}
|
|
2738
|
+
declare enum OrderApprovalStrategy {
|
|
2739
|
+
/** Order is automatically approved when `order.priceSummary.total = 0`, **or** after receiving payment. */
|
|
2740
|
+
DEFAULT = "DEFAULT",
|
|
2741
|
+
/** Order is automatically approved **only** after receiving payment. */
|
|
2742
|
+
PAYMENT_RECEIVED = "PAYMENT_RECEIVED",
|
|
2743
|
+
/** Order is automatically approved when payment method is saved for it. */
|
|
2744
|
+
PAYMENT_METHOD_SAVED = "PAYMENT_METHOD_SAVED"
|
|
2745
|
+
}
|
|
2746
|
+
/** @enumType */
|
|
2747
|
+
type OrderApprovalStrategyWithLiterals = OrderApprovalStrategy | 'DEFAULT' | 'PAYMENT_RECEIVED' | 'PAYMENT_METHOD_SAVED';
|
|
2748
|
+
interface OrderCreateNotifications {
|
|
2749
|
+
/**
|
|
2750
|
+
* Whether to send notification to the buyer.
|
|
2751
|
+
*
|
|
2752
|
+
* Default: `true`
|
|
2753
|
+
*/
|
|
2754
|
+
sendNotificationToBuyer?: boolean | null;
|
|
2755
|
+
/**
|
|
2756
|
+
* Whether to send notifications to the business.
|
|
2757
|
+
*
|
|
2758
|
+
* Default: `true`
|
|
2759
|
+
*/
|
|
2760
|
+
sendNotificationsToBusiness?: boolean | null;
|
|
2761
|
+
}
|
|
2762
|
+
interface CreateOrderResponse {
|
|
2763
|
+
/** Newly created order. */
|
|
2764
|
+
order?: Order;
|
|
2765
|
+
}
|
|
2766
|
+
interface UpdateOrderRequest {
|
|
2767
|
+
/** Order to be updated. */
|
|
2768
|
+
order: Order;
|
|
2769
|
+
}
|
|
2770
|
+
interface UpdateOrderResponse {
|
|
2771
|
+
/** Newly created order. */
|
|
2772
|
+
order?: Order;
|
|
2773
|
+
}
|
|
2774
|
+
interface BulkUpdateOrdersRequest {
|
|
2775
|
+
/**
|
|
2776
|
+
* Orders to update.
|
|
2777
|
+
* @minSize 1
|
|
2778
|
+
* @maxSize 100
|
|
2779
|
+
*/
|
|
2780
|
+
orders: MaskedOrder[];
|
|
2781
|
+
/**
|
|
2782
|
+
* Whether to return the full order entities.
|
|
2783
|
+
*
|
|
2784
|
+
* Default: `false`
|
|
2785
|
+
*/
|
|
2786
|
+
returnEntity?: boolean;
|
|
2787
|
+
}
|
|
2788
|
+
interface MaskedOrder {
|
|
2789
|
+
/** Order to be updated. */
|
|
2790
|
+
order?: Order;
|
|
2791
|
+
}
|
|
2792
|
+
interface BulkUpdateOrdersResponse {
|
|
2793
|
+
/**
|
|
2794
|
+
* Bulk action results.
|
|
2795
|
+
* @minSize 1
|
|
2796
|
+
* @maxSize 100
|
|
2797
|
+
*/
|
|
2798
|
+
results?: BulkOrderResult[];
|
|
2799
|
+
/** Bulk action metadata. */
|
|
2800
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
2801
|
+
}
|
|
2802
|
+
interface CommitDeltasRequest {
|
|
2803
|
+
/** Order id to be updated */
|
|
2804
|
+
id: string;
|
|
2805
|
+
/**
|
|
2806
|
+
* Draft order Id representing this change.
|
|
2807
|
+
* Use this ID to get this specific draft content. call .../v1/draft-orders/{draft_order_id}/get
|
|
2808
|
+
* @format GUID
|
|
2809
|
+
*/
|
|
2810
|
+
draftOrderId?: string;
|
|
2811
|
+
/** Draft order changes to be applied */
|
|
2812
|
+
changes: DraftOrderDiffs;
|
|
2813
|
+
/** Side-effects to happen after order is updated */
|
|
2814
|
+
commitSettings?: DraftOrderCommitSettings;
|
|
2815
|
+
/**
|
|
2816
|
+
* Reason for edit, given by user (optional).
|
|
2817
|
+
* @maxLength 200
|
|
2818
|
+
*/
|
|
2819
|
+
reason?: string | null;
|
|
2820
|
+
}
|
|
2821
|
+
interface DraftOrderDiffs extends DraftOrderDiffsShippingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
2822
|
+
/** Shipping info and selected shipping option details. */
|
|
2823
|
+
changedShippingInfo?: V1ShippingInformation;
|
|
2824
|
+
/** Remove existing shipping info. */
|
|
2825
|
+
shippingInfoRemoved?: boolean;
|
|
2826
|
+
/**
|
|
2827
|
+
* Added/updated/removed order line items.
|
|
2828
|
+
* @maxSize 300
|
|
2829
|
+
*/
|
|
2830
|
+
lineItems?: V1LineItemDelta[];
|
|
2831
|
+
/**
|
|
2832
|
+
* Added/updated/removed discounts.
|
|
2833
|
+
* @maxSize 320
|
|
2834
|
+
*/
|
|
2835
|
+
appliedDiscounts?: AppliedDiscountDelta[];
|
|
2836
|
+
/**
|
|
2837
|
+
* Added/updated/removed additional fee.
|
|
2838
|
+
* @maxSize 100
|
|
2839
|
+
*/
|
|
2840
|
+
additionalFees?: AdditionalFeeDelta[];
|
|
2841
|
+
/**
|
|
2842
|
+
* Deprecated. Use `taxInfo` instead.
|
|
2843
|
+
* This field will be removed on September 30, 2024.
|
|
2844
|
+
* Updated Tax summary. overwrites existing tax summary.
|
|
2845
|
+
* @deprecated Deprecated. Use `taxInfo` instead.
|
|
2846
|
+
* This field will be removed on September 30, 2024.
|
|
2847
|
+
* Updated Tax summary. overwrites existing tax summary.
|
|
2848
|
+
* @replacedBy tax_info
|
|
2849
|
+
* @targetRemovalDate 2024-09-30
|
|
2850
|
+
*/
|
|
2851
|
+
taxSummary?: TaxSummary;
|
|
2852
|
+
/**
|
|
2853
|
+
* Updated order price summary. overwrites existing price summary.
|
|
2854
|
+
* balance will be updated automatically.
|
|
2855
|
+
*/
|
|
2856
|
+
priceSummary?: PriceSummary;
|
|
2857
|
+
}
|
|
2858
|
+
/** @oneof */
|
|
2859
|
+
interface DraftOrderDiffsShippingUpdateInfoOneOf {
|
|
2860
|
+
/** Shipping info and selected shipping option details. */
|
|
2861
|
+
changedShippingInfo?: V1ShippingInformation;
|
|
2862
|
+
/** Remove existing shipping info. */
|
|
2863
|
+
shippingInfoRemoved?: boolean;
|
|
2864
|
+
}
|
|
2865
|
+
/** @oneof */
|
|
2866
|
+
interface DraftOrderDiffsBuyerUpdateInfoOneOf {
|
|
2867
|
+
}
|
|
2868
|
+
/** @oneof */
|
|
2869
|
+
interface DraftOrderDiffsBillingUpdateInfoOneOf {
|
|
2870
|
+
}
|
|
2871
|
+
/** @oneof */
|
|
2872
|
+
interface DraftOrderDiffsRecipientUpdateInfoOneOf {
|
|
2873
|
+
}
|
|
2874
|
+
interface V1LineItemDelta extends V1LineItemDeltaDeltaOneOf {
|
|
2875
|
+
/** The line item was added. */
|
|
2876
|
+
lineItemAdded?: boolean;
|
|
2877
|
+
/** The line item was modified. */
|
|
2878
|
+
changedDetails?: ItemChangedDetails;
|
|
2879
|
+
/** The line item was added. */
|
|
2880
|
+
lineItemRemoved?: boolean;
|
|
2881
|
+
/**
|
|
2882
|
+
* Line item ID.
|
|
2883
|
+
* @format GUID
|
|
2884
|
+
*/
|
|
2885
|
+
lineItemId?: string;
|
|
2886
|
+
lineItem?: OrderLineItemChangedDetails;
|
|
2887
|
+
}
|
|
2888
|
+
/** @oneof */
|
|
2889
|
+
interface V1LineItemDeltaDeltaOneOf {
|
|
2890
|
+
/** The line item was added. */
|
|
2891
|
+
lineItemAdded?: boolean;
|
|
2892
|
+
/** The line item was modified. */
|
|
2893
|
+
changedDetails?: ItemChangedDetails;
|
|
2894
|
+
/** The line item was added. */
|
|
2895
|
+
lineItemRemoved?: boolean;
|
|
2896
|
+
}
|
|
2897
|
+
interface OrderLineItemChangedDetails {
|
|
2898
|
+
/**
|
|
2899
|
+
* Item name.
|
|
2900
|
+
* + Stores - `product.name`
|
|
2901
|
+
* + Bookings - `service.info.name`
|
|
2902
|
+
* + Events - `ticket.name`
|
|
2903
|
+
*/
|
|
2904
|
+
productName?: ProductName;
|
|
2905
|
+
/**
|
|
2906
|
+
* References to the line item's origin catalog.
|
|
2907
|
+
* This field may be empty in the case of a custom line item.
|
|
2908
|
+
*/
|
|
2909
|
+
catalogReference?: CatalogReference;
|
|
2910
|
+
/**
|
|
2911
|
+
* Line item quantity.
|
|
2912
|
+
* @min 1
|
|
2913
|
+
* @max 100000
|
|
2914
|
+
*/
|
|
2915
|
+
quantity?: number;
|
|
2916
|
+
/** Total discount for this line item's entire quantity. */
|
|
2917
|
+
totalDiscount?: Price;
|
|
2918
|
+
/**
|
|
2919
|
+
* Line item description lines. Used for display purposes for the cart, checkout and order.
|
|
2920
|
+
* @maxSize 20
|
|
2921
|
+
*/
|
|
2922
|
+
descriptionLines?: DescriptionLine[];
|
|
2923
|
+
/** Line item image. */
|
|
2924
|
+
image?: Image;
|
|
2925
|
+
/** Physical properties of the item. When relevant, contains information such as SKU and item weight. */
|
|
2926
|
+
physicalProperties?: PhysicalProperties;
|
|
2927
|
+
/** Item type. Either a preset type or custom. */
|
|
2928
|
+
itemType?: ItemType;
|
|
2929
|
+
/**
|
|
2930
|
+
* Fulfiller ID. Field is empty when the line item is self-fulfilled.
|
|
2931
|
+
* To get fulfillment information, pass this order's ID to [List Fulfillments For Single Order](https://bo.wix.com/wix-docs/rest/ecommerce/order-fulfillments/list-fulfillments-for-single-order).
|
|
2932
|
+
* @format GUID
|
|
2933
|
+
*/
|
|
2934
|
+
fulfillerId?: string | null;
|
|
2935
|
+
/** Line item price after line item discounts for display purposes. */
|
|
2936
|
+
price?: Price;
|
|
2937
|
+
/** Line item price before line item discounts for display purposes. Defaults to `price` when not provided. */
|
|
2938
|
+
priceBeforeDiscounts?: Price;
|
|
2939
|
+
/** Total price after all discounts and tax. */
|
|
2940
|
+
totalPriceAfterTax?: Price;
|
|
2941
|
+
/**
|
|
2942
|
+
* Type of selected payment option for current item. Defaults to `FULL_PAYMENT_ONLINE`.
|
|
2943
|
+
* + `FULL_PAYMENT_OFFLINE` - The entire payment for this item happens after the checkout. For example, when using cash, check, or other offline payment methods.
|
|
2944
|
+
* + `MEMBERSHIP` - Payment for this item is done by charging a membership. When this option is used, `lineItem.price.amount` is 0.
|
|
2945
|
+
*/
|
|
2946
|
+
paymentOption?: DeltaPaymentOptionTypeWithLiterals;
|
|
2947
|
+
/**
|
|
2948
|
+
* Deprecated. Use `taxInfo` instead.
|
|
2949
|
+
* This field will be removed on September 30, 2024.
|
|
2950
|
+
* Tax details for this line item.
|
|
2951
|
+
* @deprecated Deprecated. Use `taxInfo` instead.
|
|
2952
|
+
* This field will be removed on September 30, 2024.
|
|
2953
|
+
* Tax details for this line item.
|
|
2954
|
+
* @replacedBy tax_info
|
|
2955
|
+
* @targetRemovalDate 2024-09-30
|
|
2956
|
+
*/
|
|
2957
|
+
taxDetails?: ItemTaxFullDetails;
|
|
2958
|
+
/** Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67". */
|
|
2959
|
+
priceDescription?: PriceDescription;
|
|
2960
|
+
/** Total price **after** catalog-defined discount and line item discounts. */
|
|
2961
|
+
lineItemPrice?: Price;
|
|
2962
|
+
/** Total price after all discounts excluding tax. */
|
|
2963
|
+
totalPriceBeforeTax?: Price;
|
|
2964
|
+
/**
|
|
2965
|
+
* Line item locations.
|
|
2966
|
+
*
|
|
2967
|
+
* The location's total quantity must not exceed the line item quantity.
|
|
2968
|
+
* @maxSize 5
|
|
2969
|
+
*/
|
|
2970
|
+
locations?: LocationAndQuantity[];
|
|
2971
|
+
/** Subscription info. */
|
|
2972
|
+
subscriptionInfo?: SubscriptionInfo;
|
|
2973
|
+
}
|
|
2974
|
+
/** Type of selected payment option for catalog item */
|
|
2975
|
+
declare enum DeltaPaymentOptionType {
|
|
2976
|
+
/** Irrelevant */
|
|
2977
|
+
UNKNOWN_PAYMENT_OPTION = "UNKNOWN_PAYMENT_OPTION",
|
|
2978
|
+
/** The entire payment for the given item will happen after checkout. */
|
|
2979
|
+
FULL_PAYMENT_OFFLINE = "FULL_PAYMENT_OFFLINE",
|
|
2980
|
+
/**
|
|
2981
|
+
* Payment for this item can only be done using a membership and must be manually redeemed in the dashboard by the site owner.
|
|
2982
|
+
* Note: when this option is used, the price will be 0.
|
|
2983
|
+
*/
|
|
2984
|
+
MEMBERSHIP_OFFLINE = "MEMBERSHIP_OFFLINE"
|
|
2985
|
+
}
|
|
2986
|
+
/** @enumType */
|
|
2987
|
+
type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'UNKNOWN_PAYMENT_OPTION' | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
|
|
2988
|
+
interface ItemChangedDetails {
|
|
2989
|
+
/**
|
|
2990
|
+
* The quantity before the change.
|
|
2991
|
+
* @min 1
|
|
2992
|
+
* @max 1000000
|
|
2993
|
+
*/
|
|
2994
|
+
quantityBeforeChange?: number | null;
|
|
2995
|
+
/** The price before the change. */
|
|
2996
|
+
priceBeforeChange?: Price;
|
|
2997
|
+
/** The price description before the change */
|
|
2998
|
+
priceDescriptionBeforeChange?: PriceDescription;
|
|
2999
|
+
}
|
|
3000
|
+
interface AppliedDiscountDelta extends AppliedDiscountDeltaDeltaOneOf {
|
|
3001
|
+
editedDiscount?: AppliedDiscount;
|
|
3002
|
+
discountRemoved?: boolean;
|
|
3003
|
+
/**
|
|
3004
|
+
* Discount id.
|
|
3005
|
+
* @format GUID
|
|
3006
|
+
*/
|
|
3007
|
+
discountId?: string;
|
|
3008
|
+
}
|
|
3009
|
+
/** @oneof */
|
|
3010
|
+
interface AppliedDiscountDeltaDeltaOneOf {
|
|
3011
|
+
editedDiscount?: AppliedDiscount;
|
|
3012
|
+
discountRemoved?: boolean;
|
|
3013
|
+
}
|
|
3014
|
+
interface AdditionalFeeDelta extends AdditionalFeeDeltaDeltaOneOf {
|
|
3015
|
+
editedAdditionalFee?: AdditionalFee;
|
|
3016
|
+
additionalFeeRemoved?: boolean;
|
|
3017
|
+
/**
|
|
3018
|
+
* Additional fee id.
|
|
3019
|
+
* @format GUID
|
|
3020
|
+
*/
|
|
3021
|
+
additionalFeeId?: string;
|
|
3022
|
+
}
|
|
3023
|
+
/** @oneof */
|
|
3024
|
+
interface AdditionalFeeDeltaDeltaOneOf {
|
|
3025
|
+
editedAdditionalFee?: AdditionalFee;
|
|
3026
|
+
additionalFeeRemoved?: boolean;
|
|
3027
|
+
}
|
|
3028
|
+
interface DraftOrderCommitSettings {
|
|
3029
|
+
/** If false, do not send notifications to buyer. Default is true. */
|
|
3030
|
+
sendNotificationsToBuyer?: boolean | null;
|
|
3031
|
+
/** If false, do not send notifications to business. Default is true. */
|
|
3032
|
+
sendNotificationsToBusiness?: boolean | null;
|
|
3033
|
+
/** If false, do not add activities to the order. Default is true. */
|
|
3034
|
+
addActivitiesToOrder?: boolean | null;
|
|
3035
|
+
/** If false, do not send mails to custom fulfillers in case of a change of shippable items fulfilled by custom fulfillers. Default is true. */
|
|
3036
|
+
sendNotificationsToCustomFulfillers?: boolean | null;
|
|
3037
|
+
/**
|
|
3038
|
+
* Inventory changes to be applied. Either to restock, or decrease.
|
|
3039
|
+
* @maxSize 300
|
|
3040
|
+
*/
|
|
3041
|
+
inventoryUpdates?: InventoryUpdateDetails[];
|
|
3042
|
+
}
|
|
3043
|
+
interface InventoryUpdateDetails {
|
|
3044
|
+
/** Action to be applied - decrease or restock */
|
|
3045
|
+
actionType?: InventoryActionWithLiterals;
|
|
3046
|
+
/** Order line item id */
|
|
3047
|
+
lineItemId?: string;
|
|
3048
|
+
/** The amount to be increased or restocked */
|
|
3049
|
+
quantityChange?: number;
|
|
3050
|
+
}
|
|
3051
|
+
declare enum InventoryAction {
|
|
3052
|
+
/** Restock inventory */
|
|
3053
|
+
RESTOCK = "RESTOCK",
|
|
3054
|
+
/** Decrease inventory. Without failing on negative inventory. */
|
|
3055
|
+
DECREASE = "DECREASE"
|
|
3056
|
+
}
|
|
3057
|
+
/** @enumType */
|
|
3058
|
+
type InventoryActionWithLiterals = InventoryAction | 'RESTOCK' | 'DECREASE';
|
|
3059
|
+
interface CommitDeltasResponse {
|
|
3060
|
+
/** Order after deltas are applied */
|
|
3061
|
+
order?: Order;
|
|
3062
|
+
}
|
|
3063
|
+
interface UpdateOrderLineItemRequest {
|
|
3064
|
+
/**
|
|
3065
|
+
* Order ID
|
|
3066
|
+
* @minLength 1
|
|
3067
|
+
* @maxLength 100
|
|
3068
|
+
*/
|
|
3069
|
+
id: string;
|
|
3070
|
+
/** Order line item to update */
|
|
3071
|
+
lineItem: OrderLineItem;
|
|
3072
|
+
}
|
|
3073
|
+
interface UpdateOrderLineItemResponse {
|
|
3074
|
+
/** Updated order data */
|
|
3075
|
+
order?: Order;
|
|
3076
|
+
}
|
|
3077
|
+
interface AddActivityRequest {
|
|
3078
|
+
/**
|
|
3079
|
+
* Order ID.
|
|
3080
|
+
* @minLength 1
|
|
3081
|
+
* @maxLength 100
|
|
3082
|
+
*/
|
|
3083
|
+
id: string;
|
|
3084
|
+
/** Activity info. */
|
|
3085
|
+
activity: PublicActivity;
|
|
3086
|
+
}
|
|
3087
|
+
interface PublicActivity extends PublicActivityContentOneOf {
|
|
3088
|
+
/** Custom activity details. */
|
|
3089
|
+
customActivity?: CustomActivity;
|
|
3090
|
+
/** Merchant commment. */
|
|
3091
|
+
merchantComment?: MerchantComment;
|
|
3092
|
+
}
|
|
3093
|
+
/** @oneof */
|
|
3094
|
+
interface PublicActivityContentOneOf {
|
|
3095
|
+
/** Custom activity details. */
|
|
3096
|
+
customActivity?: CustomActivity;
|
|
3097
|
+
/** Merchant commment. */
|
|
3098
|
+
merchantComment?: MerchantComment;
|
|
3099
|
+
}
|
|
3100
|
+
interface AddActivityResponse {
|
|
3101
|
+
/** Updated order. */
|
|
3102
|
+
order?: Order;
|
|
3103
|
+
/**
|
|
3104
|
+
* ID of the added activity.
|
|
3105
|
+
* Use this ID to either [update](https://bo.wix.com/wix-docs/rest/ecommerce/orders/update-activity) or [delete](https://bo.wix.com/wix-docs/rest/ecommerce/orders/delete-activity) the activity.
|
|
3106
|
+
* @format GUID
|
|
3107
|
+
*/
|
|
3108
|
+
activityId?: string;
|
|
3109
|
+
}
|
|
3110
|
+
interface UpdateActivityRequest {
|
|
3111
|
+
/**
|
|
3112
|
+
* Order ID.
|
|
3113
|
+
* @minLength 1
|
|
3114
|
+
* @maxLength 100
|
|
3115
|
+
*/
|
|
3116
|
+
id: string;
|
|
3117
|
+
/**
|
|
3118
|
+
* ID of the activity to update.
|
|
3119
|
+
* @format GUID
|
|
3120
|
+
*/
|
|
3121
|
+
activityId: string;
|
|
3122
|
+
/** Activity info. */
|
|
3123
|
+
activity: PublicActivity;
|
|
3124
|
+
}
|
|
3125
|
+
interface UpdateActivityResponse {
|
|
3126
|
+
/** Updated order. */
|
|
3127
|
+
order?: Order;
|
|
3128
|
+
}
|
|
3129
|
+
interface DeleteActivityRequest {
|
|
3130
|
+
/**
|
|
3131
|
+
* Order ID.
|
|
3132
|
+
* @minLength 1
|
|
3133
|
+
* @maxLength 100
|
|
3134
|
+
*/
|
|
3135
|
+
id: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* ID of the activity to delete.
|
|
3138
|
+
* @format GUID
|
|
3139
|
+
*/
|
|
3140
|
+
activityId: string;
|
|
3141
|
+
}
|
|
3142
|
+
interface DeleteActivityResponse {
|
|
3143
|
+
/** Updated order. */
|
|
3144
|
+
order?: Order;
|
|
3145
|
+
}
|
|
3146
|
+
interface CancelOrderRequest {
|
|
3147
|
+
/**
|
|
3148
|
+
* Order ID.
|
|
3149
|
+
* @minLength 1
|
|
3150
|
+
* @maxLength 100
|
|
3151
|
+
*/
|
|
3152
|
+
id: string;
|
|
3153
|
+
/** Whether to send an order canceled email to the buyer. */
|
|
3154
|
+
sendOrderCanceledEmail?: boolean;
|
|
3155
|
+
/**
|
|
3156
|
+
* Custom note to be added to the email (optional).
|
|
3157
|
+
* @minLength 1
|
|
3158
|
+
* @maxLength 1000
|
|
3159
|
+
*/
|
|
3160
|
+
customMessage?: string | null;
|
|
3161
|
+
/** Whether to restock all items in the order. This will only apply to products in the Wix Stores inventory. */
|
|
3162
|
+
restockAllItems?: boolean;
|
|
3163
|
+
}
|
|
3164
|
+
interface CancelOrderResponse {
|
|
3165
|
+
/** Canceled order. */
|
|
3166
|
+
order?: Order;
|
|
3167
|
+
}
|
|
3168
|
+
interface UpdateOrderStatusRequest {
|
|
3169
|
+
/**
|
|
3170
|
+
* Order ID.
|
|
3171
|
+
* @format GUID
|
|
3172
|
+
*/
|
|
3173
|
+
orderId: string;
|
|
3174
|
+
/** New order status. */
|
|
3175
|
+
status: OrderStatusWithLiterals;
|
|
3176
|
+
}
|
|
3177
|
+
interface UpdateOrderStatusResponse {
|
|
3178
|
+
/** Updated order. */
|
|
3179
|
+
order?: Order;
|
|
3180
|
+
}
|
|
3181
|
+
interface AggregateOrdersRequest {
|
|
3182
|
+
/** Filter applied to original data */
|
|
3183
|
+
filter?: Record<string, any> | null;
|
|
3184
|
+
/** This is an object defining aggregation itself */
|
|
3185
|
+
aggregation: Record<string, any> | null;
|
|
3186
|
+
/**
|
|
3187
|
+
* Optional custom separator string that can be used to override default separator value '|'
|
|
3188
|
+
* for hierarchical responses of multifaceted aggregation requests like:
|
|
3189
|
+
* '{"aggregation": {"example_request_key": {"$count" : ["deliveryMethod", "shippingRegion"]}}}'
|
|
3190
|
+
* with example response for default '|' separator like:
|
|
3191
|
+
* '{"aggregates" :{"example_request_key": {"(Mail|Region 1)": 5, "(Pickup|Region 2)": 10}}}'
|
|
3192
|
+
* @minLength 1
|
|
3193
|
+
* @maxLength 100
|
|
3194
|
+
*/
|
|
3195
|
+
hierarchySeparatorOverride?: string | null;
|
|
3196
|
+
}
|
|
3197
|
+
interface AggregateOrdersResponse {
|
|
3198
|
+
aggregates?: Record<string, any> | null;
|
|
3199
|
+
}
|
|
3200
|
+
interface BulkUpdateOrderTagsRequest {
|
|
3201
|
+
/**
|
|
3202
|
+
* IDs of orders to update tags for.
|
|
3203
|
+
* @minSize 1
|
|
3204
|
+
* @maxSize 100
|
|
3205
|
+
* @format GUID
|
|
3206
|
+
*/
|
|
3207
|
+
orderIds: string[];
|
|
3208
|
+
/** Tags to be added to orders */
|
|
3209
|
+
assignTags?: Tags;
|
|
3210
|
+
/** Tags to be removed from orders */
|
|
3211
|
+
unassignTags?: Tags;
|
|
3212
|
+
}
|
|
3213
|
+
interface BulkUpdateOrderTagsResponse {
|
|
3214
|
+
/**
|
|
3215
|
+
* @minSize 1
|
|
3216
|
+
* @maxSize 100
|
|
3217
|
+
*/
|
|
3218
|
+
results?: BulkUpdateOrderTagsResult[];
|
|
3219
|
+
bulkActionMetadata?: BulkActionMetadata;
|
|
3220
|
+
}
|
|
3221
|
+
interface BulkUpdateOrderTagsResult {
|
|
3222
|
+
itemMetadata?: ItemMetadata;
|
|
3223
|
+
}
|
|
3224
|
+
|
|
3225
|
+
type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
|
|
3226
|
+
getUrl: (context: any) => string;
|
|
3227
|
+
httpMethod: K;
|
|
3228
|
+
path: string;
|
|
3229
|
+
pathParams: M;
|
|
3230
|
+
__requestType: T;
|
|
3231
|
+
__originalRequestType: S;
|
|
3232
|
+
__responseType: Q;
|
|
3233
|
+
__originalResponseType: R;
|
|
3234
|
+
};
|
|
3235
|
+
declare function preparePaymentCollection(): __PublicMethodMetaInfo<'POST', {
|
|
3236
|
+
ecomOrderId: string;
|
|
3237
|
+
}, PreparePaymentCollectionRequest$1, PreparePaymentCollectionRequest, PreparePaymentCollectionResponse$1, PreparePaymentCollectionResponse>;
|
|
3238
|
+
declare function getPaymentCollectabilityStatus(): __PublicMethodMetaInfo<'GET', {
|
|
3239
|
+
ecomOrderId: string;
|
|
3240
|
+
}, GetPaymentCollectabilityStatusRequest$1, GetPaymentCollectabilityStatusRequest, GetPaymentCollectabilityStatusResponse$1, GetPaymentCollectabilityStatusResponse>;
|
|
3241
|
+
declare function recordManuallyCollectedPayment(): __PublicMethodMetaInfo<'POST', {
|
|
3242
|
+
orderId: string;
|
|
3243
|
+
}, RecordManuallyCollectedPaymentRequest$1, RecordManuallyCollectedPaymentRequest, RecordManuallyCollectedPaymentResponse$1, RecordManuallyCollectedPaymentResponse>;
|
|
3244
|
+
declare function paymentCollectionMarkOrderAsPaid(): __PublicMethodMetaInfo<'POST', {
|
|
3245
|
+
ecomOrderId: string;
|
|
3246
|
+
}, MarkOrderAsPaidRequest$1, MarkOrderAsPaidRequest, MarkOrderAsPaidResponse$1, MarkOrderAsPaidResponse>;
|
|
3247
|
+
declare function paymentCollectionBulkMarkOrdersAsPaid(): __PublicMethodMetaInfo<'POST', {}, BulkMarkOrdersAsPaidRequest$1, BulkMarkOrdersAsPaidRequest, BulkMarkOrdersAsPaidResponse$1, BulkMarkOrdersAsPaidResponse>;
|
|
3248
|
+
declare function getRefundabilityStatus(): __PublicMethodMetaInfo<'GET', {
|
|
3249
|
+
ecomOrderId: string;
|
|
3250
|
+
}, GetRefundabilityStatusRequest$1, GetRefundabilityStatusRequest, GetRefundabilityStatusResponse$1, GetRefundabilityStatusResponse>;
|
|
3251
|
+
declare function paymentCollectionCreatePaymentGatewayOrder(): __PublicMethodMetaInfo<'POST', {
|
|
3252
|
+
ecomOrderId: string;
|
|
3253
|
+
}, CreatePaymentGatewayOrderRequest$1, CreatePaymentGatewayOrderRequest, CreatePaymentGatewayOrderResponse$1, CreatePaymentGatewayOrderResponse>;
|
|
3254
|
+
declare function chargeMemberships(): __PublicMethodMetaInfo<'POST', {
|
|
3255
|
+
ecomOrderId: string;
|
|
3256
|
+
}, ChargeMembershipsRequest$1, ChargeMembershipsRequest, ChargeMembershipsResponse$1, ChargeMembershipsResponse>;
|
|
3257
|
+
declare function triggerRefund(): __PublicMethodMetaInfo<'POST', {
|
|
3258
|
+
ecomOrderId: string;
|
|
3259
|
+
}, TriggerRefundRequest$1, TriggerRefundRequest, TriggerRefundResponse$1, TriggerRefundResponse>;
|
|
3260
|
+
declare function voidAuthorizedPayments(): __PublicMethodMetaInfo<'POST', {
|
|
3261
|
+
ecomOrderId: string;
|
|
3262
|
+
}, VoidAuthorizedPaymentsRequest$1, VoidAuthorizedPaymentsRequest, VoidAuthorizedPaymentsResponse$1, VoidAuthorizedPaymentsResponse>;
|
|
3263
|
+
declare function captureAuthorizedPayments(): __PublicMethodMetaInfo<'POST', {
|
|
3264
|
+
ecomOrderId: string;
|
|
3265
|
+
}, CaptureAuthorizedPaymentsRequest$1, CaptureAuthorizedPaymentsRequest, CaptureAuthorizedPaymentsResponse$1, CaptureAuthorizedPaymentsResponse>;
|
|
3266
|
+
declare function getOrder(): __PublicMethodMetaInfo<'GET', {
|
|
3267
|
+
id: string;
|
|
3268
|
+
}, GetOrderRequest$1, GetOrderRequest, GetOrderResponse$1, GetOrderResponse>;
|
|
3269
|
+
declare function searchOrders(): __PublicMethodMetaInfo<'POST', {}, SearchOrdersRequest$1, SearchOrdersRequest, SearchOrdersResponse$1, SearchOrdersResponse>;
|
|
3270
|
+
declare function createOrder(): __PublicMethodMetaInfo<'POST', {}, CreateOrderRequest$1, CreateOrderRequest, CreateOrderResponse$1, CreateOrderResponse>;
|
|
3271
|
+
declare function updateOrder(): __PublicMethodMetaInfo<'PATCH', {
|
|
3272
|
+
orderId: string;
|
|
3273
|
+
}, UpdateOrderRequest$1, UpdateOrderRequest, UpdateOrderResponse$1, UpdateOrderResponse>;
|
|
3274
|
+
declare function bulkUpdateOrders(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrdersRequest$1, BulkUpdateOrdersRequest, BulkUpdateOrdersResponse$1, BulkUpdateOrdersResponse>;
|
|
3275
|
+
declare function commitDeltas(): __PublicMethodMetaInfo<'POST', {
|
|
3276
|
+
id: string;
|
|
3277
|
+
}, CommitDeltasRequest$1, CommitDeltasRequest, CommitDeltasResponse$1, CommitDeltasResponse>;
|
|
3278
|
+
declare function updateOrderLineItem(): __PublicMethodMetaInfo<'PATCH', {
|
|
3279
|
+
id: string;
|
|
3280
|
+
lineItemId: string;
|
|
3281
|
+
}, UpdateOrderLineItemRequest$1, UpdateOrderLineItemRequest, UpdateOrderLineItemResponse$1, UpdateOrderLineItemResponse>;
|
|
3282
|
+
declare function addActivity(): __PublicMethodMetaInfo<'POST', {
|
|
3283
|
+
id: string;
|
|
3284
|
+
}, AddActivityRequest$1, AddActivityRequest, AddActivityResponse$1, AddActivityResponse>;
|
|
3285
|
+
declare function updateActivity(): __PublicMethodMetaInfo<'PATCH', {
|
|
3286
|
+
id: string;
|
|
3287
|
+
activityId: string;
|
|
3288
|
+
}, UpdateActivityRequest$1, UpdateActivityRequest, UpdateActivityResponse$1, UpdateActivityResponse>;
|
|
3289
|
+
declare function deleteActivity(): __PublicMethodMetaInfo<'DELETE', {
|
|
3290
|
+
id: string;
|
|
3291
|
+
activityId: string;
|
|
3292
|
+
}, DeleteActivityRequest$1, DeleteActivityRequest, DeleteActivityResponse$1, DeleteActivityResponse>;
|
|
3293
|
+
declare function cancelOrder(): __PublicMethodMetaInfo<'POST', {
|
|
3294
|
+
id: string;
|
|
3295
|
+
}, CancelOrderRequest$1, CancelOrderRequest, CancelOrderResponse$1, CancelOrderResponse>;
|
|
3296
|
+
declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
|
|
3297
|
+
orderId: string;
|
|
3298
|
+
}, UpdateOrderStatusRequest$1, UpdateOrderStatusRequest, UpdateOrderStatusResponse$1, UpdateOrderStatusResponse>;
|
|
3299
|
+
declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
|
|
3300
|
+
declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
|
|
3301
|
+
|
|
3302
|
+
export { type __PublicMethodMetaInfo, addActivity, aggregateOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, commitDeltas, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
|