@wix/ditto-codegen-public 1.0.170 → 1.0.172

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.
Files changed (17) hide show
  1. package/dist/docs-output/api-docs/ecom-cart-addToCart-doc.txt +255 -345
  2. package/dist/docs-output/api-docs/ecom-cart-createCart-doc.txt +298 -387
  3. package/dist/docs-output/api-docs/ecom-cart-createCheckout-doc.txt +24 -30
  4. package/dist/docs-output/api-docs/ecom-cart-getCart-doc.txt +174 -266
  5. package/dist/docs-output/api-docs/ecom-cart-removeLineItemsFromCart-doc.txt +175 -204
  6. package/dist/docs-output/api-docs/ecom-cart-updateCart-doc.txt +301 -398
  7. package/dist/docs-output/api-docs/ecom-checkout-addToCheckout-doc.txt +433 -816
  8. package/dist/docs-output/api-docs/ecom-checkout-createCheckout-doc.txt +519 -1282
  9. package/dist/docs-output/api-docs/ecom-checkout-getCheckout-doc.txt +353 -886
  10. package/dist/docs-output/api-docs/ecom-checkout-removeLineItemsFromCheckout-doc.txt +354 -734
  11. package/dist/docs-output/api-docs/ecom-checkout-updateCheckout-doc.txt +513 -794
  12. package/dist/docs-output/api-docs/ecom-currentCart-getCurrentCart-doc.txt +174 -301
  13. package/dist/docs-output/api-docs/ecom-currentCart-updateCurrentCart-doc.txt +301 -398
  14. package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt +589 -641
  15. package/dist/docs-output/api-docs/ecom-orders-getOrder-doc.txt +425 -726
  16. package/dist/examples-apps/custom-element/src/widgets/custom-elements/countdown-timer/widget.tsx +370 -209
  17. package/package.json +2 -2
package/dist/docs-output/api-docs/ecom-orders-getOrder-doc.txt CHANGED
@@ -30,7 +30,7 @@ undefined
30
30
 
31
31
  # Method Code Examples:
32
32
 
33
- ## Get an order
33
+ ## Get an order
34
34
 
35
35
  ```javascript
36
36
  /*****************************************
@@ -71,307 +71,6 @@ myGetOrderFunction(orderId)
71
71
  console.error(error);
72
72
  // Handle the error
73
73
  });
74
-
75
- /*
76
- * Promise resolves to:
77
- *
78
- * {
79
- * "_id": "67668940-527d-4465-94c6-5475d8c7a412",
80
- * "number": "10124",
81
- * "_createdDate": "2022-07-31T13:42:13.136Z",
82
- * "_updatedDate": "2022-07-31T14:58:11.663Z",
83
- * "lineItems": [
84
- * {
85
- * "_id": "00000000-0000-0000-0000-000000000001",
86
- * "productName": {
87
- * "original": "Brazilian Arabica",
88
- * "translated": "Brazilian Arabica"
89
- * },
90
- * "catalogReference": {
91
- * "catalogItemId": "0614129c-8777-9f3b-4dfe-b80a54df10d5",
92
- * "appId": "215238eb-22a5-4c36-9e7b-e7c08025e04e",
93
- * "options": {
94
- * "options": {
95
- * "Weight": "500g",
96
- * "Ground for": "Stovetop"
97
- * },
98
- * "variantId": "00000000-0000-003f-0005-a316f7c67df7",
99
- * "customTextFields": {
100
- * "What would you like written on the custom label?": "Enjoy our finest coffee."
101
- * }
102
- * }
103
- * },
104
- * "quantity": 1,
105
- * "totalDiscount": {
106
- * "amount": "0",
107
- * "formattedAmount": "$0.00"
108
- * },
109
- * "descriptionLines": [
110
- * {
111
- * "name": {
112
- * "original": "Weight",
113
- * "translated": "Weight"
114
- * },
115
- * "plainText": {
116
- * "original": "500g",
117
- * "translated": "500g"
118
- * },
119
- * "lineType": "PLAIN_TEXT",
120
- * "plainTextValue": {
121
- * "original": "500g",
122
- * "translated": "500g"
123
- * }
124
- * },
125
- * {
126
- * "name": {
127
- * "original": "Ground for",
128
- * "translated": "Ground for"
129
- * },
130
- * "plainText": {
131
- * "original": "Stovetop",
132
- * "translated": "Stovetop"
133
- * },
134
- * "lineType": "PLAIN_TEXT",
135
- * "plainTextValue": {
136
- * "original": "Stovetop",
137
- * "translated": "Stovetop"
138
- * }
139
- * },
140
- * {
141
- * "name": {
142
- * "original": "What would you like written on the custom label?",
143
- * "translated": "What would you like written on the custom label?"
144
- * },
145
- * "plainText": {
146
- * "original": "Enjoy our finest coffee.",
147
- * "translated": "Enjoy our finest coffee."
148
- * },
149
- * "lineType": "PLAIN_TEXT",
150
- * "plainTextValue": {
151
- * "original": "Enjoy our finest coffee.",
152
- * "translated": "Enjoy our finest coffee."
153
- * }
154
- * }
155
- * ],
156
- * "image": "wix:image://v1/nsplsh_306d666a306a4a74306459~mv2_d_4517_2992_s_4_2.jpg#originWidth=4517&originHeight=2992",
157
- * "physicalProperties": {
158
- * "weight": 0.5,
159
- * "shippable": true
160
- * },
161
- * "itemType": {
162
- * "preset": "PHYSICAL"
163
- * },
164
- * "fulfillerId": "85e29287-a5bf-4c25-b303-a2ddc9d975e2",
165
- * "refundQuantity": 0,
166
- * "price": {
167
- * "amount": "48.75",
168
- * "formattedAmount": "$48.75"
169
- * },
170
- * "priceBeforeDiscounts": {
171
- * "amount": "48.75",
172
- * "formattedAmount": "$48.75"
173
- * },
174
- * "totalPriceBeforeTax": {
175
- * "amount": "48.75",
176
- * "formattedAmount": "$48.75"
177
- * },
178
- * "totalPriceAfterTax": {
179
- * "amount": "50.70",
180
- * "formattedAmount": "$50.70"
181
- * },
182
- * "paymentOption": "FULL_PAYMENT_ONLINE",
183
- * "taxDetails": {
184
- * "taxableAmount": {
185
- * "amount": "48.75",
186
- * "formattedAmount": "$48.75"
187
- * },
188
- * "taxRate": "0.04",
189
- * "totalTax": {
190
- * "amount": "1.95",
191
- * "formattedAmount": "$1.95"
192
- * }
193
- * }
194
- * }
195
- * ],
196
- * "buyerInfo": {
197
- * "contactId": "f61f30cd-7474-47b7-95a2-339c0fcacbd3",
198
- * "email": "janedoe@gmail.com",
199
- * "visitorId": "b52ec002-40dd-469c-9f9f-833988e8048d"
200
- * },
201
- * "paymentStatus": "PAID",
202
- * "fulfillmentStatus": "NOT_FULFILLED",
203
- * "buyerLanguage": "en",
204
- * "weightUnit": "LB",
205
- * "currency": "USD",
206
- * "taxIncludedInPrices": false,
207
- * "priceSummary": {
208
- * "subtotal": {
209
- * "amount": "48.75",
210
- * "formattedAmount": "$48.75"
211
- * },
212
- * "shipping": {
213
- * "amount": "5.0",
214
- * "formattedAmount": "$5.00"
215
- * },
216
- * "tax": {
217
- * "amount": "1.95",
218
- * "formattedAmount": "$1.95"
219
- * },
220
- * "discount": {
221
- * "amount": "0",
222
- * "formattedAmount": "$0.00"
223
- * },
224
- * "totalPrice": {
225
- * "amount": "55.70",
226
- * "formattedAmount": "$55.70"
227
- * },
228
- * "total": {
229
- * "amount": "55.70",
230
- * "formattedAmount": "$55.70"
231
- * },
232
- * "totalWithGiftCard": {
233
- * "amount": "55.70",
234
- * "formattedAmount": "$55.70"
235
- * },
236
- * "totalWithoutGiftCard": {
237
- * "amount": "55.70",
238
- * "formattedAmount": "$55.70"
239
- * },
240
- * "totalAdditionalFees": {
241
- * "amount": "0",
242
- * "formattedAmount": "$0.00"
243
- * }
244
- * },
245
- * "billingInfo": {
246
- * "address": {
247
- * "addressLine1": "525 5th Avenue",
248
- * "city": "New York",
249
- * "subdivision": "US-NY",
250
- * "country": "US",
251
- * "postalCode": "10173"
252
- * },
253
- * "contactDetails": {
254
- * "firstName": "Jane",
255
- * "lastName": "Doe",
256
- * "phone": "0555555555"
257
- * }
258
- * },
259
- * "shippingInfo": {
260
- * "carrierId": "c8a08776-c095-4dec-8553-8f9698d86adc",
261
- * "code": "a0fde0a4-6f4e-3716-64be-c0acbde1696a",
262
- * "title": "U.S Shipping",
263
- * "logistics": {
264
- * "deliveryTime": "3 - 5 business days",
265
- * "shippingDestination": {
266
- * "address": {
267
- * "addressLine1": "525 5th Avenue",
268
- * "city": "New York",
269
- * "subdivision": "US-NY",
270
- * "country": "US",
271
- * "postalCode": "10173"
272
- * },
273
- * "contactDetails": {
274
- * "firstName": "Jane",
275
- * "lastName": "Doe",
276
- * "phone": "0555555555"
277
- * }
278
- * }
279
- * },
280
- * "cost": {
281
- * "price": {
282
- * "amount": "5",
283
- * "formattedAmount": "$5.00"
284
- * },
285
- * "totalPriceBeforeTax": {
286
- * "amount": "5",
287
- * "formattedAmount": "$5.00"
288
- * },
289
- * "totalPriceAfterTax": {
290
- * "amount": "5.0",
291
- * "formattedAmount": "$5.00"
292
- * },
293
- * "taxDetails": {
294
- * "taxRate": "0.0",
295
- * "totalTax": {
296
- * "amount": "0.0",
297
- * "formattedAmount": "$0.00"
298
- * }
299
- * },
300
- * "discount": {
301
- * "amount": "0",
302
- * "formattedAmount": "$0.00"
303
- * }
304
- * },
305
- * "region": {
306
- * "name": "Region 3"
307
- * }
308
- * },
309
- * "buyerNote": "This is a buyerNote",
310
- * "status": "APPROVED",
311
- * "taxSummary": {
312
- * "totalTax": {
313
- * "amount": "1.95",
314
- * "formattedAmount": "$1.95"
315
- * },
316
- * "manualTaxRate": "0.04"
317
- * },
318
- * "appliedDiscounts": [],
319
- * "activities": [],
320
- * "attributionSource": "UNSPECIFIED",
321
- * "createdBy": {
322
- * "visitorId": "b52ec002-40dd-469c-9f9f-833988e8048d"
323
- * },
324
- * "channelInfo": {
325
- * "type": "WEB"
326
- * },
327
- * "checkoutId": "62d01935-e0d3-4063-9e78-da099462e90c",
328
- * "customFields": [],
329
- * "cartId": "52fec024-4379-4a96-9237-9660030be6fe",
330
- * "payNow": {
331
- * "subtotal": {
332
- * "amount": "48.75",
333
- * "formattedAmount": "$48.75"
334
- * },
335
- * "shipping": {
336
- * "amount": "5.0",
337
- * "formattedAmount": "$5.00"
338
- * },
339
- * "tax": {
340
- * "amount": "1.95",
341
- * "formattedAmount": "$1.95"
342
- * },
343
- * "discount": {
344
- * "amount": "0",
345
- * "formattedAmount": "$0.00"
346
- * },
347
- * "totalPrice": {
348
- * "amount": "55.70",
349
- * "formattedAmount": "$55.70"
350
- * },
351
- * "total": {
352
- * "amount": "55.70",
353
- * "formattedAmount": "$55.70"
354
- * },
355
- * "totalWithGiftCard": {
356
- * "amount": "55.70",
357
- * "formattedAmount": "$55.70"
358
- * },
359
- * "totalWithoutGiftCard": {
360
- * "amount": "55.70",
361
- * "formattedAmount": "$55.70"
362
- * }
363
- * },
364
- * "balanceSummary": {
365
- * "balance": {
366
- * "amount": "0.0",
367
- * "formattedAmount": "$0.00"
368
- * }
369
- * },
370
- * "additionalFees": []
371
- * }
372
- *
373
- */
374
-
375
74
  ```
376
75
 
377
76
 
@@ -395,14 +94,14 @@ Description: Retrieves an order. The `getOrder()` function returns a Promise t
395
94
  Method parameters:
396
95
  param name: _id | type: string | description: GUID of the order to retrieve. | required: true
397
96
  Return type: PROMISE<Order>
398
- - name: _createdDate | type: Date | description: Date and time the order was created.
399
- - name: _id | type: string | description: Order GUID.
400
- - name: _updatedDate | type: Date | description: Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
401
- - name: activities | type: Array<Activity> | description: Order activities.
402
- - name: activities[]._createdDate | type: Date | description: Activity creation date and time.
403
- - name: activities[]._id | type: string | description: Activity GUID.
404
- - name: activities[].activityType | type: OrderActivityTypeEnumActivityType | description: Activity type.
405
- enum:
97
+ - name: _createdDate | type: Date | description: Date and time the order was created.
98
+ - name: _id | type: string | description: Order GUID.
99
+ - name: _updatedDate | type: Date | description: Date and time the order was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
100
+ - name: activities | type: Array<Activity> | description: Order activities.
101
+ - name: activities[]._createdDate | type: Date | description: Activity creation date and time.
102
+ - name: activities[]._id | type: string | description: Activity GUID.
103
+ - name: activities[].activityType | type: OrderActivityTypeEnumActivityType | description: Activity type.
104
+ enum:
406
105
  AUTHORIZED_PAYMENT_CAPTURED: Previously authorized payment was captured.
407
106
  AUTHORIZED_PAYMENT_CREATED: Payment was authorized but not yet captured.
408
107
  AUTHORIZED_PAYMENT_VOIDED: Previously authorized payment was voided.
@@ -445,262 +144,262 @@ Return type: PROMISE<Order>
445
144
  TRACKING_NUMBER_ADDED: Shipping tracking number was added to the order.
446
145
  TRACKING_NUMBER_EDITED: Existing shipping tracking number was modified.
447
146
  UNKNOWN_ACTIVITY_TYPE: Default value. This value is unused.
448
- - name: activities[].authorEmail | type: string | description: Activity author's email.
449
- - ONE-OF:
450
- - name: activities[].authorizedPaymentCaptured | type: AuthorizedPaymentCaptured | description: Details of an authorized payment captured.
451
- - name: activities[].authorizedPaymentCaptured.amount | type: Price | description: Payment amount
452
- - name: activities[].authorizedPaymentCaptured.amount.amount | type: string | description: Amount.
453
- - name: activities[].authorizedPaymentCaptured.amount.formattedAmount | type: string | description: Amount formatted with currency symbol.
454
- - name: activities[].authorizedPaymentCaptured.brand | type: string | description: Card issuer's brand.
455
- - name: activities[].authorizedPaymentCaptured.lastFourDigits | type: string | description: The last 4 digits of the card number.
456
- - name: activities[].authorizedPaymentCaptured.paymentId | type: string | description: Payment GUID of payment associated with this activity
457
- - name: activities[].authorizedPaymentCreated | type: AuthorizedPaymentCreated | description: Details of an authorized payment created.
458
- - name: activities[].authorizedPaymentCreated.amount | type: Price | description: Payment amount
459
- - name: activities[].authorizedPaymentCreated.brand | type: string | description: Card issuer's brand.
460
- - name: activities[].authorizedPaymentCreated.lastFourDigits | type: string | description: The last 4 digits of the card number.
461
- - name: activities[].authorizedPaymentCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
462
- - name: activities[].authorizedPaymentVoided | type: AuthorizedPaymentVoided | description: Details of an authorized payment voided.
463
- - name: activities[].authorizedPaymentVoided.amount | type: Price | description: Payment amount
464
- - name: activities[].authorizedPaymentVoided.brand | type: string | description: Card issuer's brand.
465
- - name: activities[].authorizedPaymentVoided.lastFourDigits | type: string | description: The last 4 digits of the card number.
466
- - name: activities[].authorizedPaymentVoided.paymentId | type: string | description: Payment GUID of payment associated with this activity
467
- - name: activities[].chargebackCreated | type: ChargebackCreated | description: Order received a chargeback for one of its' payments.
468
- - name: activities[].chargebackCreated.amount | type: Price | description: Chargeback amount.
469
- - name: activities[].chargebackCreated.chargebackId | type: string | description: Chargeback GUID.
470
- - name: activities[].chargebackCreated.paymentDetails | type: RegularPayment | description: Payment details.
471
- - name: activities[].chargebackCreated.paymentDetails.amount | type: Price | description: Payment amount
472
- - ONE-OF:
473
- - name: activities[].chargebackCreated.paymentDetails.creditCardDetails | type: CreditCardDetails | description: Whether regular card used
474
- - name: activities[].chargebackCreated.paymentDetails.creditCardDetails.brand | type: string | description: Card issuer's brand.
475
- - name: activities[].chargebackCreated.paymentDetails.creditCardDetails.lastFourDigits | type: string | description: The last 4 digits of the card number.
476
- - name: activities[].chargebackCreated.paymentId | type: string | description: GUID of the payment that received a chargeback.
477
- - name: activities[].chargebackReversed | type: ChargebackReversed | description: Chargeback reversed for one of the order's payments.
478
- - name: activities[].chargebackReversed.amount | type: Price | description: Chargeback amount.
479
- - name: activities[].chargebackReversed.chargebackId | type: string | description: Chargeback GUID.
480
- - name: activities[].chargebackReversed.paymentDetails | type: RegularPayment | description: Payment details.
481
- - name: activities[].chargebackReversed.paymentId | type: string | description: GUID of the payment involved with the chargeback.
482
- - name: activities[].chargebackReversed.reversalAmount | type: Price | description: Chargeback reversal amount.
483
- - name: activities[].customActivity | type: CustomActivity | description: Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`.
484
- - name: activities[].customActivity.additionalData | type: Record<string, string> | description: Additional data in key-value form. For example, `{ "Ticket number": "123456" }`.
485
- - name: activities[].customActivity.appId | type: string | description: GUID of the app that created the custom activity.
486
- - name: activities[].customActivity.type | type: string | description: Custom activity type. For example, `"Ticket number set"`.
487
- - name: activities[].draftOrderChangesApplied | type: DraftOrderChangesApplied | description: Details of changes made by the Draft Orders API.
488
- - name: activities[].draftOrderChangesApplied.changes | type: Array<OrderChange> | description: Changes applied to order.
489
- - ONE-OF:
490
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded | type: ManagedAdditionalFee | description: none
491
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded._id | type: string | description: Additional fee id.
492
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items additional fee applies to.
493
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[]._id | type: string | description: Order line item id
494
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].amount | type: Price | description: Amount associated with this item. (Discount amount for item / additional fee amount for item)
495
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name | type: ProductName | description: Item name.
496
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name.original | type: string | description: __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). Min: 1 character. Max: 200 characters.
497
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name.translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
498
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name | type: TranslatedValue | description: Additional fee name.
499
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.original | type: string | description: Value in site default language.
500
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.translated | type: string | description: Translated value.
501
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.totalAmount | type: Price | description: Additional fee amount.
502
- - name: activities[].draftOrderChangesApplied.changes[].additionalFeeRemoved | type: ManagedAdditionalFee | description: none
503
- - name: activities[].draftOrderChangesApplied.changes[].discountAdded | type: ManagedDiscount | description: none
504
- - name: activities[].draftOrderChangesApplied.changes[].discountAdded._id | type: string | description: Discount id.
505
- - name: activities[].draftOrderChangesApplied.changes[].discountAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items discount applies to.
506
- - name: activities[].draftOrderChangesApplied.changes[].discountAdded.name | type: TranslatedValue | description: Discount name: coupon name / discount rule name / merchant discount description.
507
- - name: activities[].draftOrderChangesApplied.changes[].discountAdded.totalAmount | type: Price | description: Discount amount.
508
- - name: activities[].draftOrderChangesApplied.changes[].discountRemoved | type: ManagedDiscount | description: none
509
- - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded | type: ManagedLineItem | description: none
510
- - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded._id | type: string | description: Line item GUID.
511
- - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded.name | type: ProductName | description: Item name.
512
- - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded.quantity | type: number | description: Added or removed item quantity.
513
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged | type: LineItemChanges | description: none
514
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged._id | type: string | description: Line item GUID.
515
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.name | type: ProductName | description: Item name after change.
516
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.price | type: LineItemPriceChange | description: Item price change.
517
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.newPrice | type: Price | description: Item price after update.
518
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.originalPrice | type: Price | description: Item price before update.
519
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity | type: LineItemQuantityChange | description: Item quantity change.
520
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.deltaType | type: LineItemQuantityChangeType | description: Type of quantity change: increase or decrease.
521
- enum:
147
+ - name: activities[].authorEmail | type: string | description: Activity author's email.
148
+ - ONE-OF:
149
+ - name: activities[].authorizedPaymentCaptured | type: AuthorizedPaymentCaptured | description: Details of an authorized payment captured.
150
+ - name: activities[].authorizedPaymentCaptured.amount | type: Price | description: Payment amount
151
+ - name: activities[].authorizedPaymentCaptured.amount.amount | type: string | description: Amount.
152
+ - name: activities[].authorizedPaymentCaptured.amount.formattedAmount | type: string | description: Amount formatted with currency symbol.
153
+ - name: activities[].authorizedPaymentCaptured.brand | type: string | description: Card issuer's brand.
154
+ - name: activities[].authorizedPaymentCaptured.lastFourDigits | type: string | description: The last 4 digits of the card number.
155
+ - name: activities[].authorizedPaymentCaptured.paymentId | type: string | description: Payment GUID of payment associated with this activity
156
+ - name: activities[].authorizedPaymentCreated | type: AuthorizedPaymentCreated | description: Details of an authorized payment created.
157
+ - name: activities[].authorizedPaymentCreated.amount | type: Price | description: Payment amount
158
+ - name: activities[].authorizedPaymentCreated.brand | type: string | description: Card issuer's brand.
159
+ - name: activities[].authorizedPaymentCreated.lastFourDigits | type: string | description: The last 4 digits of the card number.
160
+ - name: activities[].authorizedPaymentCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
161
+ - name: activities[].authorizedPaymentVoided | type: AuthorizedPaymentVoided | description: Details of an authorized payment voided.
162
+ - name: activities[].authorizedPaymentVoided.amount | type: Price | description: Payment amount
163
+ - name: activities[].authorizedPaymentVoided.brand | type: string | description: Card issuer's brand.
164
+ - name: activities[].authorizedPaymentVoided.lastFourDigits | type: string | description: The last 4 digits of the card number.
165
+ - name: activities[].authorizedPaymentVoided.paymentId | type: string | description: Payment GUID of payment associated with this activity
166
+ - name: activities[].chargebackCreated | type: ChargebackCreated | description: Order received a chargeback for one of its' payments.
167
+ - name: activities[].chargebackCreated.amount | type: Price | description: Chargeback amount.
168
+ - name: activities[].chargebackCreated.chargebackId | type: string | description: Chargeback GUID.
169
+ - name: activities[].chargebackCreated.paymentDetails | type: RegularPayment | description: Payment details.
170
+ - name: activities[].chargebackCreated.paymentDetails.amount | type: Price | description: Payment amount
171
+ - ONE-OF:
172
+ - name: activities[].chargebackCreated.paymentDetails.creditCardDetails | type: CreditCardDetails | description: Whether regular card used
173
+ - name: activities[].chargebackCreated.paymentDetails.creditCardDetails.brand | type: string | description: Card issuer's brand.
174
+ - name: activities[].chargebackCreated.paymentDetails.creditCardDetails.lastFourDigits | type: string | description: The last 4 digits of the card number.
175
+ - name: activities[].chargebackCreated.paymentId | type: string | description: GUID of the payment that received a chargeback.
176
+ - name: activities[].chargebackReversed | type: ChargebackReversed | description: Chargeback reversed for one of the order's payments.
177
+ - name: activities[].chargebackReversed.amount | type: Price | description: Chargeback amount.
178
+ - name: activities[].chargebackReversed.chargebackId | type: string | description: Chargeback GUID.
179
+ - name: activities[].chargebackReversed.paymentDetails | type: RegularPayment | description: Payment details.
180
+ - name: activities[].chargebackReversed.paymentId | type: string | description: GUID of the payment involved with the chargeback.
181
+ - name: activities[].chargebackReversed.reversalAmount | type: Price | description: Chargeback reversal amount.
182
+ - name: activities[].customActivity | type: CustomActivity | description: Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`.
183
+ - name: activities[].customActivity.additionalData | type: Record<string, string> | description: Additional data in key-value form. For example, `{ "Ticket number": "123456" }`.
184
+ - name: activities[].customActivity.appId | type: string | description: GUID of the app that created the custom activity.
185
+ - name: activities[].customActivity.type | type: string | description: Custom activity type. For example, `"Ticket number set"`.
186
+ - name: activities[].draftOrderChangesApplied | type: DraftOrderChangesApplied | description: Details of changes made by the Draft Orders API.
187
+ - name: activities[].draftOrderChangesApplied.changes | type: Array<OrderChange> | description: Changes applied to order.
188
+ - ONE-OF:
189
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded | type: ManagedAdditionalFee | description: none
190
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded._id | type: string | description: Additional fee id.
191
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items additional fee applies to.
192
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[]._id | type: string | description: Order line item id
193
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].amount | type: Price | description: Amount associated with this item. (Discount amount for item / additional fee amount for item)
194
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name | type: ProductName | description: Item name.
195
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name.original | type: string | description: __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). Min: 1 character. Max: 200 characters.
196
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name.translated | type: string | description: Item name translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
197
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name | type: TranslatedValue | description: Additional fee name.
198
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.original | type: string | description: Value in site default language.
199
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.translated | type: string | description: Translated value.
200
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.totalAmount | type: Price | description: Additional fee amount.
201
+ - name: activities[].draftOrderChangesApplied.changes[].additionalFeeRemoved | type: ManagedAdditionalFee | description: none
202
+ - name: activities[].draftOrderChangesApplied.changes[].discountAdded | type: ManagedDiscount | description: none
203
+ - name: activities[].draftOrderChangesApplied.changes[].discountAdded._id | type: string | description: Discount id.
204
+ - name: activities[].draftOrderChangesApplied.changes[].discountAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items discount applies to.
205
+ - name: activities[].draftOrderChangesApplied.changes[].discountAdded.name | type: TranslatedValue | description: Discount name: coupon name / discount rule name / merchant discount description.
206
+ - name: activities[].draftOrderChangesApplied.changes[].discountAdded.totalAmount | type: Price | description: Discount amount.
207
+ - name: activities[].draftOrderChangesApplied.changes[].discountRemoved | type: ManagedDiscount | description: none
208
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded | type: ManagedLineItem | description: none
209
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded._id | type: string | description: Line item GUID.
210
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded.name | type: ProductName | description: Item name.
211
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemAdded.quantity | type: number | description: Added or removed item quantity.
212
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged | type: LineItemChanges | description: none
213
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged._id | type: string | description: Line item GUID.
214
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.name | type: ProductName | description: Item name after change.
215
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.price | type: LineItemPriceChange | description: Item price change.
216
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.newPrice | type: Price | description: Item price after update.
217
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.originalPrice | type: Price | description: Item price before update.
218
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity | type: LineItemQuantityChange | description: Item quantity change.
219
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.deltaType | type: LineItemQuantityChangeType | description: Type of quantity change: increase or decrease.
220
+ enum:
522
221
  QUANTITY_DECREASED: Quantity decreased.
523
222
  QUANTITY_INCREASED: Quantity increased.
524
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.diff | type: number | description: Difference between original and new quantity. Absolute value.
525
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.newQuantity | type: number | description: Item quantity after update.
526
- - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.originalQuantity | type: number | description: Item quantity before update.
527
- - name: activities[].draftOrderChangesApplied.changes[].lineItemRemoved | type: ManagedLineItem | description: none
528
- - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged | type: ShippingInformationChange | description: none
529
- - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. After update
530
- - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.shippingTitle | type: string | description: Order’s shipping title.
531
- - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.total | type: Price | description: Order’s shipping price.
532
- - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.originalShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. Before update
533
- - name: activities[].draftOrderChangesApplied.changes[].totalPriceChanged | type: TotalPriceChange | description: none
534
- - name: activities[].draftOrderChangesApplied.changes[].totalPriceChanged.newTotal | type: Price | description: Order’s total price after discounts and tax. After update
535
- - name: activities[].draftOrderChangesApplied.changes[].totalPriceChanged.originalTotal | type: Price | description: Order’s total price after discounts and tax. Before update
536
- - name: activities[].draftOrderChangesApplied.draftOrderId | type: string | description: Draft order id.
537
- - name: activities[].draftOrderChangesApplied.reason | type: string | description: Reason for edit, given by user (optional).
538
- - name: activities[].merchantComment | type: MerchantComment | description: Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`.
539
- - name: activities[].merchantComment.message | type: string | description: Merchant comment message.
540
- - name: activities[].orderRefunded | type: OrderRefunded | description: Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`.
541
- - name: activities[].orderRefunded.amount | type: Price | description: Refund amount.
542
- - name: activities[].orderRefunded.manual | type: boolean | description: Whether order was refunded manually. For example, via payment provider or using cash.
543
- - name: activities[].orderRefunded.reason | type: string | description: Reason for refund.
544
- - name: activities[].paymentCanceled | type: PaymentCanceled | description: Details of a canceled payment.
545
- - name: activities[].paymentCanceled.paymentId | type: string | description: Payment GUID of payment associated with this activity
546
- - ONE-OF:
547
- - name: activities[].paymentCanceled.regular | type: RegularPayment | description: Regular payment.
548
- - name: activities[].paymentDeclined | type: PaymentDeclined | description: Details of a declined payment.
549
- - name: activities[].paymentDeclined.paymentId | type: string | description: Payment GUID of payment associated with this activity
550
- - ONE-OF:
551
- - name: activities[].paymentDeclined.regular | type: RegularPayment | description: Regular payment.
552
- - name: activities[].paymentPending | type: PaymentPending | description: Details of a pending payment.
553
- - name: activities[].paymentPending.paymentId | type: string | description: Payment GUID of payment associated with this activity
554
- - ONE-OF:
555
- - name: activities[].paymentPending.regular | type: RegularPayment | description: Regular payment.
556
- - name: activities[].paymentRefundFailed | type: PaymentRefundFailed | description: Details of a failed payment refund. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities.
557
- - name: activities[].paymentRefundFailed.payment | type: RefundedPayment | description: Details about the failed payment refund.
558
- - name: activities[].paymentRefundFailed.payment.externalRefund | type: boolean | description: Whether refund was made externally and manually on the payment provider's side.
559
- - name: activities[].paymentRefundFailed.payment.paymentId | type: string | description: Payment GUID.
560
- - ONE-OF:
561
- - name: activities[].paymentRefundFailed.payment.giftCard | type: GiftCardPaymentRefund | description: Gift card payment refund.
562
- - name: activities[].paymentRefundFailed.payment.giftCard.amount | type: Price | description: Refund amount
563
- - name: activities[].paymentRefundFailed.payment.giftCard.giftCardPaymentId | type: string | description: Gift card payment GUID
564
- - name: activities[].paymentRefundFailed.payment.membership | type: MembershipPaymentRefund | description: Membership payment refund.
565
- - name: activities[].paymentRefundFailed.payment.membership.membershipId | type: string | description: Membership GUID
566
- - name: activities[].paymentRefundFailed.payment.regular | type: RegularPaymentRefund | description: Regular payment refund.
567
- - name: activities[].paymentRefundFailed.payment.regular.amount | type: Price | description: Refund amount
568
- - name: activities[].paymentRefundFailed.payment.regular.brand | type: string | description: Card issuer's brand.
569
- - name: activities[].paymentRefundFailed.payment.regular.lastFourDigits | type: string | description: The last 4 digits of the card number.
570
- - name: activities[].paymentRefundFailed.refundId | type: string | description: Refund GUID.
571
- - name: activities[].paymentRefunded | type: PaymentRefunded | description: Details of a refunded payment. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities.
572
- - name: activities[].paymentRefunded.payment | type: RefundedPayment | description: Details about the refunded payment.
573
- - name: activities[].paymentRefunded.refundId | type: string | description: Refund GUID.
574
- - name: activities[].receiptCreated | type: ReceiptCreated | description: Receipt was added for associated payment.
575
- - name: activities[].receiptCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
576
- - ONE-OF:
577
- - name: activities[].receiptCreated.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
578
- - name: activities[].receiptCreated.externalReceipt.displayNumber | type: string | description: Display number of receipt
579
- - name: activities[].receiptCreated.externalReceipt.receiptId | type: string | description: Receipt GUID
580
- - name: activities[].receiptCreated.wixReceipt | type: WixReceipt | description: Receipt created by Wix
581
- - name: activities[].receiptCreated.wixReceipt.displayNumber | type: string | description: Display number of receipt
582
- - name: activities[].receiptCreated.wixReceipt.receiptId | type: string | description: Receipt GUID
583
- - name: activities[].receiptSent | type: ReceiptSent | description: Receipt sent to customer.
584
- - name: activities[].receiptSent.paymentId | type: string | description: Payment GUID of payment associated with this activity
585
- - ONE-OF:
586
- - name: activities[].receiptSent.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
587
- - name: activities[].receiptSent.wixReceipt | type: WixReceipt | description: Receipt created by Wix
588
- - name: activities[].refundInitiated | type: RefundInitiated | description: Details of an initiated refund process. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities.
589
- - name: activities[].refundInitiated.amount | type: Price | description: Refund amount.
590
- - name: activities[].refundInitiated.payments | type: Array<RefundedPayment> | description: Details about the payments being refunded.
591
- - name: activities[].refundInitiated.reason | type: string | description: Reason for refund.
592
- - name: activities[].refundInitiated.refundId | type: string | description: Refund GUID.
593
- - name: activities[].refundedAsStoreCredit | type: RefundedAsStoreCredit | description: Details of refund to store credit.
594
- - name: activities[].refundedAsStoreCredit.amount | type: Price | description: Refund amount
595
- - name: activities[].refundedAsStoreCredit.reason | type: string | description: Reason for refund
596
- - name: activities[].savedPaymentMethod | type: SavedPaymentMethod | description: Details of the payment method saved for order
597
- - name: activities[].savedPaymentMethod.description | type: string | description: Payment method description
598
- - name: activities[].savedPaymentMethod.name | type: string | description: Payment method name
599
- - name: additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
600
- - name: additionalFees[]._id | type: string | description: Additional fee's id.
601
- - name: additionalFees[].code | type: string | description: Additional fee's unique code for future processing.
602
- - name: additionalFees[].lineItemIds | type: Array<string> | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
603
- - name: additionalFees[].name | type: string | description: Name of additional fee.
604
- - name: additionalFees[].price | type: Price | description: Additional fee's price.
605
- - name: additionalFees[].priceAfterTax | type: Price | description: Additional fee's price after tax.
606
- - name: additionalFees[].priceBeforeTax | type: Price | description: Additional fee's price before tax.
607
- - name: additionalFees[].providerAppId | type: string | description: SPI implementer's `appId`.
608
- - name: additionalFees[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
609
- - name: additionalFees[].taxInfo.taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
610
- - name: additionalFees[].taxInfo.taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
611
- - name: additionalFees[].taxInfo.taxBreakdown[].jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
612
- - name: additionalFees[].taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
223
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.diff | type: number | description: Difference between original and new quantity. Absolute value.
224
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.newQuantity | type: number | description: Item quantity after update.
225
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.originalQuantity | type: number | description: Item quantity before update.
226
+ - name: activities[].draftOrderChangesApplied.changes[].lineItemRemoved | type: ManagedLineItem | description: none
227
+ - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged | type: ShippingInformationChange | description: none
228
+ - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. After update
229
+ - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.shippingTitle | type: string | description: Order’s shipping title.
230
+ - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.total | type: Price | description: Order’s shipping price.
231
+ - name: activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.originalShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. Before update
232
+ - name: activities[].draftOrderChangesApplied.changes[].totalPriceChanged | type: TotalPriceChange | description: none
233
+ - name: activities[].draftOrderChangesApplied.changes[].totalPriceChanged.newTotal | type: Price | description: Order’s total price after discounts and tax. After update
234
+ - name: activities[].draftOrderChangesApplied.changes[].totalPriceChanged.originalTotal | type: Price | description: Order’s total price after discounts and tax. Before update
235
+ - name: activities[].draftOrderChangesApplied.draftOrderId | type: string | description: Draft order id.
236
+ - name: activities[].draftOrderChangesApplied.reason | type: string | description: Reason for edit, given by user (optional).
237
+ - name: activities[].merchantComment | type: MerchantComment | description: Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`.
238
+ - name: activities[].merchantComment.message | type: string | description: Merchant comment message.
239
+ - name: activities[].orderRefunded | type: OrderRefunded | description: Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`.
240
+ - name: activities[].orderRefunded.amount | type: Price | description: Refund amount.
241
+ - name: activities[].orderRefunded.manual | type: boolean | description: Whether order was refunded manually. For example, via payment provider or using cash.
242
+ - name: activities[].orderRefunded.reason | type: string | description: Reason for refund.
243
+ - name: activities[].paymentCanceled | type: PaymentCanceled | description: Details of a canceled payment.
244
+ - name: activities[].paymentCanceled.paymentId | type: string | description: Payment GUID of payment associated with this activity
245
+ - ONE-OF:
246
+ - name: activities[].paymentCanceled.regular | type: RegularPayment | description: Regular payment.
247
+ - name: activities[].paymentDeclined | type: PaymentDeclined | description: Details of a declined payment.
248
+ - name: activities[].paymentDeclined.paymentId | type: string | description: Payment GUID of payment associated with this activity
249
+ - ONE-OF:
250
+ - name: activities[].paymentDeclined.regular | type: RegularPayment | description: Regular payment.
251
+ - name: activities[].paymentPending | type: PaymentPending | description: Details of a pending payment.
252
+ - name: activities[].paymentPending.paymentId | type: string | description: Payment GUID of payment associated with this activity
253
+ - ONE-OF:
254
+ - name: activities[].paymentPending.regular | type: RegularPayment | description: Regular payment.
255
+ - name: activities[].paymentRefundFailed | type: PaymentRefundFailed | description: Details of a failed payment refund. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities.
256
+ - name: activities[].paymentRefundFailed.payment | type: RefundedPayment | description: Details about the failed payment refund.
257
+ - name: activities[].paymentRefundFailed.payment.externalRefund | type: boolean | description: Whether refund was made externally and manually on the payment provider's side.
258
+ - name: activities[].paymentRefundFailed.payment.paymentId | type: string | description: Payment GUID.
259
+ - ONE-OF:
260
+ - name: activities[].paymentRefundFailed.payment.giftCard | type: GiftCardPaymentRefund | description: Gift card payment refund.
261
+ - name: activities[].paymentRefundFailed.payment.giftCard.amount | type: Price | description: Refund amount
262
+ - name: activities[].paymentRefundFailed.payment.giftCard.giftCardPaymentId | type: string | description: Gift card payment GUID
263
+ - name: activities[].paymentRefundFailed.payment.membership | type: MembershipPaymentRefund | description: Membership payment refund.
264
+ - name: activities[].paymentRefundFailed.payment.membership.membershipId | type: string | description: Membership GUID
265
+ - name: activities[].paymentRefundFailed.payment.regular | type: RegularPaymentRefund | description: Regular payment refund.
266
+ - name: activities[].paymentRefundFailed.payment.regular.amount | type: Price | description: Refund amount
267
+ - name: activities[].paymentRefundFailed.payment.regular.brand | type: string | description: Card issuer's brand.
268
+ - name: activities[].paymentRefundFailed.payment.regular.lastFourDigits | type: string | description: The last 4 digits of the card number.
269
+ - name: activities[].paymentRefundFailed.refundId | type: string | description: Refund GUID.
270
+ - name: activities[].paymentRefunded | type: PaymentRefunded | description: Details of a refunded payment. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities.
271
+ - name: activities[].paymentRefunded.payment | type: RefundedPayment | description: Details about the refunded payment.
272
+ - name: activities[].paymentRefunded.refundId | type: string | description: Refund GUID.
273
+ - name: activities[].receiptCreated | type: ReceiptCreated | description: Receipt was added for associated payment.
274
+ - name: activities[].receiptCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
275
+ - ONE-OF:
276
+ - name: activities[].receiptCreated.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
277
+ - name: activities[].receiptCreated.externalReceipt.displayNumber | type: string | description: Display number of receipt
278
+ - name: activities[].receiptCreated.externalReceipt.receiptId | type: string | description: Receipt GUID
279
+ - name: activities[].receiptCreated.wixReceipt | type: WixReceipt | description: Receipt created by Wix
280
+ - name: activities[].receiptCreated.wixReceipt.displayNumber | type: string | description: Display number of receipt
281
+ - name: activities[].receiptCreated.wixReceipt.receiptId | type: string | description: Receipt GUID
282
+ - name: activities[].receiptSent | type: ReceiptSent | description: Receipt sent to customer.
283
+ - name: activities[].receiptSent.paymentId | type: string | description: Payment GUID of payment associated with this activity
284
+ - ONE-OF:
285
+ - name: activities[].receiptSent.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
286
+ - name: activities[].receiptSent.wixReceipt | type: WixReceipt | description: Receipt created by Wix
287
+ - name: activities[].refundInitiated | type: RefundInitiated | description: Details of an initiated refund process. > **Note:** A single `refundInitiated` activity can result in multiple `paymentRefunded` or `paymentRefundFailed` activities. > In these cases, the `refundId` will be identical across the activities.
288
+ - name: activities[].refundInitiated.amount | type: Price | description: Refund amount.
289
+ - name: activities[].refundInitiated.payments | type: Array<RefundedPayment> | description: Details about the payments being refunded.
290
+ - name: activities[].refundInitiated.reason | type: string | description: Reason for refund.
291
+ - name: activities[].refundInitiated.refundId | type: string | description: Refund GUID.
292
+ - name: activities[].refundedAsStoreCredit | type: RefundedAsStoreCredit | description: Details of refund to store credit.
293
+ - name: activities[].refundedAsStoreCredit.amount | type: Price | description: Refund amount
294
+ - name: activities[].refundedAsStoreCredit.reason | type: string | description: Reason for refund
295
+ - name: activities[].savedPaymentMethod | type: SavedPaymentMethod | description: Details of the payment method saved for order
296
+ - name: activities[].savedPaymentMethod.description | type: string | description: Payment method description
297
+ - name: activities[].savedPaymentMethod.name | type: string | description: Payment method name
298
+ - name: additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
299
+ - name: additionalFees[]._id | type: string | description: Additional fee's id.
300
+ - name: additionalFees[].code | type: string | description: Additional fee's unique code for future processing.
301
+ - name: additionalFees[].lineItemIds | type: Array<string> | description: Optional - Line items associated with this additional fee. If no `lineItemIds` are provided, the fee will be associated with the whole cart/checkout/order.
302
+ - name: additionalFees[].name | type: string | description: Name of additional fee.
303
+ - name: additionalFees[].price | type: Price | description: Additional fee's price.
304
+ - name: additionalFees[].priceAfterTax | type: Price | description: Additional fee's price after tax.
305
+ - name: additionalFees[].priceBeforeTax | type: Price | description: Additional fee's price before tax.
306
+ - name: additionalFees[].providerAppId | type: string | description: SPI implementer's `appId`.
307
+ - name: additionalFees[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
308
+ - name: additionalFees[].taxInfo.taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
309
+ - name: additionalFees[].taxInfo.taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
310
+ - name: additionalFees[].taxInfo.taxBreakdown[].jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
311
+ - name: additionalFees[].taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
613
312
  enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
614
- - name: additionalFees[].taxInfo.taxBreakdown[].nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
615
- - name: additionalFees[].taxInfo.taxBreakdown[].rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
616
- - name: additionalFees[].taxInfo.taxBreakdown[].taxAmount | type: Price | description: Amount of tax calculated for this line item.
617
- - name: additionalFees[].taxInfo.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated.
618
- - name: additionalFees[].taxInfo.taxBreakdown[].taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
619
- - name: additionalFees[].taxInfo.taxBreakdown[].taxableAmount | type: Price | description: Taxable amount of the line item price.
620
- - name: additionalFees[].taxInfo.taxGroupId | type: string | description: Tax group GUID.
621
- - name: additionalFees[].taxInfo.taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
622
- - name: additionalFees[].taxInfo.taxRate | type: string | description: Tax rate %, as a decimal point.
623
- - name: additionalFees[].taxInfo.taxableAmount | type: Price | description: Amount for which tax is calculated.
624
- - name: appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
625
- - name: appliedDiscounts[]._id | type: string | description: Discount id.
626
- - name: appliedDiscounts[].discountType | type: DiscountType | description: Discount type. * `"GLOBAL"` - discount applies to entire order. * `"SPECIFIC-ITEMS"` - discount applies to specific items. * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
313
+ - name: additionalFees[].taxInfo.taxBreakdown[].nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
314
+ - name: additionalFees[].taxInfo.taxBreakdown[].rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
315
+ - name: additionalFees[].taxInfo.taxBreakdown[].taxAmount | type: Price | description: Amount of tax calculated for this line item.
316
+ - name: additionalFees[].taxInfo.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated. For example, "NY State Sales Tax", "Quebec GST", etc. This name should be explicit enough to allow the merchant to understand what tax was calculated.
317
+ - name: additionalFees[].taxInfo.taxBreakdown[].taxType | type: string | description: The type of tax that was calculated. Depends on the jurisdiction's tax laws. For example, "Sales Tax", "Income Tax", "Value Added Tax", etc.
318
+ - name: additionalFees[].taxInfo.taxBreakdown[].taxableAmount | type: Price | description: Taxable amount of the line item price.
319
+ - name: additionalFees[].taxInfo.taxGroupId | type: string | description: Tax group GUID.
320
+ - name: additionalFees[].taxInfo.taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
321
+ - name: additionalFees[].taxInfo.taxRate | type: string | description: Tax rate %, as a decimal point.
322
+ - name: additionalFees[].taxInfo.taxableAmount | type: Price | description: Amount for which tax is calculated.
323
+ - name: appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
324
+ - name: appliedDiscounts[]._id | type: string | description: Discount id.
325
+ - name: appliedDiscounts[].discountType | type: DiscountType | description: Discount type. * `"GLOBAL"` - discount applies to entire order. * `"SPECIFIC-ITEMS"` - discount applies to specific items. * `"SHIPPING"` - discount applies to shipping. For example, free shipping.
627
326
  enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
628
- - ONE-OF:
629
- - name: appliedDiscounts[].coupon | type: Coupon | description: Applied coupon info.
630
- - name: appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
631
- - name: appliedDiscounts[].coupon.amount | type: Price | description: Coupon value.
632
- - name: appliedDiscounts[].coupon.code | type: string | description: Coupon code.
633
- - name: appliedDiscounts[].coupon.name | type: string | description: Coupon name.
634
- - name: appliedDiscounts[].discountRule | type: DiscountRule | description: Automatic Discount
635
- - name: appliedDiscounts[].discountRule._id | type: string | description: Discount rule GUID
636
- - name: appliedDiscounts[].discountRule.amount | type: Price | description: Discount value.
637
- - name: appliedDiscounts[].discountRule.name | type: DiscountRuleName | description: Discount rule name
638
- - name: appliedDiscounts[].discountRule.name.original | type: string | description: Original discount rule name (in site's default language).
639
- - name: appliedDiscounts[].discountRule.name.translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
640
- - name: appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
641
- - name: appliedDiscounts[].merchantDiscount.amount | type: Price | description: Discount amount.
642
- - ONE-OF:
643
- - name: appliedDiscounts[].merchantDiscount.description | type: string | description: Discount description as free text (optional).
644
- - name: appliedDiscounts[].merchantDiscount.discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
327
+ - ONE-OF:
328
+ - name: appliedDiscounts[].coupon | type: Coupon | description: Applied coupon info.
329
+ - name: appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
330
+ - name: appliedDiscounts[].coupon.amount | type: Price | description: Coupon value.
331
+ - name: appliedDiscounts[].coupon.code | type: string | description: Coupon code.
332
+ - name: appliedDiscounts[].coupon.name | type: string | description: Coupon name.
333
+ - name: appliedDiscounts[].discountRule | type: DiscountRule | description: Automatic Discount
334
+ - name: appliedDiscounts[].discountRule._id | type: string | description: Discount rule GUID
335
+ - name: appliedDiscounts[].discountRule.amount | type: Price | description: Discount value.
336
+ - name: appliedDiscounts[].discountRule.name | type: DiscountRuleName | description: Discount rule name
337
+ - name: appliedDiscounts[].discountRule.name.original | type: string | description: Original discount rule name (in site's default language).
338
+ - name: appliedDiscounts[].discountRule.name.translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
339
+ - name: appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
340
+ - name: appliedDiscounts[].merchantDiscount.amount | type: Price | description: Discount amount.
341
+ - ONE-OF:
342
+ - name: appliedDiscounts[].merchantDiscount.description | type: string | description: Discount description as free text (optional).
343
+ - name: appliedDiscounts[].merchantDiscount.discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
645
344
  enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
646
- - name: archived | type: boolean | description: Whether order is archived.
647
- - name: attributionSource | type: AttributionSource | description: Order attribution source.
345
+ - name: archived | type: boolean | description: Whether order is archived.
346
+ - name: attributionSource | type: AttributionSource | description: Order attribution source.
648
347
  enum: FACEBOOK_ADS, UNSPECIFIED
649
- - name: balanceSummary | type: BalanceSummary | description: Balance summary.
650
- - name: balanceSummary.authorized | type: Price | description: Sum of all authorized payments.
651
- - name: balanceSummary.balance | type: Balance | description: Current amount left to pay.
652
- - name: balanceSummary.balance.amount | type: string | description: Balance amount. 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.
653
- - name: balanceSummary.balance.formattedAmount | type: string | description: Amount formatted with currency symbol.
654
- - name: balanceSummary.chargeback | type: Price | description: Sum of all transaction chargebacks.
655
- - name: balanceSummary.chargebackReversal | type: Price | description: Sum of all chargeback reversals.
656
- - name: balanceSummary.paid | type: Price | description: Sum of all approved and successful payments. The value includes payments that have subsequently been fully or partially refunded.
657
- - name: balanceSummary.pending | type: Price | description: Sum of all pending transactions.
658
- - name: balanceSummary.pendingRefund | type: Price | description: Sum of all pending refund transactions.
659
- - name: balanceSummary.refunded | type: Price | description: Sum of all successfully refunded payments.
660
- - name: billingInfo | type: AddressWithContact | description: Billing address and contact details.
661
- - name: billingInfo.address | type: Address | description: Address.
662
- - name: billingInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
663
- - name: billingInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
664
- - name: billingInfo.address.city | type: string | description: City name.
665
- - name: billingInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
666
- - name: billingInfo.address.countryFullname | type: string | description: Country's full name.
667
- - name: billingInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
668
- - name: billingInfo.address.location.latitude | type: number | description: Address latitude.
669
- - name: billingInfo.address.location.longitude | type: number | description: Address longitude.
670
- - name: billingInfo.address.postalCode | type: string | description: Postal or zip code.
671
- - name: billingInfo.address.streetAddress | type: StreetAddress | description: Street address.
672
- - name: billingInfo.address.streetAddress.name | type: string | description: Street name.
673
- - name: billingInfo.address.streetAddress.number | type: string | description: Street number.
674
- - name: billingInfo.address.subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
675
- - name: billingInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
676
- - name: billingInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
677
- - name: billingInfo.contactDetails.company | type: string | description: Company name.
678
- - name: billingInfo.contactDetails.firstName | type: string | description: First name.
679
- - name: billingInfo.contactDetails.lastName | type: string | description: Last name.
680
- - name: billingInfo.contactDetails.phone | type: string | description: Phone number.
681
- - name: billingInfo.contactDetails.vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
682
- - name: billingInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
683
- - name: billingInfo.contactDetails.vatId.type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
684
- enum:
348
+ - name: balanceSummary | type: BalanceSummary | description: Balance summary.
349
+ - name: balanceSummary.authorized | type: Price | description: Sum of all authorized payments.
350
+ - name: balanceSummary.balance | type: Balance | description: Current amount left to pay.
351
+ - name: balanceSummary.balance.amount | type: string | description: Balance amount. 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.
352
+ - name: balanceSummary.balance.formattedAmount | type: string | description: Amount formatted with currency symbol.
353
+ - name: balanceSummary.chargeback | type: Price | description: Sum of all transaction chargebacks.
354
+ - name: balanceSummary.chargebackReversal | type: Price | description: Sum of all chargeback reversals.
355
+ - name: balanceSummary.paid | type: Price | description: Sum of all approved and successful payments. The value includes payments that have subsequently been fully or partially refunded.
356
+ - name: balanceSummary.pending | type: Price | description: Sum of all pending transactions.
357
+ - name: balanceSummary.pendingRefund | type: Price | description: Sum of all pending refund transactions.
358
+ - name: balanceSummary.refunded | type: Price | description: Sum of all successfully refunded payments.
359
+ - name: billingInfo | type: AddressWithContact | description: Billing address and contact details.
360
+ - name: billingInfo.address | type: Address | description: Address.
361
+ - name: billingInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
362
+ - name: billingInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
363
+ - name: billingInfo.address.city | type: string | description: City name.
364
+ - name: billingInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
365
+ - name: billingInfo.address.countryFullname | type: string | description: Country's full name.
366
+ - name: billingInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
367
+ - name: billingInfo.address.location.latitude | type: number | description: Address latitude.
368
+ - name: billingInfo.address.location.longitude | type: number | description: Address longitude.
369
+ - name: billingInfo.address.postalCode | type: string | description: Postal or zip code.
370
+ - name: billingInfo.address.streetAddress | type: StreetAddress | description: Street address.
371
+ - name: billingInfo.address.streetAddress.name | type: string | description: Street name.
372
+ - name: billingInfo.address.streetAddress.number | type: string | description: Street number.
373
+ - name: billingInfo.address.subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
374
+ - name: billingInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
375
+ - name: billingInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
376
+ - name: billingInfo.contactDetails.company | type: string | description: Company name.
377
+ - name: billingInfo.contactDetails.firstName | type: string | description: First name.
378
+ - name: billingInfo.contactDetails.lastName | type: string | description: Last name.
379
+ - name: billingInfo.contactDetails.phone | type: string | description: Phone number.
380
+ - name: billingInfo.contactDetails.vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
381
+ - name: billingInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
382
+ - name: billingInfo.contactDetails.vatId.type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
383
+ enum:
685
384
  CNPJ: CNPJ - for corporations
686
385
  CPF: CPF - for individual tax payers.
687
386
  UNSPECIFIED
688
- - name: businessLocation | type: Location | description: Order Location
689
- - name: businessLocation._id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
690
- - name: businessLocation.name | type: string | description: Location name.
691
- - name: buyerInfo | type: BuyerInfo | description: Buyer information.
692
- - name: buyerInfo.contactId | type: string | description: Contact GUID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction).
693
- - name: buyerInfo.email | type: string | description: Buyer email address.
694
- - ONE-OF:
695
- - name: buyerInfo.memberId | type: string | description: Member GUID (if site visitor is a site member).
696
- - name: buyerInfo.visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
697
- - name: buyerLanguage | type: string | description: Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.
698
- - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
699
- - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
700
- - name: channelInfo.externalOrderId | type: string | description: Reference to an order GUID from an external system.
701
- - name: channelInfo.externalOrderUrl | type: string | description: URL to the order in the external system.
702
- - name: channelInfo.type | type: ChannelType | description: Sales channel that submitted the order.
703
- enum:
387
+ - name: businessLocation | type: Location | description: Order Location
388
+ - name: businessLocation._id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
389
+ - name: businessLocation.name | type: string | description: Location name.
390
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
391
+ - name: buyerInfo.contactId | type: string | description: Contact GUID. Auto-created if one does not yet exist. For more information, see [Contacts API](https://www.wix.com/velo/reference/wix-crm-backend/contacts/introduction).
392
+ - name: buyerInfo.email | type: string | description: Buyer email address.
393
+ - ONE-OF:
394
+ - name: buyerInfo.memberId | type: string | description: Member GUID (if site visitor is a site member).
395
+ - name: buyerInfo.visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
396
+ - name: buyerLanguage | type: string | description: Language for communication with the buyer. Defaults to the site language. For a site that supports multiple languages, this is the language the buyer selected.
397
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
398
+ - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
399
+ - name: channelInfo.externalOrderId | type: string | description: Reference to an order GUID from an external system.
400
+ - name: channelInfo.externalOrderUrl | type: string | description: URL to the order in the external system.
401
+ - name: channelInfo.type | type: ChannelType | description: Sales channel that submitted the order.
402
+ enum:
704
403
  AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
705
404
  BACKOFFICE_MERCHANT: Wix merchant backoffice.
706
405
  CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
@@ -718,129 +417,129 @@ Return type: PROMISE<Order>
718
417
  WISH: Wish sales channel.
719
418
  WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
720
419
  WIX_INVOICES: 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)
721
- - name: checkoutId | type: string | description: Checkout GUID.
722
- - name: createdBy | type: CreatedBy | description: GUID of the order's initiator.
723
- - ONE-OF:
724
- - name: createdBy.appId | type: string | description: App GUID - when the order was created by an external application.
725
- - name: createdBy.memberId | type: string | description: Member GUID - when the order was created by a **logged in** site visitor.
726
- - name: createdBy.userId | type: string | description: User GUID - when the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service).
727
- - name: createdBy.visitorId | type: string | description: Visitor GUID - when the order was created by a site visitor that was **not** logged in.
728
- - name: currency | type: string | description: 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.
729
- - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
730
- - name: currencyConversionDetails.conversionRate | type: string | description: The rate used for converting the original currency to the currency used for payment.
731
- - name: currencyConversionDetails.originalCurrency | type: string | description: 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. This currency is used to calculate the pricing before conversion to the buyer's payment currency.
732
- - name: customFields | type: Array<CustomField> | description: Custom fields.
733
- - name: customFields[].title | type: string | description: Custom field title.
734
- - name: customFields[].translatedTitle | type: string | description: Translated custom field title.
735
- - name: customFields[].value | type: any | description: Custom field value.
736
- - name: extendedFields | type: ExtendedFields | description: Custom field data for the order object. [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.
737
- - name: extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
738
- - name: fulfillmentStatus | type: FulfillmentStatus | description: Order fulfillment status.
739
- enum:
420
+ - name: checkoutId | type: string | description: Checkout GUID.
421
+ - name: createdBy | type: CreatedBy | description: GUID of the order's initiator.
422
+ - ONE-OF:
423
+ - name: createdBy.appId | type: string | description: App GUID - when the order was created by an external application.
424
+ - name: createdBy.memberId | type: string | description: Member GUID - when the order was created by a **logged in** site visitor.
425
+ - name: createdBy.userId | type: string | description: User GUID - when the order was created by a Wix user on behalf of a buyer. For example, via POS (point of service).
426
+ - name: createdBy.visitorId | type: string | description: Visitor GUID - when the order was created by a site visitor that was **not** logged in.
427
+ - name: currency | type: string | description: 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.
428
+ - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
429
+ - name: currencyConversionDetails.conversionRate | type: string | description: The rate used for converting the original currency to the currency used for payment.
430
+ - name: currencyConversionDetails.originalCurrency | type: string | description: 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. This currency is used to calculate the pricing before conversion to the buyer's payment currency.
431
+ - name: customFields | type: Array<CustomField> | description: Custom fields.
432
+ - name: customFields[].title | type: string | description: Custom field title.
433
+ - name: customFields[].translatedTitle | type: string | description: Translated custom field title.
434
+ - name: customFields[].value | type: any | description: Custom field value.
435
+ - name: extendedFields | type: ExtendedFields | description: Custom field data for the order object. [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.
436
+ - name: extendedFields.namespaces | type: Record<string, undefined> | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
437
+ - name: fulfillmentStatus | type: FulfillmentStatus | description: Order fulfillment status.
438
+ enum:
740
439
  FULFILLED: All of the order items are fulfilled or the order was manually marked as fulfilled. Orders without shipping info are fulfilled automatically.
741
440
  NOT_FULFILLED: None of the order items are fulfilled or the order was manually marked as unfulfilled.
742
441
  PARTIALLY_FULFILLED: Some, but not all, of the order items are fulfilled.
743
- - name: lineItems | type: Array<OrderLineItem> | description: Order line items.
744
- - name: lineItems[]._id | type: string | description: Line item GUID.
745
- - name: lineItems[].catalogReference | type: CatalogReference | description: Catalog and item reference. Holds GUIDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin.
746
- - name: lineItems[].catalogReference.appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
747
- - name: lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
748
- - name: lineItems[].catalogReference.options | type: Record<string, any> | description: 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. For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
749
- - name: lineItems[].depositAmount | type: Price | description: Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
750
- - name: lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for display purposes for the cart, checkout and order.
751
- - name: lineItems[].descriptionLines[].name | type: DescriptionLineName | description: Description line name.
752
- - name: lineItems[].descriptionLines[].name.original | type: string | description: 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).
753
- - name: lineItems[].descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
754
- - ONE-OF:
755
- - name: lineItems[].descriptionLines[].colorInfo | type: Color | description: Description line color value.
756
- - name: lineItems[].descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
757
- - name: lineItems[].descriptionLines[].colorInfo.original | type: string | description: 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).
758
- - name: lineItems[].descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
759
- - name: lineItems[].descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
760
- - name: lineItems[].descriptionLines[].plainText.original | type: string | description: 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).
761
- - name: lineItems[].descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
762
- - ONE-OF:
763
- - name: lineItems[].digitalFile | type: DigitalFile | description: Digital file identifier, relevant only for items with type DIGITAL.
764
- - name: lineItems[].digitalFile.expirationDate | type: Date | description: Link expiration time and date.
765
- - name: lineItems[].digitalFile.fileId | type: string | description: GUID of the secure file in media.
766
- - name: lineItems[].digitalFile.link | type: string | description: Link will exist after the digital links have been generated on the order.
767
- - name: lineItems[].extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [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.
768
- - name: lineItems[].fulfillerId | type: string | description: Fulfiller GUID. Field is empty when the line item is self-fulfilled. To get fulfillment information, pass the order GUID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
769
- - name: lineItems[].image | type: string | description: Line item image.
770
- - name: lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
771
- - ONE-OF:
772
- - name: lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
773
- - name: lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
442
+ - name: lineItems | type: Array<OrderLineItem> | description: Order line items.
443
+ - name: lineItems[]._id | type: string | description: Line item GUID.
444
+ - name: lineItems[].catalogReference | type: CatalogReference | description: Catalog and item reference. Holds GUIDs for the item and the catalog it came from, as well as further optional info. Optional for custom line items, which don't trigger the Catalog service plugin.
445
+ - name: lineItems[].catalogReference.appId | type: string | description: GUID of the app providing the catalog. You can get your app's GUID from its page in the [app dashboard](https://dev.wix.com/dc3/my-apps/). For items from Wix catalogs, the following values always apply: + Wix Stores: `"215238eb-22a5-4c36-9e7b-e7c08025e04e"` + Wix Bookings: `"13d21c63-b5ec-5912-8397-c3a5ddb27a97"` + Wix Restaurants: `"9a5d83fd-8570-482e-81ab-cfa88942ee60"`
446
+ - name: lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
447
+ - name: lineItems[].catalogReference.options | type: Record<string, any> | description: 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. For products and variants from your Wix Stores catalog, learn more about [eCommerce integration](https://www.wix.com/velo/reference/wix-stores-backend/ecommerce-integration).
448
+ - name: lineItems[].depositAmount | type: Price | description: Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
449
+ - name: lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for display purposes for the cart, checkout and order.
450
+ - name: lineItems[].descriptionLines[].name | type: DescriptionLineName | description: Description line name.
451
+ - name: lineItems[].descriptionLines[].name.original | type: string | description: 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).
452
+ - name: lineItems[].descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
453
+ - ONE-OF:
454
+ - name: lineItems[].descriptionLines[].colorInfo | type: Color | description: Description line color value.
455
+ - name: lineItems[].descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
456
+ - name: lineItems[].descriptionLines[].colorInfo.original | type: string | description: 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).
457
+ - name: lineItems[].descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
458
+ - name: lineItems[].descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
459
+ - name: lineItems[].descriptionLines[].plainText.original | type: string | description: 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).
460
+ - name: lineItems[].descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
461
+ - ONE-OF:
462
+ - name: lineItems[].digitalFile | type: DigitalFile | description: Digital file identifier, relevant only for items with type DIGITAL.
463
+ - name: lineItems[].digitalFile.expirationDate | type: Date | description: Link expiration time and date.
464
+ - name: lineItems[].digitalFile.fileId | type: string | description: GUID of the secure file in media.
465
+ - name: lineItems[].digitalFile.link | type: string | description: Link will exist after the digital links have been generated on the order.
466
+ - name: lineItems[].extendedFields | type: ExtendedFields | description: Custom extended fields for the line item object. [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.
467
+ - name: lineItems[].fulfillerId | type: string | description: Fulfiller GUID. Field is empty when the line item is self-fulfilled. To get fulfillment information, pass the order GUID to [List Fulfillments For Single Order](https://www.wix.com/velo/reference/wix-ecom-backend/orderfulfillments/listfulfillmentsforsingleorder).
468
+ - name: lineItems[].image | type: string | description: Line item image.
469
+ - name: lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
470
+ - ONE-OF:
471
+ - name: lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
472
+ - name: lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
774
473
  enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
775
- - name: lineItems[].locations | type: Array<LocationAndQuantity> | description: Line item locations. The location's total quantity must not exceed the line item quantity.
776
- - name: lineItems[].locations[]._id | type: string | description: Location id in the associated owner app.
777
- - name: lineItems[].locations[].name | type: string | description: Location name.
778
- - name: lineItems[].locations[].quantity | type: number | description: Quantity for specific location.
779
- - name: lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
780
- - name: lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
781
- - name: lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
782
- - name: lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
783
- - name: lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
784
- - name: lineItems[].modifierGroups[].modifiers[].details.original | type: string | description: __Required.__ String 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). Min: 1 character. Max: 200 characters.
785
- - name: lineItems[].modifierGroups[].modifiers[].details.translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
786
- - name: lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
787
- - name: lineItems[].modifierGroups[].modifiers[].price | type: Price | description: The price of the modifier.
788
- - name: lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
789
- - name: lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
790
- - name: lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
791
- enum:
474
+ - name: lineItems[].locations | type: Array<LocationAndQuantity> | description: Line item locations. The location's total quantity must not exceed the line item quantity.
475
+ - name: lineItems[].locations[]._id | type: string | description: Location id in the associated owner app.
476
+ - name: lineItems[].locations[].name | type: string | description: Location name.
477
+ - name: lineItems[].locations[].quantity | type: number | description: Quantity for specific location.
478
+ - name: lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
479
+ - name: lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
480
+ - name: lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
481
+ - name: lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
482
+ - name: lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
483
+ - name: lineItems[].modifierGroups[].modifiers[].details.original | type: string | description: __Required.__ String 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). Min: 1 character. Max: 200 characters.
484
+ - name: lineItems[].modifierGroups[].modifiers[].details.translated | type: string | description: String translated into the buyer's language. Min: 1 character. Max: 400 characters. Default: Same as `original`.
485
+ - name: lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
486
+ - name: lineItems[].modifierGroups[].modifiers[].price | type: Price | description: The price of the modifier.
487
+ - name: lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
488
+ - name: lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
489
+ - name: lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
490
+ enum:
792
491
  DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
793
492
  FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
794
493
  FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
795
494
  MEMBERSHIP: Payment for this item is done by charging a membership. Any remaining amount not covered by the membership, such as item modifiers, is paid online.
796
495
  MEMBERSHIP_OFFLINE: 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`.
797
496
  MEMBERSHIP_ONLINE_WITH_OFFLINE_REMAINDER: Item price is charged to online membership. Any remaining amount not covered by the membership, such as item modifiers, is paid offline.
798
- - name: lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU and item weight.
799
- - name: lineItems[].physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
800
- - name: lineItems[].physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
801
- - name: lineItems[].physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
802
- - name: lineItems[].price | type: Price | description: Line item price after line item discounts for display purposes.
803
- - name: lineItems[].priceBeforeDiscounts | type: Price | description: Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
804
- - name: lineItems[].priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
805
- - name: lineItems[].priceDescription.original | type: string | description: __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).
806
- - name: lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
807
- - name: lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
808
- - name: lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
809
- - name: lineItems[].quantity | type: number | description: Line item quantity.
810
- - name: lineItems[].refundQuantity | type: number | description: Number of items that were refunded.
811
- - name: lineItems[].restockQuantity | type: number | description: Number of items restocked.
812
- - name: lineItems[].subscriptionInfo | type: SubscriptionInfo | description: Subscription info.
813
- - name: lineItems[].subscriptionInfo._id | type: string | description: Subscription GUID.
814
- - name: lineItems[].subscriptionInfo.chargesDescription | type: string | description: Description of the charges that will be applied for subscription.
815
- - name: lineItems[].subscriptionInfo.cycleNumber | type: number | description: Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
816
- - name: lineItems[].subscriptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription detailed information.
817
- - name: lineItems[].subscriptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
818
- - name: lineItems[].subscriptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
819
- - name: lineItems[].subscriptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription.
820
- - name: lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If None => no free trial
821
- - name: lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
497
+ - name: lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU and item weight.
498
+ - name: lineItems[].physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
499
+ - name: lineItems[].physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
500
+ - name: lineItems[].physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
501
+ - name: lineItems[].price | type: Price | description: Line item price after line item discounts for display purposes.
502
+ - name: lineItems[].priceBeforeDiscounts | type: Price | description: Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
503
+ - name: lineItems[].priceDescription | type: PriceDescription | description: Additional description for the price. For example, when price is 0 but additional details about the actual price are needed - "Starts at $67".
504
+ - name: lineItems[].priceDescription.original | type: string | description: __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).
505
+ - name: lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
506
+ - name: lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
507
+ - name: lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
508
+ - name: lineItems[].quantity | type: number | description: Line item quantity.
509
+ - name: lineItems[].refundQuantity | type: number | description: Number of items that were refunded.
510
+ - name: lineItems[].restockQuantity | type: number | description: Number of items restocked.
511
+ - name: lineItems[].subscriptionInfo | type: SubscriptionInfo | description: Subscription info.
512
+ - name: lineItems[].subscriptionInfo._id | type: string | description: Subscription GUID.
513
+ - name: lineItems[].subscriptionInfo.chargesDescription | type: string | description: Description of the charges that will be applied for subscription.
514
+ - name: lineItems[].subscriptionInfo.cycleNumber | type: number | description: Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`.
515
+ - name: lineItems[].subscriptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription detailed information.
516
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
517
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
518
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription.
519
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If None => no free trial
520
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
822
521
  enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
823
- - name: lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
824
- - name: lineItems[].subscriptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
825
- - name: lineItems[].subscriptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment.
826
- - name: lineItems[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a specific line item.
827
- - name: lineItems[].taxableAddress | type: TaxableAddress | description: Address used for tax calculation.
828
- - ONE-OF:
829
- - name: lineItems[].taxableAddress.addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
522
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
523
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
524
+ - name: lineItems[].subscriptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment.
525
+ - name: lineItems[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a specific line item.
526
+ - name: lineItems[].taxableAddress | type: TaxableAddress | description: Address used for tax calculation.
527
+ - ONE-OF:
528
+ - name: lineItems[].taxableAddress.addressType | type: TaxableAddressType | description: taxable address type. if this field is selected, the address is automatically resolved, and the tax is calculated accordingly.
830
529
  enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
831
- - name: lineItems[].totalDiscount | type: Price | description: Total discount for this line item's entire quantity.
832
- - name: lineItems[].totalPriceAfterTax | type: Price | description: Total price after all discounts and tax.
833
- - name: lineItems[].totalPriceBeforeTax | type: Price | description: Total price after discounts, and before tax.
834
- - name: number | type: string | description: Order number displayed in the site owner's dashboard (auto-generated).
835
- - name: payAfterFreeTrial | type: PriceSummary | description: Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
836
- - name: payAfterFreeTrial.discount | type: Price | description: Total calculated discount value.
837
- - name: payAfterFreeTrial.shipping | type: Price | description: Total shipping price, before discounts and before tax.
838
- - name: payAfterFreeTrial.subtotal | type: Price | description: Subtotal of all the line items, before discounts and before tax.
839
- - name: payAfterFreeTrial.tax | type: Price | description: Total tax on this order.
840
- - name: payAfterFreeTrial.total | type: Price | description: Order’s total price after discounts and tax.
841
- - name: payAfterFreeTrial.totalAdditionalFees | type: Price | description: Total price of additional fees before tax.
842
- - name: paymentStatus | type: PaymentStatus | description: Order payment status.
843
- enum:
530
+ - name: lineItems[].totalDiscount | type: Price | description: Total discount for this line item's entire quantity.
531
+ - name: lineItems[].totalPriceAfterTax | type: Price | description: Total price after all discounts and tax.
532
+ - name: lineItems[].totalPriceBeforeTax | type: Price | description: Total price after discounts, and before tax.
533
+ - name: number | type: string | description: Order number displayed in the site owner's dashboard (auto-generated).
534
+ - name: payAfterFreeTrial | type: PriceSummary | description: Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
535
+ - name: payAfterFreeTrial.discount | type: Price | description: Total calculated discount value.
536
+ - name: payAfterFreeTrial.shipping | type: Price | description: Total shipping price, before discounts and before tax.
537
+ - name: payAfterFreeTrial.subtotal | type: Price | description: Subtotal of all the line items, before discounts and before tax.
538
+ - name: payAfterFreeTrial.tax | type: Price | description: Total tax on this order.
539
+ - name: payAfterFreeTrial.total | type: Price | description: Order’s total price after discounts and tax.
540
+ - name: payAfterFreeTrial.totalAdditionalFees | type: Price | description: Total price of additional fees before tax.
541
+ - name: paymentStatus | type: PaymentStatus | description: Order payment status.
542
+ enum:
844
543
  CANCELED: One or more payments canceled.
845
544
  DECLINED: One or more payments declined.
846
545
  FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
@@ -851,69 +550,69 @@ Return type: PROMISE<Order>
851
550
  PENDING: All payments pending. 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. Learn more about [pending orders](https://support.wix.com/en/article/pending-orders).
852
551
  PENDING_MERCHANT: Payment received, but not yet confirmed by the payment provider. In most cases, when a payment provider is holding payment it's because setup hasn't been successfully completed by the merchant/site owner. 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.
853
552
  UNSPECIFIED
854
- - name: priceSummary | type: PriceSummary | description: Order price summary.
855
- - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
856
- - name: purchasedDate | type: Date | description: Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems.
857
- - name: recipientInfo | type: AddressWithContact | description: Order recipient address and contact details. This field may differ from the address in `shippingInfo.logistics` when: + The chosen shipping option is pickup point or store pickup. + No shipping option is selected.
858
- - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
859
- - name: shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
860
- - name: shippingInfo.carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
861
- - name: shippingInfo.code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
862
- - name: shippingInfo.cost | type: ShippingPrice | description: Shipping costs.
863
- - name: shippingInfo.cost.discount | type: Price | description: Shipping discount before tax.
864
- - name: shippingInfo.cost.price | type: Price | description: Shipping price for display purposes.
865
- - name: shippingInfo.cost.taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
866
- - name: shippingInfo.cost.totalPriceAfterTax | type: Price | description: Shipping price after all discounts (if any exist), and after tax.
867
- - name: shippingInfo.cost.totalPriceBeforeTax | type: Price | description: Total price of shipping after discounts (when relevant), and before tax.
868
- - name: shippingInfo.logistics | type: DeliveryLogistics | description: Shipping logistics.
869
- - name: shippingInfo.logistics.deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
870
- - name: shippingInfo.logistics.deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
871
- - name: shippingInfo.logistics.deliveryTimeSlot.from | type: Date | description: Delivery slot starting time.
872
- - name: shippingInfo.logistics.deliveryTimeSlot.to | type: Date | description: Delivery slot ending time.
873
- - name: shippingInfo.logistics.instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
874
- - ONE-OF:
875
- - name: shippingInfo.logistics.pickupDetails | type: PickupDetails | description: Pickup details.
876
- - name: shippingInfo.logistics.pickupDetails.address | type: PickupAddress | description: Pickup address.
877
- - name: shippingInfo.logistics.pickupDetails.address.addressLine1 | type: string | description: Main address line (usually street name and number).
878
- - name: shippingInfo.logistics.pickupDetails.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
879
- - name: shippingInfo.logistics.pickupDetails.address.city | type: string | description: City name.
880
- - name: shippingInfo.logistics.pickupDetails.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
881
- - name: shippingInfo.logistics.pickupDetails.address.countryFullname | type: string | description: Country's full name.
882
- - name: shippingInfo.logistics.pickupDetails.address.postalCode | type: string | description: Postal or zip code.
883
- - name: shippingInfo.logistics.pickupDetails.address.streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
884
- - name: shippingInfo.logistics.pickupDetails.address.subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
885
- - name: shippingInfo.logistics.pickupDetails.address.subdivisionFullname | type: string | description: Subdivision full-name.
886
- - name: shippingInfo.logistics.pickupDetails.pickupMethod | type: PickupMethod | description: Pickup method
553
+ - name: priceSummary | type: PriceSummary | description: Order price summary.
554
+ - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
555
+ - name: purchasedDate | type: Date | description: Date and time the order was originally purchased in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. Used for migration from external systems.
556
+ - name: recipientInfo | type: AddressWithContact | description: Order recipient address and contact details. This field may differ from the address in `shippingInfo.logistics` when: + The chosen shipping option is pickup point or store pickup. + No shipping option is selected.
557
+ - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
558
+ - name: shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
559
+ - name: shippingInfo.carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
560
+ - name: shippingInfo.code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
561
+ - name: shippingInfo.cost | type: ShippingPrice | description: Shipping costs.
562
+ - name: shippingInfo.cost.discount | type: Price | description: Shipping discount before tax.
563
+ - name: shippingInfo.cost.price | type: Price | description: Shipping price for display purposes.
564
+ - name: shippingInfo.cost.taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
565
+ - name: shippingInfo.cost.totalPriceAfterTax | type: Price | description: Shipping price after all discounts (if any exist), and after tax.
566
+ - name: shippingInfo.cost.totalPriceBeforeTax | type: Price | description: Total price of shipping after discounts (when relevant), and before tax.
567
+ - name: shippingInfo.logistics | type: DeliveryLogistics | description: Shipping logistics.
568
+ - name: shippingInfo.logistics.deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
569
+ - name: shippingInfo.logistics.deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
570
+ - name: shippingInfo.logistics.deliveryTimeSlot.from | type: Date | description: Delivery slot starting time.
571
+ - name: shippingInfo.logistics.deliveryTimeSlot.to | type: Date | description: Delivery slot ending time.
572
+ - name: shippingInfo.logistics.instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
573
+ - ONE-OF:
574
+ - name: shippingInfo.logistics.pickupDetails | type: PickupDetails | description: Pickup details.
575
+ - name: shippingInfo.logistics.pickupDetails.address | type: PickupAddress | description: Pickup address.
576
+ - name: shippingInfo.logistics.pickupDetails.address.addressLine1 | type: string | description: Main address line (usually street name and number).
577
+ - name: shippingInfo.logistics.pickupDetails.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
578
+ - name: shippingInfo.logistics.pickupDetails.address.city | type: string | description: City name.
579
+ - name: shippingInfo.logistics.pickupDetails.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
580
+ - name: shippingInfo.logistics.pickupDetails.address.countryFullname | type: string | description: Country's full name.
581
+ - name: shippingInfo.logistics.pickupDetails.address.postalCode | type: string | description: Postal or zip code.
582
+ - name: shippingInfo.logistics.pickupDetails.address.streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
583
+ - name: shippingInfo.logistics.pickupDetails.address.subdivision | type: string | description: Code for a subdivision (such as state, prefecture, or province) in [ISO 3166-2](https://www.iso.org/standard/72483.html) format.
584
+ - name: shippingInfo.logistics.pickupDetails.address.subdivisionFullname | type: string | description: Subdivision full-name.
585
+ - name: shippingInfo.logistics.pickupDetails.pickupMethod | type: PickupMethod | description: Pickup method
887
586
  enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
888
- - name: shippingInfo.logistics.shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
889
- - name: shippingInfo.region | type: ShippingRegion | description: Shipping region.
890
- - name: shippingInfo.region.name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
891
- - name: shippingInfo.title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
892
- - name: siteLanguage | type: string | description: Site language in which original values are shown.
893
- - name: status | type: OrderStatus | description: Order status.
894
- enum:
587
+ - name: shippingInfo.logistics.shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
588
+ - name: shippingInfo.region | type: ShippingRegion | description: Shipping region.
589
+ - name: shippingInfo.region.name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
590
+ - name: shippingInfo.title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
591
+ - name: siteLanguage | type: string | description: Site language in which original values are shown.
592
+ - name: status | type: OrderStatus | description: Order status.
593
+ enum:
895
594
  APPROVED: Order approved. This happens when either an online payment is received **or** when `order.priceSummary.total = 0` (a zero-total order). Offline orders (cash payment) are automatically approved.
896
595
  CANCELED: Order canceled by the user.
897
596
  INITIALIZED: Order created, but not yet approved or canceled.
898
597
  PENDING: Order pending.
899
598
  REJECTED: Order rejected. This happens when pending payments fail.
900
- - name: tags | type: Tags | description: Order tags. [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
901
- - name: tags.privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
902
- - name: tags.privateTags.tagIds | type: Array<string> | description: List of tag GUIDs
903
- - name: tags.tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
904
- - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
905
- - name: taxInfo | type: OrderTaxInfo | description: Tax information.
906
- - name: taxInfo.taxBreakdown | type: Array<OrderTaxBreakdown> | description: 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.
907
- - name: taxInfo.taxBreakdown[].aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
908
- - name: taxInfo.taxBreakdown[].jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
909
- - name: taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
910
- - name: taxInfo.taxBreakdown[].rate | type: string | description: The rate at which this tax detail was calculated.
911
- - name: taxInfo.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated.
912
- - name: taxInfo.taxBreakdown[].taxType | type: string | description: The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
913
- - name: taxInfo.taxExempt | type: boolean | description: Whether the order is exempt from tax calculations. Default: `false`
914
- - name: taxInfo.totalTax | type: Price | description: Calculated tax, added from line items.
915
- - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
916
- enum:
599
+ - name: tags | type: Tags | description: Order tags. [Tags](https://dev.wix.com/docs/rest/business-management/tags/introduction) are labels attached to entities, allowing for flexible categorization and data management.
600
+ - name: tags.privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
601
+ - name: tags.privateTags.tagIds | type: Array<string> | description: List of tag GUIDs
602
+ - name: tags.tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
603
+ - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
604
+ - name: taxInfo | type: OrderTaxInfo | description: Tax information.
605
+ - name: taxInfo.taxBreakdown | type: Array<OrderTaxBreakdown> | description: 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.
606
+ - name: taxInfo.taxBreakdown[].aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
607
+ - name: taxInfo.taxBreakdown[].jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
608
+ - name: taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
609
+ - name: taxInfo.taxBreakdown[].rate | type: string | description: The rate at which this tax detail was calculated.
610
+ - name: taxInfo.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated.
611
+ - name: taxInfo.taxBreakdown[].taxType | type: string | description: The type of tax that was calculated. Depends on the company's nexus settings as well as the jurisdiction's tax laws.
612
+ - name: taxInfo.taxExempt | type: boolean | description: Whether the order is exempt from tax calculations. Default: `false`
613
+ - name: taxInfo.totalTax | type: Price | description: Calculated tax, added from line items.
614
+ - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
615
+ enum:
917
616
  KG: Kilograms.
918
617
  LB: Pounds.
919
618
  UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
@@ -923,4 +622,4 @@ Possible Errors:
923
622
 
924
623
  ```
925
624
  </type_definition>
926
- </ecom_orders_getOrder>
625
+ </ecom_orders_getOrder>