@wix/auto_sdk_ecom_orders 1.0.53 → 1.0.55
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-CyvtIwV9.d.mts} +648 -1079
- package/build/{es/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-CyvtIwV9.d.ts} +648 -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-yuJ_Abfi.d.mts} +648 -1446
- package/build/internal/{es/src/ecom-v1-order-orders.universal.d.ts → ecom-v1-order-orders.universal-yuJ_Abfi.d.ts} +648 -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
|
@@ -1,341 +0,0 @@
|
|
|
1
|
-
import { EventDefinition, HttpClient } from '@wix/sdk-types';
|
|
2
|
-
import { AddActivityResponse, AggregateOrdersOptions, AggregateOrdersResponse, BulkMarkOrdersAsPaidResponse, BulkUpdateOrderTagsOptions, BulkUpdateOrderTagsResponse, BulkUpdateOrdersOptions, BulkUpdateOrdersResponse, CancelOrderOptions, CancelOrderResponse, CaptureAuthorizedPaymentsResponse, ChargeMembershipsOptions, CommitDeltasOptions, CommitDeltasResponse, CreateOrderOptions, CreatePaymentGatewayOrderResponse, DeleteActivityIdentifiers, DeleteActivityResponse, GetPaymentCollectabilityStatusResponse, GetRefundabilityStatusResponse, MarkOrderAsPaidResponse, MaskedOrder, Order, OrderApprovedEnvelope, OrderCanceledEnvelope, OrderCreatedEnvelope, OrderSearch, OrderStatusWithLiterals, OrderUpdatedEnvelope, PaymentCapture, PaymentCollectionCreatePaymentGatewayOrderOptions, PaymentRefund, PreparePaymentCollectionOptions, PreparePaymentCollectionResponse, Price, PublicActivity, SearchOrdersResponse, TriggerRefundOptions, TriggerRefundResponse, UpdateActivityIdentifiers, UpdateActivityResponse, UpdateOrder, UpdateOrderLineItem, UpdateOrderLineItemIdentifiers, UpdateOrderLineItemResponse, UpdateOrderStatusResponse, VoidAuthorizedPaymentsResponse } from './ecom-v1-order-orders.universal.js';
|
|
3
|
-
export declare const __metadata: {
|
|
4
|
-
PACKAGE_NAME: string;
|
|
5
|
-
};
|
|
6
|
-
export declare function preparePaymentCollection(httpClient: HttpClient): PreparePaymentCollectionSignature;
|
|
7
|
-
interface PreparePaymentCollectionSignature {
|
|
8
|
-
/**
|
|
9
|
-
* Prepares payment collection for given ecom order. This is the first of 2-step process of payment collection.
|
|
10
|
-
* Here we ensure that payment collection is possible for given order and store and prepare payment gateway order for future charge.
|
|
11
|
-
* 2nd step is an actual charge of prepared payment gateway order. This could be done either
|
|
12
|
-
* via Wix-Cashier's API (https://bo.wix.com/wix-docs/rest/wix-cashier/pay/charge/charge-for-order)
|
|
13
|
-
* or using Cashier Payments Widget (https://github.com/wix-private/cashier-client/tree/master/packages/cashier-payments-widget)
|
|
14
|
-
* @param - Ecom order ID.
|
|
15
|
-
* @param - Amount to collect
|
|
16
|
-
*/
|
|
17
|
-
(ecomOrderId: string, amount: Price, options?: PreparePaymentCollectionOptions | undefined): Promise<PreparePaymentCollectionResponse>;
|
|
18
|
-
}
|
|
19
|
-
export declare function getPaymentCollectabilityStatus(httpClient: HttpClient): GetPaymentCollectabilityStatusSignature;
|
|
20
|
-
interface GetPaymentCollectabilityStatusSignature {
|
|
21
|
-
/**
|
|
22
|
-
* Provides payment collectability status for given order. If payment collection is possible
|
|
23
|
-
* response will contain collectable amount for given ecom order. If not - response will contain
|
|
24
|
-
* reason why payment collection is not possible.
|
|
25
|
-
* @param - Ecom order ID.
|
|
26
|
-
*/
|
|
27
|
-
(ecomOrderId: string): Promise<GetPaymentCollectabilityStatusResponse>;
|
|
28
|
-
}
|
|
29
|
-
/** @internal */
|
|
30
|
-
export declare function recordManuallyCollectedPayment(httpClient: HttpClient): RecordManuallyCollectedPaymentSignature;
|
|
31
|
-
interface RecordManuallyCollectedPaymentSignature {
|
|
32
|
-
/**
|
|
33
|
-
* Records and approves new manual payment with provided custom amount on given order.
|
|
34
|
-
* Existing pending payments are ignored.
|
|
35
|
-
* Custom amount is expected to be less or equal remaining amount to be paid on order (affected by approved payments, refunds and gift card payments)
|
|
36
|
-
* @param - Order ID.
|
|
37
|
-
* @param - Amount to be recorded as approved manual payment for given order
|
|
38
|
-
*/
|
|
39
|
-
(orderId: string, amount: Price): Promise<void>;
|
|
40
|
-
}
|
|
41
|
-
/** @internal */
|
|
42
|
-
export declare function paymentCollectionMarkOrderAsPaid(httpClient: HttpClient): PaymentCollectionMarkOrderAsPaidSignature;
|
|
43
|
-
interface PaymentCollectionMarkOrderAsPaidSignature {
|
|
44
|
-
/**
|
|
45
|
-
* Marks the order as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
46
|
-
* In case the order already has an offline payment transaction associated with it
|
|
47
|
-
* (usually when manual payment method is chosen at checkout) - This transaction will become approved.
|
|
48
|
-
* In case the order has no payment transactions associated with it
|
|
49
|
-
* (usually when the item is set to be paid offline after checkout or when an order is created from the backoffice) - A payment transaction
|
|
50
|
-
* will be created and approved.
|
|
51
|
-
* @param - Ecom order ID.
|
|
52
|
-
*/
|
|
53
|
-
(ecomOrderId: string): Promise<MarkOrderAsPaidResponse>;
|
|
54
|
-
}
|
|
55
|
-
/** @internal */
|
|
56
|
-
export declare function paymentCollectionBulkMarkOrdersAsPaid(httpClient: HttpClient): PaymentCollectionBulkMarkOrdersAsPaidSignature;
|
|
57
|
-
interface PaymentCollectionBulkMarkOrdersAsPaidSignature {
|
|
58
|
-
/**
|
|
59
|
-
* Marks multiple orders as paid. `order.paymentStatus` field *eventually* changes to `PAID`.
|
|
60
|
-
* @param - IDs of orders to mark as paid.
|
|
61
|
-
*/
|
|
62
|
-
(ecomOrderIds: string[]): Promise<BulkMarkOrdersAsPaidResponse>;
|
|
63
|
-
}
|
|
64
|
-
/** @internal */
|
|
65
|
-
export declare function getRefundabilityStatus(httpClient: HttpClient): GetRefundabilityStatusSignature;
|
|
66
|
-
interface GetRefundabilityStatusSignature {
|
|
67
|
-
/**
|
|
68
|
-
* Checks whether this order can be refunded.
|
|
69
|
-
* @param - Order ID.
|
|
70
|
-
*/
|
|
71
|
-
(ecomOrderId: string): Promise<GetRefundabilityStatusResponse>;
|
|
72
|
-
}
|
|
73
|
-
/** @internal */
|
|
74
|
-
export declare function paymentCollectionCreatePaymentGatewayOrder(httpClient: HttpClient): PaymentCollectionCreatePaymentGatewayOrderSignature;
|
|
75
|
-
interface PaymentCollectionCreatePaymentGatewayOrderSignature {
|
|
76
|
-
/**
|
|
77
|
-
* Call this endpoint to create an order in the payment gateway system. The amount of the order would be either:
|
|
78
|
-
* 1. An explicit amount provided in the request, or;
|
|
79
|
-
* 2. If an explicit amount is not provided - the remaining amount to complete the payment of that eCom order.
|
|
80
|
-
* As a result, an ID of the created payment gateway order would be returned.
|
|
81
|
-
* You can then use Wix Payments APIs to approve that order or collect payment, which will eventually change the eCom order state (e.g mark it as paid).
|
|
82
|
-
* @param - Ecom order ID.
|
|
83
|
-
*/
|
|
84
|
-
(ecomOrderId: string, options?: PaymentCollectionCreatePaymentGatewayOrderOptions | undefined): Promise<CreatePaymentGatewayOrderResponse>;
|
|
85
|
-
}
|
|
86
|
-
/** @internal */
|
|
87
|
-
export declare function chargeMemberships(httpClient: HttpClient): ChargeMembershipsSignature;
|
|
88
|
-
interface ChargeMembershipsSignature {
|
|
89
|
-
/**
|
|
90
|
-
* @param - Order ID.
|
|
91
|
-
* @param - The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
|
|
92
|
-
* but a user which is using the membership on behalf of the a member
|
|
93
|
-
*/
|
|
94
|
-
(ecomOrderId: string, memberId: string, options?: ChargeMembershipsOptions | undefined): Promise<void>;
|
|
95
|
-
}
|
|
96
|
-
/** @internal */
|
|
97
|
-
export declare function triggerRefund(httpClient: HttpClient): TriggerRefundSignature;
|
|
98
|
-
interface TriggerRefundSignature {
|
|
99
|
-
/**
|
|
100
|
-
* Calls corresponding payment providers and creates refund transactions for requested payments.
|
|
101
|
-
* Updates order transactions based on refund results.
|
|
102
|
-
* For requested payments with `TriggerRefundRequest.payments.external_refund = true` will not call payment providers and
|
|
103
|
-
* will only update order transactions.
|
|
104
|
-
* @param - The order this refund related to
|
|
105
|
-
* @param - Refund operations information
|
|
106
|
-
*/
|
|
107
|
-
(ecomOrderId: string, payments: PaymentRefund[], options?: TriggerRefundOptions | undefined): Promise<TriggerRefundResponse>;
|
|
108
|
-
}
|
|
109
|
-
export declare function voidAuthorizedPayments(httpClient: HttpClient): VoidAuthorizedPaymentsSignature;
|
|
110
|
-
interface VoidAuthorizedPaymentsSignature {
|
|
111
|
-
/**
|
|
112
|
-
* Void authorized payments
|
|
113
|
-
* Transaction statuses for related payments will be updated in async way
|
|
114
|
-
* @param - Wix eCommerce order ID
|
|
115
|
-
* @param - Payment IDs
|
|
116
|
-
*/
|
|
117
|
-
(ecomOrderId: string, paymentIds: string[]): Promise<VoidAuthorizedPaymentsResponse>;
|
|
118
|
-
}
|
|
119
|
-
export declare function captureAuthorizedPayments(httpClient: HttpClient): CaptureAuthorizedPaymentsSignature;
|
|
120
|
-
interface CaptureAuthorizedPaymentsSignature {
|
|
121
|
-
/**
|
|
122
|
-
* Capture authorized payments
|
|
123
|
-
* Transaction statuses for related payments will be updated in async way
|
|
124
|
-
* @param - Wix eCommerce order ID
|
|
125
|
-
* @param - Capture payments information
|
|
126
|
-
*/
|
|
127
|
-
(ecomOrderId: string, payments: PaymentCapture[]): Promise<CaptureAuthorizedPaymentsResponse>;
|
|
128
|
-
}
|
|
129
|
-
export declare function getOrder(httpClient: HttpClient): GetOrderSignature;
|
|
130
|
-
interface GetOrderSignature {
|
|
131
|
-
/**
|
|
132
|
-
* Retrieves an order.
|
|
133
|
-
*
|
|
134
|
-
*
|
|
135
|
-
* The `getOrder()` function returns a Promise that resolves when the specified order is retrieved.
|
|
136
|
-
*
|
|
137
|
-
* To retrieve an order's payment and refund details, including amounts, payment methods, and payment statuses, pass the order ID to [`listTransactionsForSingleOrder( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/listtransactionsforsingleorder).
|
|
138
|
-
* @param - ID of the order to retrieve.
|
|
139
|
-
* @returns Fulfilled - The requested order.
|
|
140
|
-
*/
|
|
141
|
-
(_id: string): Promise<Order>;
|
|
142
|
-
}
|
|
143
|
-
export declare function searchOrders(httpClient: HttpClient): SearchOrdersSignature;
|
|
144
|
-
interface SearchOrdersSignature {
|
|
145
|
-
/**
|
|
146
|
-
* Retrieves a list of orders, given the provided paging, filtering, and sorting.
|
|
147
|
-
*
|
|
148
|
-
*
|
|
149
|
-
* Search Orders runs with these defaults, which you can override:
|
|
150
|
-
*
|
|
151
|
-
* - `createdDate` is sorted in `DESC` order
|
|
152
|
-
* - `cursorPaging.limit` is `100`
|
|
153
|
-
* - `filter: {"status": {"$ne": "INITIALIZED"}}` - other order statuses can be queried, but orders with `status: "INITIALIZED"` are never returned
|
|
154
|
-
*
|
|
155
|
-
* For field support for filters and sorting, see [Orders: Supported Filters and Sorting](https://dev.wix.com/docs/rest/api-reference/wix-e-commerce/orders/supported-filters-and-sorting).
|
|
156
|
-
*
|
|
157
|
-
* To learn about working with _Search_ endpoints, see
|
|
158
|
-
* [API Query Language](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language), and
|
|
159
|
-
* [Sorting and Paging](https://dev.wix.com/docs/rest/articles/getting-started/sorting-and-paging).
|
|
160
|
-
* @param - Search options.
|
|
161
|
-
*/
|
|
162
|
-
(search: OrderSearch): Promise<SearchOrdersResponse>;
|
|
163
|
-
}
|
|
164
|
-
export declare function createOrder(httpClient: HttpClient): CreateOrderSignature;
|
|
165
|
-
interface CreateOrderSignature {
|
|
166
|
-
/**
|
|
167
|
-
* Creates an order.
|
|
168
|
-
*
|
|
169
|
-
*
|
|
170
|
-
* The `createOrder()` function returns a Promise that resolves when the order is created.
|
|
171
|
-
*
|
|
172
|
-
* > **Notes:**
|
|
173
|
-
* > + If an item is digital - `lineItems[i].itemType.preset: DIGITAL` - then `lineItems[i].digitalFile` must be provided.
|
|
174
|
-
* > + If `lineItems[i].id` is passed, it must be either a valid GUID, or empty.
|
|
175
|
-
* @param - Order info.
|
|
176
|
-
* @returns Newly created order.
|
|
177
|
-
*/
|
|
178
|
-
(order: Order, options?: CreateOrderOptions | undefined): Promise<Order>;
|
|
179
|
-
}
|
|
180
|
-
export declare function updateOrder(httpClient: HttpClient): UpdateOrderSignature;
|
|
181
|
-
interface UpdateOrderSignature {
|
|
182
|
-
/**
|
|
183
|
-
* Updates an order.
|
|
184
|
-
*
|
|
185
|
-
*
|
|
186
|
-
* The `updateOrder()` function returns a Promise that resolves when the specified order's information is updated.
|
|
187
|
-
*
|
|
188
|
-
* Currently, the following fields can be updated:
|
|
189
|
-
* + `order.buyerInfo.email`
|
|
190
|
-
* + `order.buyerLanguage`
|
|
191
|
-
* + `order.weightUnit`
|
|
192
|
-
* + `order.billingInfo.address`
|
|
193
|
-
* + `order.billingInfo.contactDetails`
|
|
194
|
-
* + `order.archived`
|
|
195
|
-
* + `order.attributionSource`
|
|
196
|
-
* + `order.seenByAHuman`
|
|
197
|
-
* + `order.recipientInfo.address`
|
|
198
|
-
* + `order.recipientInfo.contactDetails`
|
|
199
|
-
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
200
|
-
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
201
|
-
*
|
|
202
|
-
* To update a field's value, include the new value in the `order` object in the method parameters.
|
|
203
|
-
* To remove a field's value, pass `null`.
|
|
204
|
-
*
|
|
205
|
-
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
206
|
-
*
|
|
207
|
-
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
208
|
-
* @param - Order ID.
|
|
209
|
-
* @returns Newly created order.
|
|
210
|
-
*/
|
|
211
|
-
(_id: string, order: UpdateOrder): Promise<Order>;
|
|
212
|
-
}
|
|
213
|
-
export declare function bulkUpdateOrders(httpClient: HttpClient): BulkUpdateOrdersSignature;
|
|
214
|
-
interface BulkUpdateOrdersSignature {
|
|
215
|
-
/**
|
|
216
|
-
* Updates up to 100 orders.
|
|
217
|
-
*
|
|
218
|
-
*
|
|
219
|
-
* The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated.
|
|
220
|
-
*
|
|
221
|
-
* Currently, the following fields can be updated:
|
|
222
|
-
* + `order.buyerInfo.email`
|
|
223
|
-
* + `order.buyerLanguage`
|
|
224
|
-
* + `order.weightUnit`
|
|
225
|
-
* + `order.billingInfo.address`
|
|
226
|
-
* + `order.billingInfo.contactDetails`
|
|
227
|
-
* + `order.archived`
|
|
228
|
-
* + `order.attributionSource`
|
|
229
|
-
* + `order.seenByAHuman`
|
|
230
|
-
* + `order.recipientInfo.address`
|
|
231
|
-
* + `order.recipientInfo.contactDetails`
|
|
232
|
-
* + `order.shippingInfo.logistics.shippingDestination.address`
|
|
233
|
-
* + `order.shippingInfo.logistics.shippingDestination.contactDetails`
|
|
234
|
-
*
|
|
235
|
-
* To update a field's value, include the new value in the `orders.order` object in the method parameters.
|
|
236
|
-
* To remove a field's value, pass `null`.
|
|
237
|
-
*
|
|
238
|
-
* > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error.
|
|
239
|
-
*
|
|
240
|
-
* To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
|
|
241
|
-
* @param - Orders to update.
|
|
242
|
-
*/
|
|
243
|
-
(orders: MaskedOrder[], options?: BulkUpdateOrdersOptions | undefined): Promise<BulkUpdateOrdersResponse>;
|
|
244
|
-
}
|
|
245
|
-
/** @internal */
|
|
246
|
-
export declare function commitDeltas(httpClient: HttpClient): CommitDeltasSignature;
|
|
247
|
-
interface CommitDeltasSignature {
|
|
248
|
-
/** @param - Order id to be updated */
|
|
249
|
-
(_id: string, options?: CommitDeltasOptions | undefined): Promise<CommitDeltasResponse>;
|
|
250
|
-
}
|
|
251
|
-
/** @internal */
|
|
252
|
-
export declare function updateOrderLineItem(httpClient: HttpClient): UpdateOrderLineItemSignature;
|
|
253
|
-
interface UpdateOrderLineItemSignature {
|
|
254
|
-
/** @deprecated */
|
|
255
|
-
(identifiers: UpdateOrderLineItemIdentifiers, lineItem: UpdateOrderLineItem): Promise<UpdateOrderLineItemResponse>;
|
|
256
|
-
}
|
|
257
|
-
/** @internal */
|
|
258
|
-
export declare function addActivity(httpClient: HttpClient): AddActivitySignature;
|
|
259
|
-
interface AddActivitySignature {
|
|
260
|
-
/**
|
|
261
|
-
* Adds a merchant comment to an order.
|
|
262
|
-
* > **Note:** Activities with type CustomActivity not supported
|
|
263
|
-
* @param - Order ID.
|
|
264
|
-
* @param - Activity info.
|
|
265
|
-
* @deprecated
|
|
266
|
-
*/
|
|
267
|
-
(_id: string, activity: PublicActivity): Promise<AddActivityResponse>;
|
|
268
|
-
}
|
|
269
|
-
/** @internal */
|
|
270
|
-
export declare function updateActivity(httpClient: HttpClient): UpdateActivitySignature;
|
|
271
|
-
interface UpdateActivitySignature {
|
|
272
|
-
/**
|
|
273
|
-
* Updates an order's activity.
|
|
274
|
-
* @param - Activity info.
|
|
275
|
-
*/
|
|
276
|
-
(identifiers: UpdateActivityIdentifiers, activity: PublicActivity): Promise<UpdateActivityResponse>;
|
|
277
|
-
}
|
|
278
|
-
/** @internal */
|
|
279
|
-
export declare function deleteActivity(httpClient: HttpClient): DeleteActivitySignature;
|
|
280
|
-
interface DeleteActivitySignature {
|
|
281
|
-
/**
|
|
282
|
-
* Delete's an order's activity.
|
|
283
|
-
*
|
|
284
|
-
* Only custom activities and merchant comments can be deleted.
|
|
285
|
-
*/
|
|
286
|
-
(identifiers: DeleteActivityIdentifiers): Promise<DeleteActivityResponse>;
|
|
287
|
-
}
|
|
288
|
-
export declare function cancelOrder(httpClient: HttpClient): CancelOrderSignature;
|
|
289
|
-
interface CancelOrderSignature {
|
|
290
|
-
/**
|
|
291
|
-
* Cancels an order.
|
|
292
|
-
*
|
|
293
|
-
*
|
|
294
|
-
* The `cancelOrder()` function returns a Promise that resolves when the specified order is canceled and the `order.status` field changes to `CANCELED`.
|
|
295
|
-
* @param - Order ID.
|
|
296
|
-
*/
|
|
297
|
-
(_id: string, options?: CancelOrderOptions | undefined): Promise<CancelOrderResponse>;
|
|
298
|
-
}
|
|
299
|
-
/** @internal */
|
|
300
|
-
export declare function updateOrderStatus(httpClient: HttpClient): UpdateOrderStatusSignature;
|
|
301
|
-
interface UpdateOrderStatusSignature {
|
|
302
|
-
/**
|
|
303
|
-
* Updates order status.
|
|
304
|
-
*
|
|
305
|
-
* >CANCELED and REJECTED are final statuses. Update from either of those will fail.
|
|
306
|
-
* >Updates into INITIALIZED are not supported.
|
|
307
|
-
*
|
|
308
|
-
* Approving order:
|
|
309
|
-
* APPROVED status can be set while order has one of [INITIALIZED, PENDING] statuses.
|
|
310
|
-
*
|
|
311
|
-
* Approving an order which was created with CreateOrderRequest.settings.order_approval_strategy = PAYMENT_METHOD_SAVED
|
|
312
|
-
* will cause an error.
|
|
313
|
-
*
|
|
314
|
-
* Setting PENDING status:
|
|
315
|
-
* Only orders in INITIALIZED status can be updated into PENDING.
|
|
316
|
-
* @param - Order ID.
|
|
317
|
-
* @param - New order status.
|
|
318
|
-
*/
|
|
319
|
-
(orderId: string, status: OrderStatusWithLiterals): Promise<UpdateOrderStatusResponse>;
|
|
320
|
-
}
|
|
321
|
-
/** @internal */
|
|
322
|
-
export declare function aggregateOrders(httpClient: HttpClient): AggregateOrdersSignature;
|
|
323
|
-
interface AggregateOrdersSignature {
|
|
324
|
-
/** */
|
|
325
|
-
(options?: AggregateOrdersOptions | undefined): Promise<AggregateOrdersResponse>;
|
|
326
|
-
}
|
|
327
|
-
export declare function bulkUpdateOrderTags(httpClient: HttpClient): BulkUpdateOrderTagsSignature;
|
|
328
|
-
interface BulkUpdateOrderTagsSignature {
|
|
329
|
-
/**
|
|
330
|
-
* Synchronously update tags on multiple orders, by list of order IDs.
|
|
331
|
-
*
|
|
332
|
-
* > **Note:** If the same tag is passed to both the `assignTags` and `unassignTags` fields, it will be assigned.
|
|
333
|
-
* @param - IDs of orders to update tags for.
|
|
334
|
-
*/
|
|
335
|
-
(orderIds: string[], options?: BulkUpdateOrderTagsOptions | undefined): Promise<BulkUpdateOrderTagsResponse>;
|
|
336
|
-
}
|
|
337
|
-
export declare const onOrderApproved: EventDefinition<OrderApprovedEnvelope, "wix.ecom.v1.order_approved">;
|
|
338
|
-
export declare const onOrderUpdated: EventDefinition<OrderUpdatedEnvelope, "wix.ecom.v1.order_updated">;
|
|
339
|
-
export declare const onOrderCanceled: EventDefinition<OrderCanceledEnvelope, "wix.ecom.v1.order_canceled">;
|
|
340
|
-
export declare const onOrderCreated: EventDefinition<OrderCreatedEnvelope, "wix.ecom.v1.order_created">;
|
|
341
|
-
export { ActionEvent, ActionType, Activity, ActivityContentOneOf, ActivityType, AddActivitiesRequest, AddActivitiesResponse, AddActivityRequest, AddActivityResponse, AddInternalActivityRequest, AddInternalActivityResponse, AdditionalFee, AdditionalFeeDelta, AdditionalFeeDeltaDeltaOneOf, AdditionalFeeRefund, Address, AddressDescription, AddressLocation, AddressWithContact, AdjustmentType, AggregateOrdersOptions, AggregateOrdersRequest, AggregateOrdersResponse, AggregatedRefundSummary, AnimationDetection, App, ApplicationError, AppliedDiscount, AppliedDiscountDelta, AppliedDiscountDeltaDeltaOneOf, AppliedDiscountDiscountSourceOneOf, ArchiveOrderRequest, ArchiveOrderResponse, AttributionSource, AuthorizationActionFailureDetails, AuthorizationCapture, AuthorizationCaptureStatus, AuthorizationDetails, AuthorizationVoid, AuthorizationVoidStatus, AuthorizedPaymentCaptured, AuthorizedPaymentCreated, AuthorizedPaymentVoided, Balance, BalanceSummary, BaseEventMetadata, BatchOfTriggerReindexOrderRequest, BigDecimalWrapper, BillingAdjustment, BillingAdjustmentPriceSummary, BulkActionMetadata, BulkArchiveOrdersByFilterRequest, BulkArchiveOrdersByFilterResponse, BulkArchiveOrdersRequest, BulkArchiveOrdersResponse, BulkMarkAsFulfilledByFilterRequest, BulkMarkAsFulfilledByFilterResponse, BulkMarkAsFulfilledRequest, BulkMarkAsFulfilledResponse, BulkMarkAsUnfulfilledByFilterRequest, BulkMarkAsUnfulfilledByFilterResponse, BulkMarkAsUnfulfilledRequest, BulkMarkAsUnfulfilledResponse, BulkMarkOrdersAsPaidRequest, BulkMarkOrdersAsPaidResponse, BulkOrderResult, BulkSendBuyerPickupConfirmationEmailsRequest, BulkSendBuyerPickupConfirmationEmailsResponse, BulkSendBuyerShippingConfirmationEmailsRequest, BulkSendBuyerShippingConfirmationEmailsResponse, BulkSetBusinessLocationRequest, BulkSetBusinessLocationResponse, BulkSetBusinessLocationResult, BulkUnArchiveOrdersByFilterRequest, BulkUnArchiveOrdersByFilterResponse, BulkUnArchiveOrdersRequest, BulkUnArchiveOrdersResponse, BulkUpdateOrderTagsOptions, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse, BulkUpdateOrderTagsResult, BulkUpdateOrdersOptions, BulkUpdateOrdersRequest, BulkUpdateOrdersResponse, BuyerInfo, BuyerInfoIdOneOf, BuyerInfoUpdate, CalculateRefundItemRequest, CalculateRefundItemResponse, CalculateRefundRequest, CalculateRefundResponse, CalculatedTax, CalculatedTaxes, Cancel, CancelOrderOptions, CancelOrderRequest, CancelOrderResponse, CaptureAuthorizedPaymentsRequest, CaptureAuthorizedPaymentsResponse, CatalogReference, ChannelInfo, ChannelType, ChargeMembershipsOptions, ChargeMembershipsRequest, ChargeMembershipsResponse, ChargeSavedPaymentMethodRequest, ChargeSavedPaymentMethodResponse, ChargedBy, Color, CommitDeltasOptions, CommitDeltasRequest, CommitDeltasResponse, CommittedDiffs, CommittedDiffsShippingUpdateInfoOneOf, CommonAddress, CommonAddressStreetOneOf, Company, Complete, ContinueSideEffectsFlowInLegacyData, Coupon, CreateOrderOptions, CreateOrderRequest, CreateOrderResponse, CreatePaymentGatewayOrderRequest, CreatePaymentGatewayOrderResponse, CreatedBy, CreatedByStringOneOf, CreditCardDetails, CreditCardPaymentMethodDetails, CurrencyConversionDetails, CursorPaging, CursorPagingMetadata, CursorSearch, CursorSearchPagingMethodOneOf, Cursors, CustomActivity, CustomField, CustomFieldGroup, CustomFieldValue, Customer, DecrementData, DecrementItemsQuantityRequest, DecrementItemsQuantityResponse, DelayedCaptureSettings, DeleteActivityIdentifiers, DeleteActivityRequest, DeleteActivityResponse, DeleteByFilterOperation, DeleteByIdsOperation, DeliveryLogistics, DeliveryLogisticsAddressOneOf, DeliveryTimeSlot, DeltaPaymentOptionType, Deposit, DepositType, DescriptionLine, DescriptionLineDescriptionLineValueOneOf, DescriptionLineName, DescriptionLineType, DescriptionLineValueOneOf, DiffmatokyPayload, DigitalFile, Discount, DiscountOneDiscountTypeOneOf, DiscountReason, DiscountRule, DiscountRuleName, DiscountType, DomainEvent, DomainEventBodyOneOf, DownloadLinkSent, DraftOrderChangesApplied, DraftOrderCommitSettings, DraftOrderDiffs, DraftOrderDiffsBillingUpdateInfoOneOf, DraftOrderDiffsBuyerUpdateInfoOneOf, DraftOrderDiffsRecipientUpdateInfoOneOf, DraftOrderDiffsShippingUpdateInfoOneOf, Duration, DurationUnit, Email, EmailEdited, Empty, EntityCreatedEvent, EntityDeletedEvent, EntityUpdatedEvent, ErrorInformation, EventMetadata, ExtendedFields, ExternalReceipt, ExternalReceiptInfo, ExternalUriMapping, FocalPoint, FreeTrialPeriod, FulfillerEmailSent, FulfillmentStatus, FulfillmentStatusUpdated, FulfillmentStatusesAggregate, FullAddressContactDetails, GetMetasiteDataRequest, GetMetasiteDataResponse, GetOrderAgcRequest, GetOrderAgcResponse, GetOrderForMetasiteRequest, GetOrderForMetasiteResponse, GetOrderOutOfBoxRequest, GetOrderOutOfBoxResponse, GetOrderRequest, GetOrderResponse, GetOrderWithFilterByLocationRequest, GetOrderWithFilterByLocationResponse, GetPaymentCollectabilityStatusRequest, GetPaymentCollectabilityStatusResponse, GetRefundabilityStatusRequest, GetRefundabilityStatusResponse, GetShipmentsRequest, GetShipmentsResponse, GiftCardPaymentDetails, GiftCardPaymentRefund, HtmlApplication, IdAndVersion, IdentificationData, IdentificationDataIdOneOf, ImageContent, IndexingMessage, InternalActivity, InternalActivityContentOneOf, InternalDocument, InternalDocumentUpdateByFilterOperation, InternalDocumentUpdateOperation, InternalQueryOrdersRequest, InternalQueryOrdersResponse, InternalUpdateExistingOperation, InventoryAction, InventoryUpdateDetails, InvoiceAdded, InvoiceDates, InvoiceDynamicPriceTotals, InvoiceFields, InvoiceSent, InvoiceSentEvent, InvoiceStatus, InvoicesPayment, ItemChangedDetails, ItemMetadata, ItemModifier, ItemTaxFullDetails, ItemType, ItemTypeItemType, ItemTypeItemTypeDataOneOf, ItemizedFee, JurisdictionType, LineItem, LineItemAmount, LineItemChanges, LineItemDelta, LineItemDeltaDeltaOneOf, LineItemDiscount, LineItemExchangeData, LineItemMetaData, LineItemPriceChange, LineItemQuantityChange, LineItemQuantityChangeType, LineItemRefund, LineItemRefundSummary, LineItemTax, LineItemTaxBreakdown, LineItemTaxInfo, LineItemUpdate, LineItems, ListOrderTransactionsForMetasiteRequest, ListOrderTransactionsForMetasiteResponse, Locale, Location, LocationAndQuantity, ManagedAdditionalFee, ManagedDiscount, ManagedLineItem, ManuallyRefundableReason, MarkAsFulfilledRequest, MarkAsFulfilledResponse, MarkAsUnfulfilledRequest, MarkAsUnfulfilledResponse, MarkOrderAsPaidRequest, MarkOrderAsPaidResponse, MarkOrderAsSeenByHumanRequest, MarkOrderAsSeenByHumanResponse, MaskedOrder, MaskedOrderLineItem, MembershipChargeItem, MembershipName, MembershipPaymentDetails, MembershipPaymentRefund, MembershipPaymentStatus, MerchantComment, MerchantDiscount, MerchantDiscountMerchantDiscountReasonOneOf, MessageEnvelope, MetaData, MetaSite, MetaTag, ModifierGroup, Namespace, NewExchangeOrderCreated, NonRefundableReason, Order, OrderApprovalStrategy, OrderApproved, OrderApprovedEnvelope, OrderCanceled, OrderCanceledEnvelope, OrderCanceledEventOrderCanceled, OrderChange, OrderChangeValueOneOf, OrderCreateNotifications, OrderCreatedEnvelope, OrderCreatedFromExchange, OrderCreationSettings, OrderDeltasCommitted, OrderFulfilled, OrderItemsRestocked, OrderLineItem, OrderLineItemChangedDetails, OrderNotFulfilled, OrderPaid, OrderPartiallyPaid, OrderPending, OrderPlaced, OrderRefunded, OrderRejected, OrderRejectedEventOrderRejected, OrderSearchSpec, OrderStatus, OrderTaxBreakdown, OrderTaxInfo, OrderTransactions, OrderUpdatedEnvelope, OrdersExperiments, Payment, PaymentCanceled, PaymentCanceledPaymentDetailsOneOf, PaymentCapture, PaymentCollectabilityStatus, PaymentCollectionCreatePaymentGatewayOrderOptions, PaymentDeclined, PaymentDeclinedPaymentDetailsOneOf, PaymentOptionType, PaymentPaymentDetailsOneOf, PaymentPending, PaymentPendingPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentRefund, PaymentRefundFailed, PaymentRefunded, PaymentStatus, PaymentStatusUpdated, Payments, Phone, PhysicalProperties, PickupAddress, PickupDetails, PickupMethod, PickupReadyEmailSent, Placement, PlainTextValue, PlatformPaging, PlatformPagingMetadata, PlatformQuery, PlatformQueryPagingMethodOneOf, PreparePaymentCollectionOptions, PreparePaymentCollectionRequest, PreparePaymentCollectionResponse, PreviewBuyerConfirmationEmailRequest, PreviewBuyerConfirmationEmailResponse, PreviewBuyerPaymentsReceivedEmailRequest, PreviewBuyerPaymentsReceivedEmailResponse, PreviewBuyerPickupConfirmationEmailRequest, PreviewBuyerPickupConfirmationEmailResponse, PreviewCancelEmailRequest, PreviewCancelEmailResponse, PreviewCancelRefundEmailRequest, PreviewCancelRefundEmailResponse, PreviewEmailByTypeRequest, PreviewEmailByTypeResponse, PreviewEmailType, PreviewRefundEmailRequest, PreviewRefundEmailResponse, PreviewResendDownloadLinksEmailRequest, PreviewResendDownloadLinksEmailResponse, PreviewShippingConfirmationEmailRequest, PreviewShippingConfirmationEmailResponse, Price, PriceDescription, PriceSummary, ProductName, PublicActivity, PublicActivityContentOneOf, QueryOrderRequest, QueryOrderResponse, QueryOrdersForMetasiteRequest, QueryOrdersForMetasiteResponse, QuotesAddress, Reason, ReceiptCreated, ReceiptCreatedReceiptInfoOneOf, ReceiptSent, ReceiptSentReceiptInfoOneOf, RecordManuallyCollectedPaymentRequest, RecordManuallyCollectedPaymentResponse, RedirectUrls, Refund, RefundDetails, RefundInitiated, RefundItem, RefundItemsBreakdown, RefundSideEffects, RefundStatus, RefundStatusInfo, RefundTransaction, Refundability, RefundabilityAdditionalRefundabilityInfoOneOf, RefundableStatus, RefundedAsStoreCredit, RefundedPayment, RefundedPaymentKindOneOf, RegularPayment, RegularPaymentDetails, RegularPaymentDetailsPaymentMethodDetailsOneOf, RegularPaymentPaymentMethodDetailsOneOf, RegularPaymentRefund, Reschedule, RestockInfo, RestockItem, RestockType, RestoreInfo, SavedPaymentMethod, ScheduledAction, SearchOrdersRequest, SearchOrdersResponse, SendBuyerConfirmationEmailRequest, SendBuyerConfirmationEmailResponse, SendBuyerPaymentsReceivedEmailRequest, SendBuyerPaymentsReceivedEmailResponse, SendBuyerPickupConfirmationEmailRequest, SendBuyerPickupConfirmationEmailResponse, SendBuyerShippingConfirmationEmailRequest, SendBuyerShippingConfirmationEmailResponse, SendCancelRefundEmailRequest, SendCancelRefundEmailResponse, SendMerchantOrderReceivedNotificationRequest, SendMerchantOrderReceivedNotificationResponse, SendMerchantOrderReceivedPushRequest, SendMerchantOrderReceivedPushResponse, SendRefundEmailRequest, SendRefundEmailResponse, SeoData, ServiceProperties, ShippingAddressEdited, ShippingConfirmationEmailSent, ShippingInformation, ShippingInformationChange, ShippingPrice, ShippingRefund, ShippingRegion, SnapshotMessage, SortOrder, Sorting, Source, SourceType, StandardDetails, State, StreetAddress, Subdivision, SubdivisionType, SubscriptionDescription, SubscriptionFrequency, SubscriptionInfo, SubscriptionSettings, SubscriptionTitle, TagList, Tags, Task, TaskAction, TaskActionActionOneOf, TaskKey, TaxSummary, TaxableAddress, TaxableAddressTaxableAddressDataOneOf, TaxableAddressType, TextDetection, TotalPrice, TotalPriceChange, TrackingLinkAdded, TrackingNumberAdded, TrackingNumberEdited, TransactionStatus, TranslatableString, TranslatedValue, TriggerRefundOptions, TriggerRefundRequest, TriggerRefundResponse, TriggerReindexOrderRequest, TriggerReindexRequest, TriggerReindexResponse, TriggerSideEffectsFromLegacyData, UnArchiveOrderRequest, UnArchiveOrderResponse, UpdateActivityIdentifiers, UpdateActivityRequest, UpdateActivityResponse, UpdateBillingContactDetailsRequest, UpdateBillingContactDetailsResponse, UpdateBuyerEmailRequest, UpdateBuyerEmailResponse, UpdateBuyerInfoRequest, UpdateBuyerInfoResponse, UpdateInternalDocumentsEvent, UpdateInternalDocumentsEventOperationOneOf, UpdateLineItemsDescriptionLinesRequest, UpdateLineItemsDescriptionLinesResponse, UpdateOrder, UpdateOrderLineItem, UpdateOrderLineItemIdentifiers, UpdateOrderLineItemRequest, UpdateOrderLineItemResponse, UpdateOrderLineItemsRequest, UpdateOrderLineItemsResponse, UpdateOrderRequest, UpdateOrderResponse, UpdateOrderShippingAddressRequest, UpdateOrderShippingAddressResponse, UpdateOrderStatusRequest, UpdateOrderStatusResponse, UpsertRefundRequest, UpsertRefundResponse, UserDataResponse, V1BulkMarkOrdersAsPaidRequest, V1BulkMarkOrdersAsPaidResponse, V1CreatePaymentGatewayOrderRequest, V1CreatePaymentGatewayOrderResponse, V1LineItemDelta, V1LineItemDeltaDeltaOneOf, V1MarkOrderAsPaidRequest, V1MarkOrderAsPaidResponse, V1RestockItem, V1ScheduledAction, V1ShippingInformation, Value, ValueType, VatId, VatType, VersionedDeleteByIdsOperation, VersionedDocumentId, VersionedDocumentUpdateOperation, VersioningMode, VoidAuthorizedPaymentsRequest, VoidAuthorizedPaymentsResponse, WebhookIdentityType, WeightUnit, WixReceipt, WixReceiptInfo, } from './ecom-v1-order-orders.universal.js';
|
|
@@ -1,302 +0,0 @@
|
|
|
1
|
-
import { renameKeysFromRESTResponseToSDKResponse } from '@wix/sdk-runtime/rename-all-nested-keys';
|
|
2
|
-
import { transformRESTAddressToSDKAddress } from '@wix/sdk-runtime/transformations/address';
|
|
3
|
-
import { transformRESTFloatToSDKFloat } from '@wix/sdk-runtime/transformations/float';
|
|
4
|
-
import { transformRESTImageToSDKImage } from '@wix/sdk-runtime/transformations/image';
|
|
5
|
-
import { transformRESTTimestampToSDKTimestamp } from '@wix/sdk-runtime/transformations/timestamp';
|
|
6
|
-
import { transformPaths } from '@wix/sdk-runtime/transformations/transform-paths';
|
|
7
|
-
import { EventDefinition } from '@wix/sdk-types';
|
|
8
|
-
import { addActivity as universalAddActivity, aggregateOrders as universalAggregateOrders, bulkUpdateOrderTags as universalBulkUpdateOrderTags, bulkUpdateOrders as universalBulkUpdateOrders, cancelOrder as universalCancelOrder, captureAuthorizedPayments as universalCaptureAuthorizedPayments, chargeMemberships as universalChargeMemberships, commitDeltas as universalCommitDeltas, createOrder as universalCreateOrder, deleteActivity as universalDeleteActivity, getOrder as universalGetOrder, getPaymentCollectabilityStatus as universalGetPaymentCollectabilityStatus, getRefundabilityStatus as universalGetRefundabilityStatus, paymentCollectionBulkMarkOrdersAsPaid as universalPaymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder as universalPaymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid as universalPaymentCollectionMarkOrderAsPaid, preparePaymentCollection as universalPreparePaymentCollection, recordManuallyCollectedPayment as universalRecordManuallyCollectedPayment, searchOrders as universalSearchOrders, triggerRefund as universalTriggerRefund, updateActivity as universalUpdateActivity, updateOrder as universalUpdateOrder, updateOrderLineItem as universalUpdateOrderLineItem, updateOrderStatus as universalUpdateOrderStatus, voidAuthorizedPayments as universalVoidAuthorizedPayments, } from './ecom-v1-order-orders.universal.js';
|
|
9
|
-
export const __metadata = { PACKAGE_NAME: '@wix/ecom' };
|
|
10
|
-
export function preparePaymentCollection(httpClient) {
|
|
11
|
-
return (ecomOrderId, amount, options) => universalPreparePaymentCollection(ecomOrderId, amount, options,
|
|
12
|
-
// @ts-ignore
|
|
13
|
-
{ httpClient });
|
|
14
|
-
}
|
|
15
|
-
export function getPaymentCollectabilityStatus(httpClient) {
|
|
16
|
-
return (ecomOrderId) => universalGetPaymentCollectabilityStatus(ecomOrderId,
|
|
17
|
-
// @ts-ignore
|
|
18
|
-
{ httpClient });
|
|
19
|
-
}
|
|
20
|
-
/** @internal */
|
|
21
|
-
export function recordManuallyCollectedPayment(httpClient) {
|
|
22
|
-
return (orderId, amount) => universalRecordManuallyCollectedPayment(orderId, amount,
|
|
23
|
-
// @ts-ignore
|
|
24
|
-
{ httpClient });
|
|
25
|
-
}
|
|
26
|
-
/** @internal */
|
|
27
|
-
export function paymentCollectionMarkOrderAsPaid(httpClient) {
|
|
28
|
-
return (ecomOrderId) => universalPaymentCollectionMarkOrderAsPaid(ecomOrderId,
|
|
29
|
-
// @ts-ignore
|
|
30
|
-
{ httpClient });
|
|
31
|
-
}
|
|
32
|
-
/** @internal */
|
|
33
|
-
export function paymentCollectionBulkMarkOrdersAsPaid(httpClient) {
|
|
34
|
-
return (ecomOrderIds) => universalPaymentCollectionBulkMarkOrdersAsPaid(ecomOrderIds,
|
|
35
|
-
// @ts-ignore
|
|
36
|
-
{ httpClient });
|
|
37
|
-
}
|
|
38
|
-
/** @internal */
|
|
39
|
-
export function getRefundabilityStatus(httpClient) {
|
|
40
|
-
return (ecomOrderId) => universalGetRefundabilityStatus(ecomOrderId,
|
|
41
|
-
// @ts-ignore
|
|
42
|
-
{ httpClient });
|
|
43
|
-
}
|
|
44
|
-
/** @internal */
|
|
45
|
-
export function paymentCollectionCreatePaymentGatewayOrder(httpClient) {
|
|
46
|
-
return (ecomOrderId, options) => universalPaymentCollectionCreatePaymentGatewayOrder(ecomOrderId, options,
|
|
47
|
-
// @ts-ignore
|
|
48
|
-
{ httpClient });
|
|
49
|
-
}
|
|
50
|
-
/** @internal */
|
|
51
|
-
export function chargeMemberships(httpClient) {
|
|
52
|
-
return (ecomOrderId, memberId, options) => universalChargeMemberships(ecomOrderId, memberId, options,
|
|
53
|
-
// @ts-ignore
|
|
54
|
-
{ httpClient });
|
|
55
|
-
}
|
|
56
|
-
/** @internal */
|
|
57
|
-
export function triggerRefund(httpClient) {
|
|
58
|
-
return (ecomOrderId, payments, options) => universalTriggerRefund(ecomOrderId, payments, options,
|
|
59
|
-
// @ts-ignore
|
|
60
|
-
{ httpClient });
|
|
61
|
-
}
|
|
62
|
-
export function voidAuthorizedPayments(httpClient) {
|
|
63
|
-
return (ecomOrderId, paymentIds) => universalVoidAuthorizedPayments(ecomOrderId, paymentIds,
|
|
64
|
-
// @ts-ignore
|
|
65
|
-
{ httpClient });
|
|
66
|
-
}
|
|
67
|
-
export function captureAuthorizedPayments(httpClient) {
|
|
68
|
-
return (ecomOrderId, payments) => universalCaptureAuthorizedPayments(ecomOrderId, payments,
|
|
69
|
-
// @ts-ignore
|
|
70
|
-
{ httpClient });
|
|
71
|
-
}
|
|
72
|
-
export function getOrder(httpClient) {
|
|
73
|
-
return (_id) => universalGetOrder(_id,
|
|
74
|
-
// @ts-ignore
|
|
75
|
-
{ httpClient });
|
|
76
|
-
}
|
|
77
|
-
export function searchOrders(httpClient) {
|
|
78
|
-
return (search) => universalSearchOrders(search,
|
|
79
|
-
// @ts-ignore
|
|
80
|
-
{ httpClient });
|
|
81
|
-
}
|
|
82
|
-
export function createOrder(httpClient) {
|
|
83
|
-
return (order, options) => universalCreateOrder(order, options,
|
|
84
|
-
// @ts-ignore
|
|
85
|
-
{ httpClient });
|
|
86
|
-
}
|
|
87
|
-
export function updateOrder(httpClient) {
|
|
88
|
-
return (_id, order) => universalUpdateOrder(_id, order,
|
|
89
|
-
// @ts-ignore
|
|
90
|
-
{ httpClient });
|
|
91
|
-
}
|
|
92
|
-
export function bulkUpdateOrders(httpClient) {
|
|
93
|
-
return (orders, options) => universalBulkUpdateOrders(orders, options,
|
|
94
|
-
// @ts-ignore
|
|
95
|
-
{ httpClient });
|
|
96
|
-
}
|
|
97
|
-
/** @internal */
|
|
98
|
-
export function commitDeltas(httpClient) {
|
|
99
|
-
return (_id, options) => universalCommitDeltas(_id, options,
|
|
100
|
-
// @ts-ignore
|
|
101
|
-
{ httpClient });
|
|
102
|
-
}
|
|
103
|
-
/** @internal */
|
|
104
|
-
export function updateOrderLineItem(httpClient) {
|
|
105
|
-
return (identifiers, lineItem) => universalUpdateOrderLineItem(identifiers, lineItem,
|
|
106
|
-
// @ts-ignore
|
|
107
|
-
{ httpClient });
|
|
108
|
-
}
|
|
109
|
-
/** @internal */
|
|
110
|
-
export function addActivity(httpClient) {
|
|
111
|
-
return (_id, activity) => universalAddActivity(_id, activity,
|
|
112
|
-
// @ts-ignore
|
|
113
|
-
{ httpClient });
|
|
114
|
-
}
|
|
115
|
-
/** @internal */
|
|
116
|
-
export function updateActivity(httpClient) {
|
|
117
|
-
return (identifiers, activity) => universalUpdateActivity(identifiers, activity,
|
|
118
|
-
// @ts-ignore
|
|
119
|
-
{ httpClient });
|
|
120
|
-
}
|
|
121
|
-
/** @internal */
|
|
122
|
-
export function deleteActivity(httpClient) {
|
|
123
|
-
return (identifiers) => universalDeleteActivity(identifiers,
|
|
124
|
-
// @ts-ignore
|
|
125
|
-
{ httpClient });
|
|
126
|
-
}
|
|
127
|
-
export function cancelOrder(httpClient) {
|
|
128
|
-
return (_id, options) => universalCancelOrder(_id, options,
|
|
129
|
-
// @ts-ignore
|
|
130
|
-
{ httpClient });
|
|
131
|
-
}
|
|
132
|
-
/** @internal */
|
|
133
|
-
export function updateOrderStatus(httpClient) {
|
|
134
|
-
return (orderId, status) => universalUpdateOrderStatus(orderId, status,
|
|
135
|
-
// @ts-ignore
|
|
136
|
-
{ httpClient });
|
|
137
|
-
}
|
|
138
|
-
/** @internal */
|
|
139
|
-
export function aggregateOrders(httpClient) {
|
|
140
|
-
return (options) => universalAggregateOrders(options,
|
|
141
|
-
// @ts-ignore
|
|
142
|
-
{ httpClient });
|
|
143
|
-
}
|
|
144
|
-
export function bulkUpdateOrderTags(httpClient) {
|
|
145
|
-
return (orderIds, options) => universalBulkUpdateOrderTags(orderIds, options,
|
|
146
|
-
// @ts-ignore
|
|
147
|
-
{ httpClient });
|
|
148
|
-
}
|
|
149
|
-
export const onOrderApproved = EventDefinition('wix.ecom.v1.order_approved', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
|
150
|
-
{
|
|
151
|
-
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
152
|
-
paths: [
|
|
153
|
-
{ path: 'data.order.createdDate' },
|
|
154
|
-
{ path: 'data.order.updatedDate' },
|
|
155
|
-
{ path: 'data.order.purchasedDate' },
|
|
156
|
-
{ path: 'data.order.lineItems.digitalFile.expirationDate' },
|
|
157
|
-
{
|
|
158
|
-
path: 'data.order.lineItems.subscriptionInfo.subscriptionSettings.startDate',
|
|
159
|
-
},
|
|
160
|
-
{ path: 'data.order.shippingInfo.logistics.deliverByDate' },
|
|
161
|
-
{ path: 'data.order.shippingInfo.logistics.deliveryTimeSlot.from' },
|
|
162
|
-
{ path: 'data.order.shippingInfo.logistics.deliveryTimeSlot.to' },
|
|
163
|
-
{ path: 'data.order.activities.createdDate' },
|
|
164
|
-
{ path: 'metadata.eventTime' },
|
|
165
|
-
],
|
|
166
|
-
},
|
|
167
|
-
{
|
|
168
|
-
transformFn: transformRESTImageToSDKImage,
|
|
169
|
-
paths: [{ path: 'data.order.lineItems.image' }],
|
|
170
|
-
},
|
|
171
|
-
{
|
|
172
|
-
transformFn: transformRESTFloatToSDKFloat,
|
|
173
|
-
paths: [{ path: 'data.order.lineItems.physicalProperties.weight' }],
|
|
174
|
-
},
|
|
175
|
-
{
|
|
176
|
-
transformFn: transformRESTAddressToSDKAddress,
|
|
177
|
-
paths: [
|
|
178
|
-
{ path: 'data.order.billingInfo.address' },
|
|
179
|
-
{
|
|
180
|
-
path: 'data.order.shippingInfo.logistics.shippingDestination.address',
|
|
181
|
-
},
|
|
182
|
-
{ path: 'data.order.shippingInfo.logistics.pickupDetails.address' },
|
|
183
|
-
{ path: 'data.order.recipientInfo.address' },
|
|
184
|
-
],
|
|
185
|
-
},
|
|
186
|
-
])))();
|
|
187
|
-
export const onOrderUpdated = EventDefinition('wix.ecom.v1.order_updated', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
|
188
|
-
{
|
|
189
|
-
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
190
|
-
paths: [
|
|
191
|
-
{ path: 'entity.createdDate' },
|
|
192
|
-
{ path: 'entity.updatedDate' },
|
|
193
|
-
{ path: 'entity.purchasedDate' },
|
|
194
|
-
{ path: 'entity.lineItems.digitalFile.expirationDate' },
|
|
195
|
-
{
|
|
196
|
-
path: 'entity.lineItems.subscriptionInfo.subscriptionSettings.startDate',
|
|
197
|
-
},
|
|
198
|
-
{ path: 'entity.shippingInfo.logistics.deliverByDate' },
|
|
199
|
-
{ path: 'entity.shippingInfo.logistics.deliveryTimeSlot.from' },
|
|
200
|
-
{ path: 'entity.shippingInfo.logistics.deliveryTimeSlot.to' },
|
|
201
|
-
{ path: 'entity.activities.createdDate' },
|
|
202
|
-
{ path: 'metadata.eventTime' },
|
|
203
|
-
],
|
|
204
|
-
},
|
|
205
|
-
{
|
|
206
|
-
transformFn: transformRESTImageToSDKImage,
|
|
207
|
-
paths: [{ path: 'entity.lineItems.image' }],
|
|
208
|
-
},
|
|
209
|
-
{
|
|
210
|
-
transformFn: transformRESTFloatToSDKFloat,
|
|
211
|
-
paths: [{ path: 'entity.lineItems.physicalProperties.weight' }],
|
|
212
|
-
},
|
|
213
|
-
{
|
|
214
|
-
transformFn: transformRESTAddressToSDKAddress,
|
|
215
|
-
paths: [
|
|
216
|
-
{ path: 'entity.billingInfo.address' },
|
|
217
|
-
{
|
|
218
|
-
path: 'entity.shippingInfo.logistics.shippingDestination.address',
|
|
219
|
-
},
|
|
220
|
-
{ path: 'entity.shippingInfo.logistics.pickupDetails.address' },
|
|
221
|
-
{ path: 'entity.recipientInfo.address' },
|
|
222
|
-
],
|
|
223
|
-
},
|
|
224
|
-
])))();
|
|
225
|
-
export const onOrderCanceled = EventDefinition('wix.ecom.v1.order_canceled', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
|
226
|
-
{
|
|
227
|
-
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
228
|
-
paths: [
|
|
229
|
-
{ path: 'data.order.createdDate' },
|
|
230
|
-
{ path: 'data.order.updatedDate' },
|
|
231
|
-
{ path: 'data.order.purchasedDate' },
|
|
232
|
-
{ path: 'data.order.lineItems.digitalFile.expirationDate' },
|
|
233
|
-
{
|
|
234
|
-
path: 'data.order.lineItems.subscriptionInfo.subscriptionSettings.startDate',
|
|
235
|
-
},
|
|
236
|
-
{ path: 'data.order.shippingInfo.logistics.deliverByDate' },
|
|
237
|
-
{ path: 'data.order.shippingInfo.logistics.deliveryTimeSlot.from' },
|
|
238
|
-
{ path: 'data.order.shippingInfo.logistics.deliveryTimeSlot.to' },
|
|
239
|
-
{ path: 'data.order.activities.createdDate' },
|
|
240
|
-
{ path: 'metadata.eventTime' },
|
|
241
|
-
],
|
|
242
|
-
},
|
|
243
|
-
{
|
|
244
|
-
transformFn: transformRESTImageToSDKImage,
|
|
245
|
-
paths: [{ path: 'data.order.lineItems.image' }],
|
|
246
|
-
},
|
|
247
|
-
{
|
|
248
|
-
transformFn: transformRESTFloatToSDKFloat,
|
|
249
|
-
paths: [{ path: 'data.order.lineItems.physicalProperties.weight' }],
|
|
250
|
-
},
|
|
251
|
-
{
|
|
252
|
-
transformFn: transformRESTAddressToSDKAddress,
|
|
253
|
-
paths: [
|
|
254
|
-
{ path: 'data.order.billingInfo.address' },
|
|
255
|
-
{
|
|
256
|
-
path: 'data.order.shippingInfo.logistics.shippingDestination.address',
|
|
257
|
-
},
|
|
258
|
-
{ path: 'data.order.shippingInfo.logistics.pickupDetails.address' },
|
|
259
|
-
{ path: 'data.order.recipientInfo.address' },
|
|
260
|
-
],
|
|
261
|
-
},
|
|
262
|
-
])))();
|
|
263
|
-
export const onOrderCreated = EventDefinition('wix.ecom.v1.order_created', true, (event) => renameKeysFromRESTResponseToSDKResponse(transformPaths(event, [
|
|
264
|
-
{
|
|
265
|
-
transformFn: transformRESTTimestampToSDKTimestamp,
|
|
266
|
-
paths: [
|
|
267
|
-
{ path: 'entity.createdDate' },
|
|
268
|
-
{ path: 'entity.updatedDate' },
|
|
269
|
-
{ path: 'entity.purchasedDate' },
|
|
270
|
-
{ path: 'entity.lineItems.digitalFile.expirationDate' },
|
|
271
|
-
{
|
|
272
|
-
path: 'entity.lineItems.subscriptionInfo.subscriptionSettings.startDate',
|
|
273
|
-
},
|
|
274
|
-
{ path: 'entity.shippingInfo.logistics.deliverByDate' },
|
|
275
|
-
{ path: 'entity.shippingInfo.logistics.deliveryTimeSlot.from' },
|
|
276
|
-
{ path: 'entity.shippingInfo.logistics.deliveryTimeSlot.to' },
|
|
277
|
-
{ path: 'entity.activities.createdDate' },
|
|
278
|
-
{ path: 'metadata.eventTime' },
|
|
279
|
-
],
|
|
280
|
-
},
|
|
281
|
-
{
|
|
282
|
-
transformFn: transformRESTImageToSDKImage,
|
|
283
|
-
paths: [{ path: 'entity.lineItems.image' }],
|
|
284
|
-
},
|
|
285
|
-
{
|
|
286
|
-
transformFn: transformRESTFloatToSDKFloat,
|
|
287
|
-
paths: [{ path: 'entity.lineItems.physicalProperties.weight' }],
|
|
288
|
-
},
|
|
289
|
-
{
|
|
290
|
-
transformFn: transformRESTAddressToSDKAddress,
|
|
291
|
-
paths: [
|
|
292
|
-
{ path: 'entity.billingInfo.address' },
|
|
293
|
-
{
|
|
294
|
-
path: 'entity.shippingInfo.logistics.shippingDestination.address',
|
|
295
|
-
},
|
|
296
|
-
{ path: 'entity.shippingInfo.logistics.pickupDetails.address' },
|
|
297
|
-
{ path: 'entity.recipientInfo.address' },
|
|
298
|
-
],
|
|
299
|
-
},
|
|
300
|
-
])))();
|
|
301
|
-
export { ActionType, ActivityType, AdjustmentType, AnimationDetection, AttributionSource, AuthorizationCaptureStatus, AuthorizationVoidStatus, ChannelType, CustomFieldGroup, DeltaPaymentOptionType, DepositType, DescriptionLineType, DiscountReason, DiscountType, DurationUnit, FulfillmentStatus, InventoryAction, InvoiceStatus, ItemTypeItemType, JurisdictionType, LineItemQuantityChangeType, ManuallyRefundableReason, MembershipPaymentStatus, Namespace, NonRefundableReason, OrderApprovalStrategy, OrderStatus, PaymentCollectabilityStatus, PaymentOptionType, PaymentStatus, PickupMethod, Placement, PreviewEmailType, Reason, RefundStatus, RefundableStatus, RestockType, ScheduledAction, SortOrder, SourceType, State, SubdivisionType, SubscriptionFrequency, TaxableAddressType, TextDetection, TransactionStatus, ValueType, VatType, VersioningMode, WebhookIdentityType, WeightUnit, } from './ecom-v1-order-orders.universal.js';
|
|
302
|
-
//# sourceMappingURL=ecom-v1-order-orders.public.js.map
|