@wix/ditto-codegen-public 1.0.170 → 1.0.171

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 (16) 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/package.json +2 -2
package/dist/docs-output/api-docs/ecom-orders-bulkUpdateOrders-doc.txt CHANGED
@@ -48,7 +48,7 @@ undefined
48
48
 
49
49
  # Method Code Examples:
50
50
 
51
- ## Update multiple orders
51
+ ## Update multiple orders
52
52
 
53
53
  ```javascript
54
54
  import { orders } from "@wix/ecom";
@@ -85,35 +85,9 @@ export async function myBulkUpdateOrders(ordersToUpdate, options) {
85
85
  // Handle the error
86
86
  }
87
87
  }
88
-
89
- /* Promise resolves to:
90
- * {
91
- * "results": [
92
- * {
93
- * "itemMetadata": {
94
- * "id": "efc0f204-d83a-4391-b576-e9cf816f6bc9",
95
- * "originalIndex": 0,
96
- * "success": true
97
- * }
98
- * },
99
- * {
100
- * "itemMetadata": {
101
- * "id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff",
102
- * "originalIndex": 1,
103
- * "success": true
104
- * }
105
- * }
106
- * ],
107
- * "bulkActionMetadata": {
108
- * "totalSuccesses": 2,
109
- * "totalFailures": 0,
110
- * "undetailedFailures": 0
111
- * }
112
- * }
113
- */
114
88
  ```
115
89
 
116
- ## Update multiple orders (with elevated permissions)
90
+ ## Update multiple orders (with elevated permissions)
117
91
 
118
92
  ```javascript
119
93
  import { orders } from "@wix/ecom";
@@ -153,35 +127,9 @@ export async function myBulkUpdateOrders(ordersToUpdate, options) {
153
127
  // Handle the error
154
128
  }
155
129
  }
156
-
157
- /* Promise resolves to:
158
- * {
159
- * "results": [
160
- * {
161
- * "itemMetadata": {
162
- * "id": "efc0f204-d83a-4391-b576-e9cf816f6bc9",
163
- * "originalIndex": 0,
164
- * "success": true
165
- * }
166
- * },
167
- * {
168
- * "itemMetadata": {
169
- * "id": "6bfb7f73-3269-41d6-b396-64f6bb5947ff",
170
- * "originalIndex": 1,
171
- * "success": true
172
- * }
173
- * }
174
- * ],
175
- * "bulkActionMetadata": {
176
- * "totalSuccesses": 2,
177
- * "totalFailures": 0,
178
- * "undetailedFailures": 0
179
- * }
180
- * }
181
- */
182
130
  ```
183
131
 
184
- ## Updates multiple orders from input on the site's page (with $w)
132
+ ## Updates multiple orders from input on the site's page (with $w)
185
133
 
186
134
  ```javascript
187
135
  /***********************************************
@@ -306,99 +254,99 @@ Method: ecom.orders.bulkUpdateOrders(orders, options)
306
254
  Description: Updates up to 100 orders. The `bulkUpdateOrders()` function returns a Promise that resolves when the specified orders' information is updated. Currently, the following fields can be updated: + `order.buyerInfo.email` + `order.buyerLanguage` + `order.weightUnit` + `order.billingInfo.address` + `order.billingInfo.contactDetails` + `order.archived` + `order.attributionSource` + `order.seenByAHuman` + `order.recipientInfo.address` + `order.recipientInfo.contactDetails` + `order.shippingInfo.logistics.shippingDestination.address` + `order.shippingInfo.logistics.shippingDestination.contactDetails` To update a field's value, include the new value in the `orders.order` object in the method parameters. To remove a field's value, pass `null`. > **Note:** Removing `buyerInfo` or `contactDetails` fields results in an error. To update an order's payment status, use [`updatePaymentStatus( )`](https://www.wix.com/velo/reference/wix-ecom-backend/ordertransactions/updatepaymentstatus).
307
255
  Method parameters:
308
256
  param name: orders | type: Array<MaskedOrder> | description: Orders to update. | required: true
309
- - name: order | type: Order | description: Order to be updated.
310
- - name: additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
311
- - name: _id | type: string | description: Additional fee's id.
312
- - name: code | type: string | description: Additional fee's unique code for future processing.
313
- - name: 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.
314
- - name: name | type: string | description: Name of additional fee.
315
- - name: price | type: Price | description: Additional fee's price.
316
- - name: amount | type: string | description: Amount.
317
- - name: priceAfterTax | type: Price | description: Additional fee's price after tax.
318
- - name: priceBeforeTax | type: Price | description: Additional fee's price before tax.
319
- - name: providerAppId | type: string | description: SPI implementer's `appId`.
320
- - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
321
- - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
322
- - name: taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
323
- - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
324
- - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
257
+ - name: order | type: Order | description: Order to be updated.
258
+ - name: additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
259
+ - name: _id | type: string | description: Additional fee's id.
260
+ - name: code | type: string | description: Additional fee's unique code for future processing.
261
+ - name: 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.
262
+ - name: name | type: string | description: Name of additional fee.
263
+ - name: price | type: Price | description: Additional fee's price.
264
+ - name: amount | type: string | description: Amount.
265
+ - name: priceAfterTax | type: Price | description: Additional fee's price after tax.
266
+ - name: priceBeforeTax | type: Price | description: Additional fee's price before tax.
267
+ - name: providerAppId | type: string | description: SPI implementer's `appId`.
268
+ - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
269
+ - name: taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
270
+ - name: taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
271
+ - name: jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
272
+ - name: jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
325
273
  enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
326
- - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
327
- - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
328
- - name: taxAmount | type: Price | description: Amount of tax calculated for this line item.
329
- - name: 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.
330
- - name: 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.
331
- - name: taxableAmount | type: Price | description: Taxable amount of the line item price.
332
- - name: taxGroupId | type: string | description: Tax group GUID.
333
- - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
334
- - name: taxRate | type: string | description: Tax rate %, as a decimal point.
335
- - name: taxableAmount | type: Price | description: Amount for which tax is calculated.
336
- - name: appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
337
- - name: _id | type: string | description: Discount id.
338
- - name: 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.
274
+ - name: nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
275
+ - name: rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
276
+ - name: taxAmount | type: Price | description: Amount of tax calculated for this line item.
277
+ - name: 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.
278
+ - name: 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.
279
+ - name: taxableAmount | type: Price | description: Taxable amount of the line item price.
280
+ - name: taxGroupId | type: string | description: Tax group GUID.
281
+ - name: taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
282
+ - name: taxRate | type: string | description: Tax rate %, as a decimal point.
283
+ - name: taxableAmount | type: Price | description: Amount for which tax is calculated.
284
+ - name: appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
285
+ - name: _id | type: string | description: Discount id.
286
+ - name: 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.
339
287
  enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
340
- - ONE-OF:
341
- - name: coupon | type: Coupon | description: Applied coupon info.
342
- - name: _id | type: string | description: Coupon GUID.
343
- - name: amount | type: Price | description: Coupon value.
344
- - name: code | type: string | description: Coupon code.
345
- - name: name | type: string | description: Coupon name.
346
- - name: discountRule | type: DiscountRule | description: Automatic Discount
347
- - name: _id | type: string | description: Discount rule GUID
348
- - name: amount | type: Price | description: Discount value.
349
- - name: name | type: DiscountRuleName | description: Discount rule name
350
- - name: original | type: string | description: Original discount rule name (in site's default language).
351
- - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
352
- - name: merchantDiscount | type: MerchantDiscount | description: Merchant discount.
353
- - name: amount | type: Price | description: Discount amount.
354
- - ONE-OF:
355
- - name: description | type: string | description: Discount description as free text (optional).
356
- - name: discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
288
+ - ONE-OF:
289
+ - name: coupon | type: Coupon | description: Applied coupon info.
290
+ - name: _id | type: string | description: Coupon GUID.
291
+ - name: amount | type: Price | description: Coupon value.
292
+ - name: code | type: string | description: Coupon code.
293
+ - name: name | type: string | description: Coupon name.
294
+ - name: discountRule | type: DiscountRule | description: Automatic Discount
295
+ - name: _id | type: string | description: Discount rule GUID
296
+ - name: amount | type: Price | description: Discount value.
297
+ - name: name | type: DiscountRuleName | description: Discount rule name
298
+ - name: original | type: string | description: Original discount rule name (in site's default language).
299
+ - name: translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
300
+ - name: merchantDiscount | type: MerchantDiscount | description: Merchant discount.
301
+ - name: amount | type: Price | description: Discount amount.
302
+ - ONE-OF:
303
+ - name: description | type: string | description: Discount description as free text (optional).
304
+ - name: discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
357
305
  enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
358
- - name: archived | type: boolean | description: Whether order is archived.
359
- - name: attributionSource | type: AttributionSource | description: Order attribution source.
306
+ - name: archived | type: boolean | description: Whether order is archived.
307
+ - name: attributionSource | type: AttributionSource | description: Order attribution source.
360
308
  enum: FACEBOOK_ADS, UNSPECIFIED
361
- - name: billingInfo | type: AddressWithContact | description: Billing address and contact details.
362
- - name: address | type: Address | description: Address.
363
- - name: addressLine1 | type: string | description: Main address line (usually street name and number).
364
- - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
365
- - name: city | type: string | description: City name.
366
- - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
367
- - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
368
- - name: latitude | type: number | description: Address latitude.
369
- - name: longitude | type: number | description: Address longitude.
370
- - name: postalCode | type: string | description: Postal or zip code.
371
- - name: streetAddress | type: StreetAddress | description: Street address.
372
- - name: name | type: string | description: Street name.
373
- - name: number | type: string | description: Street number.
374
- - name: 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.
375
- - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
376
- - name: company | type: string | description: Company name.
377
- - name: firstName | type: string | description: First name.
378
- - name: lastName | type: string | description: Last name.
379
- - name: phone | type: string | description: Phone number.
380
- - name: 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: _id | type: string | description: Customer's tax GUID.
382
- - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
383
- enum:
309
+ - name: billingInfo | type: AddressWithContact | description: Billing address and contact details.
310
+ - name: address | type: Address | description: Address.
311
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
312
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
313
+ - name: city | type: string | description: City name.
314
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
315
+ - name: location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
316
+ - name: latitude | type: number | description: Address latitude.
317
+ - name: longitude | type: number | description: Address longitude.
318
+ - name: postalCode | type: string | description: Postal or zip code.
319
+ - name: streetAddress | type: StreetAddress | description: Street address.
320
+ - name: name | type: string | description: Street name.
321
+ - name: number | type: string | description: Street number.
322
+ - name: 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.
323
+ - name: contactDetails | type: FullAddressContactDetails | description: Contact details.
324
+ - name: company | type: string | description: Company name.
325
+ - name: firstName | type: string | description: First name.
326
+ - name: lastName | type: string | description: Last name.
327
+ - name: phone | type: string | description: Phone number.
328
+ - name: vatId | type: VatId | description: Tax information (for Brazil only). If GUID is provided, `vatId.type` must also be set, `UNSPECIFIED` is not allowed.
329
+ - name: _id | type: string | description: Customer's tax GUID.
330
+ - name: type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
331
+ enum:
384
332
  CNPJ: CNPJ - for corporations
385
333
  CPF: CPF - for individual tax payers.
386
334
  UNSPECIFIED
387
- - name: businessLocation | type: Location | description: Order Location
388
- - name: _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: buyerInfo | type: BuyerInfo | description: Buyer information.
390
- - name: 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).
391
- - name: email | type: string | description: Buyer email address.
392
- - ONE-OF:
393
- - name: memberId | type: string | description: Member GUID (if site visitor is a site member).
394
- - name: visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
395
- - 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.
396
- - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
397
- - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
398
- - name: externalOrderId | type: string | description: Reference to an order GUID from an external system.
399
- - name: externalOrderUrl | type: string | description: URL to the order in the external system.
400
- - name: type | type: ChannelType | description: Sales channel that submitted the order.
401
- enum:
335
+ - name: businessLocation | type: Location | description: Order Location
336
+ - name: _id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
337
+ - name: buyerInfo | type: BuyerInfo | description: Buyer information.
338
+ - name: 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).
339
+ - name: email | type: string | description: Buyer email address.
340
+ - ONE-OF:
341
+ - name: memberId | type: string | description: Member GUID (if site visitor is a site member).
342
+ - name: visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
343
+ - 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.
344
+ - name: buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
345
+ - name: channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
346
+ - name: externalOrderId | type: string | description: Reference to an order GUID from an external system.
347
+ - name: externalOrderUrl | type: string | description: URL to the order in the external system.
348
+ - name: type | type: ChannelType | description: Sales channel that submitted the order.
349
+ enum:
402
350
  AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
403
351
  BACKOFFICE_MERCHANT: Wix merchant backoffice.
404
352
  CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
@@ -416,17 +364,17 @@ Method parameters:
416
364
  WISH: Wish sales channel.
417
365
  WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
418
366
  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)
419
- - name: checkoutId | type: string | description: Checkout GUID.
420
- - 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.
421
- - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
422
- - name: customFields | type: Array<CustomField> | description: Custom fields.
423
- - name: title | type: string | description: Custom field title.
424
- - name: translatedTitle | type: string | description: Translated custom field title.
425
- - name: value | type: any | description: Custom field value.
426
- - 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.
427
- - name: 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).
428
- - name: paymentStatus | type: PaymentStatus | description: Order payment status.
429
- enum:
367
+ - name: checkoutId | type: string | description: Checkout GUID.
368
+ - 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.
369
+ - name: currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
370
+ - name: customFields | type: Array<CustomField> | description: Custom fields.
371
+ - name: title | type: string | description: Custom field title.
372
+ - name: translatedTitle | type: string | description: Translated custom field title.
373
+ - name: value | type: any | description: Custom field value.
374
+ - 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.
375
+ - name: 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).
376
+ - name: paymentStatus | type: PaymentStatus | description: Order payment status.
377
+ enum:
430
378
  CANCELED: One or more payments canceled.
431
379
  DECLINED: One or more payments declined.
432
380
  FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
@@ -437,81 +385,81 @@ Method parameters:
437
385
  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).
438
386
  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.
439
387
  UNSPECIFIED
440
- - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
441
- - 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.
442
- - 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.
443
- - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
444
- - name: shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
445
- - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
446
- - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
447
- - name: cost | type: ShippingPrice | description: Shipping costs.
448
- - name: price | type: Price | description: Shipping price for display purposes.
449
- - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
450
- - name: logistics | type: DeliveryLogistics | description: Shipping logistics.
451
- - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
452
- - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
453
- - name: from | type: Date | description: Delivery slot starting time.
454
- - name: to | type: Date | description: Delivery slot ending time.
455
- - name: instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
456
- - ONE-OF:
457
- - name: pickupDetails | type: PickupDetails | description: Pickup details.
458
- - name: address | type: PickupAddress | description: Pickup address.
459
- - name: addressLine1 | type: string | description: Main address line (usually street name and number).
460
- - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
461
- - name: city | type: string | description: City name.
462
- - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
463
- - name: postalCode | type: string | description: Postal or zip code.
464
- - name: streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
465
- - name: 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.
466
- - name: pickupMethod | type: PickupMethod | description: Pickup method
388
+ - name: purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
389
+ - 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.
390
+ - 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.
391
+ - name: seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
392
+ - name: shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
393
+ - name: carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
394
+ - name: code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
395
+ - name: cost | type: ShippingPrice | description: Shipping costs.
396
+ - name: price | type: Price | description: Shipping price for display purposes.
397
+ - name: taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
398
+ - name: logistics | type: DeliveryLogistics | description: Shipping logistics.
399
+ - name: deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
400
+ - name: deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
401
+ - name: from | type: Date | description: Delivery slot starting time.
402
+ - name: to | type: Date | description: Delivery slot ending time.
403
+ - name: instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
404
+ - ONE-OF:
405
+ - name: pickupDetails | type: PickupDetails | description: Pickup details.
406
+ - name: address | type: PickupAddress | description: Pickup address.
407
+ - name: addressLine1 | type: string | description: Main address line (usually street name and number).
408
+ - name: addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
409
+ - name: city | type: string | description: City name.
410
+ - name: country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
411
+ - name: postalCode | type: string | description: Postal or zip code.
412
+ - name: streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
413
+ - name: 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.
414
+ - name: pickupMethod | type: PickupMethod | description: Pickup method
467
415
  enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
468
- - name: shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
469
- - name: region | type: ShippingRegion | description: Shipping region.
470
- - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
471
- - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
472
- - name: status | type: OrderStatus | description: Order status.
473
- enum:
416
+ - name: shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
417
+ - name: region | type: ShippingRegion | description: Shipping region.
418
+ - name: name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
419
+ - name: title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
420
+ - name: status | type: OrderStatus | description: Order status.
421
+ enum:
474
422
  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.
475
423
  CANCELED: Order canceled by the user.
476
424
  INITIALIZED: Order created, but not yet approved or canceled.
477
425
  PENDING: Order pending.
478
426
  REJECTED: Order rejected. This happens when pending payments fail.
479
- - 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.
480
- - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
481
- - name: tagIds | type: Array<string> | description: List of tag GUIDs
482
- - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
483
- - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
484
- - name: taxInfo | type: OrderTaxInfo | description: Tax information.
485
- - name: 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.
486
- - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
487
- - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
488
- - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
489
- - name: rate | type: string | description: The rate at which this tax detail was calculated.
490
- - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated.
491
- - name: 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.
492
- - name: totalTax | type: Price | description: Calculated tax, added from line items.
493
- - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
494
- enum:
427
+ - 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.
428
+ - name: privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
429
+ - name: tagIds | type: Array<string> | description: List of tag GUIDs
430
+ - name: tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
431
+ - name: taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
432
+ - name: taxInfo | type: OrderTaxInfo | description: Tax information.
433
+ - name: 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.
434
+ - name: aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
435
+ - name: jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
436
+ - name: jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
437
+ - name: rate | type: string | description: The rate at which this tax detail was calculated.
438
+ - name: taxName | type: string | description: The name of the tax against which this tax amount was calculated.
439
+ - name: 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.
440
+ - name: totalTax | type: Price | description: Calculated tax, added from line items.
441
+ - name: weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
442
+ enum:
495
443
  KG: Kilograms.
496
444
  LB: Pounds.
497
445
  UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
498
- param name: options | type: BulkUpdateOrdersOptions | description: none
499
- - name: returnEntity | type: boolean | description: Whether to return the full order entities. Default: `false`
446
+ param name: options | type: BulkUpdateOrdersOptions | description: none
447
+ - name: returnEntity | type: boolean | description: Whether to return the full order entities. Default: `false`
500
448
  Return type: PROMISE<BulkUpdateOrdersResponse>
501
- - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata.
502
- - name: bulkActionMetadata.totalFailures | type: number | description: Number of items that couldn't be processed.
503
- - name: bulkActionMetadata.totalSuccesses | type: number | description: Number of items that were successfully processed.
504
- - name: bulkActionMetadata.undetailedFailures | type: number | description: Number of failures without details because detailed failure threshold was exceeded.
505
- - name: results | type: Array<BulkOrderResult> | description: Bulk action results.
506
- - name: results[].item | type: Order | description: Updated order. Returned when `returnFullEntity = true`.
507
- - name: results[].item._createdDate | type: Date | description: Date and time the order was created.
508
- - name: results[].item._id | type: string | description: Order GUID.
509
- - name: results[].item._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.
510
- - name: results[].item.activities | type: Array<Activity> | description: Order activities.
511
- - name: results[].item.activities[]._createdDate | type: Date | description: Activity creation date and time.
512
- - name: results[].item.activities[]._id | type: string | description: Activity GUID.
513
- - name: results[].item.activities[].activityType | type: OrderActivityTypeEnumActivityType | description: Activity type.
514
- enum:
449
+ - name: bulkActionMetadata | type: BulkActionMetadata | description: Bulk action metadata.
450
+ - name: bulkActionMetadata.totalFailures | type: number | description: Number of items that couldn't be processed.
451
+ - name: bulkActionMetadata.totalSuccesses | type: number | description: Number of items that were successfully processed.
452
+ - name: bulkActionMetadata.undetailedFailures | type: number | description: Number of failures without details because detailed failure threshold was exceeded.
453
+ - name: results | type: Array<BulkOrderResult> | description: Bulk action results.
454
+ - name: results[].item | type: Order | description: Updated order. Returned when `returnFullEntity = true`.
455
+ - name: results[].item._createdDate | type: Date | description: Date and time the order was created.
456
+ - name: results[].item._id | type: string | description: Order GUID.
457
+ - name: results[].item._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.
458
+ - name: results[].item.activities | type: Array<Activity> | description: Order activities.
459
+ - name: results[].item.activities[]._createdDate | type: Date | description: Activity creation date and time.
460
+ - name: results[].item.activities[]._id | type: string | description: Activity GUID.
461
+ - name: results[].item.activities[].activityType | type: OrderActivityTypeEnumActivityType | description: Activity type.
462
+ enum:
515
463
  AUTHORIZED_PAYMENT_CAPTURED: Previously authorized payment was captured.
516
464
  AUTHORIZED_PAYMENT_CREATED: Payment was authorized but not yet captured.
517
465
  AUTHORIZED_PAYMENT_VOIDED: Previously authorized payment was voided.
@@ -554,262 +502,262 @@ Return type: PROMISE<BulkUpdateOrdersResponse>
554
502
  TRACKING_NUMBER_ADDED: Shipping tracking number was added to the order.
555
503
  TRACKING_NUMBER_EDITED: Existing shipping tracking number was modified.
556
504
  UNKNOWN_ACTIVITY_TYPE: Default value. This value is unused.
557
- - name: results[].item.activities[].authorEmail | type: string | description: Activity author's email.
558
- - ONE-OF:
559
- - name: results[].item.activities[].authorizedPaymentCaptured | type: AuthorizedPaymentCaptured | description: Details of an authorized payment captured.
560
- - name: results[].item.activities[].authorizedPaymentCaptured.amount | type: Price | description: Payment amount
561
- - name: results[].item.activities[].authorizedPaymentCaptured.amount.amount | type: string | description: Amount.
562
- - name: results[].item.activities[].authorizedPaymentCaptured.amount.formattedAmount | type: string | description: Amount formatted with currency symbol.
563
- - name: results[].item.activities[].authorizedPaymentCaptured.brand | type: string | description: Card issuer's brand.
564
- - name: results[].item.activities[].authorizedPaymentCaptured.lastFourDigits | type: string | description: The last 4 digits of the card number.
565
- - name: results[].item.activities[].authorizedPaymentCaptured.paymentId | type: string | description: Payment GUID of payment associated with this activity
566
- - name: results[].item.activities[].authorizedPaymentCreated | type: AuthorizedPaymentCreated | description: Details of an authorized payment created.
567
- - name: results[].item.activities[].authorizedPaymentCreated.amount | type: Price | description: Payment amount
568
- - name: results[].item.activities[].authorizedPaymentCreated.brand | type: string | description: Card issuer's brand.
569
- - name: results[].item.activities[].authorizedPaymentCreated.lastFourDigits | type: string | description: The last 4 digits of the card number.
570
- - name: results[].item.activities[].authorizedPaymentCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
571
- - name: results[].item.activities[].authorizedPaymentVoided | type: AuthorizedPaymentVoided | description: Details of an authorized payment voided.
572
- - name: results[].item.activities[].authorizedPaymentVoided.amount | type: Price | description: Payment amount
573
- - name: results[].item.activities[].authorizedPaymentVoided.brand | type: string | description: Card issuer's brand.
574
- - name: results[].item.activities[].authorizedPaymentVoided.lastFourDigits | type: string | description: The last 4 digits of the card number.
575
- - name: results[].item.activities[].authorizedPaymentVoided.paymentId | type: string | description: Payment GUID of payment associated with this activity
576
- - name: results[].item.activities[].chargebackCreated | type: ChargebackCreated | description: Order received a chargeback for one of its' payments.
577
- - name: results[].item.activities[].chargebackCreated.amount | type: Price | description: Chargeback amount.
578
- - name: results[].item.activities[].chargebackCreated.chargebackId | type: string | description: Chargeback GUID.
579
- - name: results[].item.activities[].chargebackCreated.paymentDetails | type: RegularPayment | description: Payment details.
580
- - name: results[].item.activities[].chargebackCreated.paymentDetails.amount | type: Price | description: Payment amount
581
- - ONE-OF:
582
- - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails | type: CreditCardDetails | description: Whether regular card used
583
- - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails.brand | type: string | description: Card issuer's brand.
584
- - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails.lastFourDigits | type: string | description: The last 4 digits of the card number.
585
- - name: results[].item.activities[].chargebackCreated.paymentId | type: string | description: GUID of the payment that received a chargeback.
586
- - name: results[].item.activities[].chargebackReversed | type: ChargebackReversed | description: Chargeback reversed for one of the order's payments.
587
- - name: results[].item.activities[].chargebackReversed.amount | type: Price | description: Chargeback amount.
588
- - name: results[].item.activities[].chargebackReversed.chargebackId | type: string | description: Chargeback GUID.
589
- - name: results[].item.activities[].chargebackReversed.paymentDetails | type: RegularPayment | description: Payment details.
590
- - name: results[].item.activities[].chargebackReversed.paymentId | type: string | description: GUID of the payment involved with the chargeback.
591
- - name: results[].item.activities[].chargebackReversed.reversalAmount | type: Price | description: Chargeback reversal amount.
592
- - name: results[].item.activities[].customActivity | type: CustomActivity | description: Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`.
593
- - name: results[].item.activities[].customActivity.additionalData | type: Record<string, string> | description: Additional data in key-value form. For example, `{ "Ticket number": "123456" }`.
594
- - name: results[].item.activities[].customActivity.appId | type: string | description: GUID of the app that created the custom activity.
595
- - name: results[].item.activities[].customActivity.type | type: string | description: Custom activity type. For example, `"Ticket number set"`.
596
- - name: results[].item.activities[].draftOrderChangesApplied | type: DraftOrderChangesApplied | description: Details of changes made by the Draft Orders API.
597
- - name: results[].item.activities[].draftOrderChangesApplied.changes | type: Array<OrderChange> | description: Changes applied to order.
598
- - ONE-OF:
599
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded | type: ManagedAdditionalFee | description: none
600
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded._id | type: string | description: Additional fee id.
601
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items additional fee applies to.
602
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[]._id | type: string | description: Order line item id
603
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].amount | type: Price | description: Amount associated with this item. (Discount amount for item / additional fee amount for item)
604
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name | type: ProductName | description: Item name.
605
- - name: results[].item.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.
606
- - name: results[].item.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`.
607
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name | type: TranslatedValue | description: Additional fee name.
608
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.original | type: string | description: Value in site default language.
609
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.translated | type: string | description: Translated value.
610
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.totalAmount | type: Price | description: Additional fee amount.
611
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeRemoved | type: ManagedAdditionalFee | description: none
612
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded | type: ManagedDiscount | description: none
613
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded._id | type: string | description: Discount id.
614
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items discount applies to.
615
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.name | type: TranslatedValue | description: Discount name: coupon name / discount rule name / merchant discount description.
616
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.totalAmount | type: Price | description: Discount amount.
617
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountRemoved | type: ManagedDiscount | description: none
618
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded | type: ManagedLineItem | description: none
619
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded._id | type: string | description: Line item GUID.
620
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded.name | type: ProductName | description: Item name.
621
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded.quantity | type: number | description: Added or removed item quantity.
622
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged | type: LineItemChanges | description: none
623
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged._id | type: string | description: Line item GUID.
624
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.name | type: ProductName | description: Item name after change.
625
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price | type: LineItemPriceChange | description: Item price change.
626
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.newPrice | type: Price | description: Item price after update.
627
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.originalPrice | type: Price | description: Item price before update.
628
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity | type: LineItemQuantityChange | description: Item quantity change.
629
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.deltaType | type: LineItemQuantityChangeType | description: Type of quantity change: increase or decrease.
630
- enum:
505
+ - name: results[].item.activities[].authorEmail | type: string | description: Activity author's email.
506
+ - ONE-OF:
507
+ - name: results[].item.activities[].authorizedPaymentCaptured | type: AuthorizedPaymentCaptured | description: Details of an authorized payment captured.
508
+ - name: results[].item.activities[].authorizedPaymentCaptured.amount | type: Price | description: Payment amount
509
+ - name: results[].item.activities[].authorizedPaymentCaptured.amount.amount | type: string | description: Amount.
510
+ - name: results[].item.activities[].authorizedPaymentCaptured.amount.formattedAmount | type: string | description: Amount formatted with currency symbol.
511
+ - name: results[].item.activities[].authorizedPaymentCaptured.brand | type: string | description: Card issuer's brand.
512
+ - name: results[].item.activities[].authorizedPaymentCaptured.lastFourDigits | type: string | description: The last 4 digits of the card number.
513
+ - name: results[].item.activities[].authorizedPaymentCaptured.paymentId | type: string | description: Payment GUID of payment associated with this activity
514
+ - name: results[].item.activities[].authorizedPaymentCreated | type: AuthorizedPaymentCreated | description: Details of an authorized payment created.
515
+ - name: results[].item.activities[].authorizedPaymentCreated.amount | type: Price | description: Payment amount
516
+ - name: results[].item.activities[].authorizedPaymentCreated.brand | type: string | description: Card issuer's brand.
517
+ - name: results[].item.activities[].authorizedPaymentCreated.lastFourDigits | type: string | description: The last 4 digits of the card number.
518
+ - name: results[].item.activities[].authorizedPaymentCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
519
+ - name: results[].item.activities[].authorizedPaymentVoided | type: AuthorizedPaymentVoided | description: Details of an authorized payment voided.
520
+ - name: results[].item.activities[].authorizedPaymentVoided.amount | type: Price | description: Payment amount
521
+ - name: results[].item.activities[].authorizedPaymentVoided.brand | type: string | description: Card issuer's brand.
522
+ - name: results[].item.activities[].authorizedPaymentVoided.lastFourDigits | type: string | description: The last 4 digits of the card number.
523
+ - name: results[].item.activities[].authorizedPaymentVoided.paymentId | type: string | description: Payment GUID of payment associated with this activity
524
+ - name: results[].item.activities[].chargebackCreated | type: ChargebackCreated | description: Order received a chargeback for one of its' payments.
525
+ - name: results[].item.activities[].chargebackCreated.amount | type: Price | description: Chargeback amount.
526
+ - name: results[].item.activities[].chargebackCreated.chargebackId | type: string | description: Chargeback GUID.
527
+ - name: results[].item.activities[].chargebackCreated.paymentDetails | type: RegularPayment | description: Payment details.
528
+ - name: results[].item.activities[].chargebackCreated.paymentDetails.amount | type: Price | description: Payment amount
529
+ - ONE-OF:
530
+ - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails | type: CreditCardDetails | description: Whether regular card used
531
+ - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails.brand | type: string | description: Card issuer's brand.
532
+ - name: results[].item.activities[].chargebackCreated.paymentDetails.creditCardDetails.lastFourDigits | type: string | description: The last 4 digits of the card number.
533
+ - name: results[].item.activities[].chargebackCreated.paymentId | type: string | description: GUID of the payment that received a chargeback.
534
+ - name: results[].item.activities[].chargebackReversed | type: ChargebackReversed | description: Chargeback reversed for one of the order's payments.
535
+ - name: results[].item.activities[].chargebackReversed.amount | type: Price | description: Chargeback amount.
536
+ - name: results[].item.activities[].chargebackReversed.chargebackId | type: string | description: Chargeback GUID.
537
+ - name: results[].item.activities[].chargebackReversed.paymentDetails | type: RegularPayment | description: Payment details.
538
+ - name: results[].item.activities[].chargebackReversed.paymentId | type: string | description: GUID of the payment involved with the chargeback.
539
+ - name: results[].item.activities[].chargebackReversed.reversalAmount | type: Price | description: Chargeback reversal amount.
540
+ - name: results[].item.activities[].customActivity | type: CustomActivity | description: Custom activity details (optional). `activity.type` must be `CUSTOM_ACTIVITY`.
541
+ - name: results[].item.activities[].customActivity.additionalData | type: Record<string, string> | description: Additional data in key-value form. For example, `{ "Ticket number": "123456" }`.
542
+ - name: results[].item.activities[].customActivity.appId | type: string | description: GUID of the app that created the custom activity.
543
+ - name: results[].item.activities[].customActivity.type | type: string | description: Custom activity type. For example, `"Ticket number set"`.
544
+ - name: results[].item.activities[].draftOrderChangesApplied | type: DraftOrderChangesApplied | description: Details of changes made by the Draft Orders API.
545
+ - name: results[].item.activities[].draftOrderChangesApplied.changes | type: Array<OrderChange> | description: Changes applied to order.
546
+ - ONE-OF:
547
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded | type: ManagedAdditionalFee | description: none
548
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded._id | type: string | description: Additional fee id.
549
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items additional fee applies to.
550
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[]._id | type: string | description: Order line item id
551
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].amount | type: Price | description: Amount associated with this item. (Discount amount for item / additional fee amount for item)
552
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.affectedLineItems[].name | type: ProductName | description: Item name.
553
+ - name: results[].item.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.
554
+ - name: results[].item.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`.
555
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name | type: TranslatedValue | description: Additional fee name.
556
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.original | type: string | description: Value in site default language.
557
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.name.translated | type: string | description: Translated value.
558
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeAdded.totalAmount | type: Price | description: Additional fee amount.
559
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].additionalFeeRemoved | type: ManagedAdditionalFee | description: none
560
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded | type: ManagedDiscount | description: none
561
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded._id | type: string | description: Discount id.
562
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.affectedLineItems | type: Array<LineItemAmount> | description: Line items discount applies to.
563
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.name | type: TranslatedValue | description: Discount name: coupon name / discount rule name / merchant discount description.
564
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountAdded.totalAmount | type: Price | description: Discount amount.
565
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].discountRemoved | type: ManagedDiscount | description: none
566
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded | type: ManagedLineItem | description: none
567
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded._id | type: string | description: Line item GUID.
568
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded.name | type: ProductName | description: Item name.
569
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemAdded.quantity | type: number | description: Added or removed item quantity.
570
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged | type: LineItemChanges | description: none
571
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged._id | type: string | description: Line item GUID.
572
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.name | type: ProductName | description: Item name after change.
573
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price | type: LineItemPriceChange | description: Item price change.
574
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.newPrice | type: Price | description: Item price after update.
575
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.price.originalPrice | type: Price | description: Item price before update.
576
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity | type: LineItemQuantityChange | description: Item quantity change.
577
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.deltaType | type: LineItemQuantityChangeType | description: Type of quantity change: increase or decrease.
578
+ enum:
631
579
  QUANTITY_DECREASED: Quantity decreased.
632
580
  QUANTITY_INCREASED: Quantity increased.
633
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.diff | type: number | description: Difference between original and new quantity. Absolute value.
634
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.newQuantity | type: number | description: Item quantity after update.
635
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.originalQuantity | type: number | description: Item quantity before update.
636
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemRemoved | type: ManagedLineItem | description: none
637
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged | type: ShippingInformationChange | description: none
638
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. After update
639
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.shippingTitle | type: string | description: Order’s shipping title.
640
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.total | type: Price | description: Order’s shipping price.
641
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.originalShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. Before update
642
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged | type: TotalPriceChange | description: none
643
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged.newTotal | type: Price | description: Order’s total price after discounts and tax. After update
644
- - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged.originalTotal | type: Price | description: Order’s total price after discounts and tax. Before update
645
- - name: results[].item.activities[].draftOrderChangesApplied.draftOrderId | type: string | description: Draft order id.
646
- - name: results[].item.activities[].draftOrderChangesApplied.reason | type: string | description: Reason for edit, given by user (optional).
647
- - name: results[].item.activities[].merchantComment | type: MerchantComment | description: Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`.
648
- - name: results[].item.activities[].merchantComment.message | type: string | description: Merchant comment message.
649
- - name: results[].item.activities[].orderRefunded | type: OrderRefunded | description: Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`.
650
- - name: results[].item.activities[].orderRefunded.amount | type: Price | description: Refund amount.
651
- - name: results[].item.activities[].orderRefunded.manual | type: boolean | description: Whether order was refunded manually. For example, via payment provider or using cash.
652
- - name: results[].item.activities[].orderRefunded.reason | type: string | description: Reason for refund.
653
- - name: results[].item.activities[].paymentCanceled | type: PaymentCanceled | description: Details of a canceled payment.
654
- - name: results[].item.activities[].paymentCanceled.paymentId | type: string | description: Payment GUID of payment associated with this activity
655
- - ONE-OF:
656
- - name: results[].item.activities[].paymentCanceled.regular | type: RegularPayment | description: Regular payment.
657
- - name: results[].item.activities[].paymentDeclined | type: PaymentDeclined | description: Details of a declined payment.
658
- - name: results[].item.activities[].paymentDeclined.paymentId | type: string | description: Payment GUID of payment associated with this activity
659
- - ONE-OF:
660
- - name: results[].item.activities[].paymentDeclined.regular | type: RegularPayment | description: Regular payment.
661
- - name: results[].item.activities[].paymentPending | type: PaymentPending | description: Details of a pending payment.
662
- - name: results[].item.activities[].paymentPending.paymentId | type: string | description: Payment GUID of payment associated with this activity
663
- - ONE-OF:
664
- - name: results[].item.activities[].paymentPending.regular | type: RegularPayment | description: Regular payment.
665
- - name: results[].item.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.
666
- - name: results[].item.activities[].paymentRefundFailed.payment | type: RefundedPayment | description: Details about the failed payment refund.
667
- - name: results[].item.activities[].paymentRefundFailed.payment.externalRefund | type: boolean | description: Whether refund was made externally and manually on the payment provider's side.
668
- - name: results[].item.activities[].paymentRefundFailed.payment.paymentId | type: string | description: Payment GUID.
669
- - ONE-OF:
670
- - name: results[].item.activities[].paymentRefundFailed.payment.giftCard | type: GiftCardPaymentRefund | description: Gift card payment refund.
671
- - name: results[].item.activities[].paymentRefundFailed.payment.giftCard.amount | type: Price | description: Refund amount
672
- - name: results[].item.activities[].paymentRefundFailed.payment.giftCard.giftCardPaymentId | type: string | description: Gift card payment GUID
673
- - name: results[].item.activities[].paymentRefundFailed.payment.membership | type: MembershipPaymentRefund | description: Membership payment refund.
674
- - name: results[].item.activities[].paymentRefundFailed.payment.membership.membershipId | type: string | description: Membership GUID
675
- - name: results[].item.activities[].paymentRefundFailed.payment.regular | type: RegularPaymentRefund | description: Regular payment refund.
676
- - name: results[].item.activities[].paymentRefundFailed.payment.regular.amount | type: Price | description: Refund amount
677
- - name: results[].item.activities[].paymentRefundFailed.payment.regular.brand | type: string | description: Card issuer's brand.
678
- - name: results[].item.activities[].paymentRefundFailed.payment.regular.lastFourDigits | type: string | description: The last 4 digits of the card number.
679
- - name: results[].item.activities[].paymentRefundFailed.refundId | type: string | description: Refund GUID.
680
- - name: results[].item.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.
681
- - name: results[].item.activities[].paymentRefunded.payment | type: RefundedPayment | description: Details about the refunded payment.
682
- - name: results[].item.activities[].paymentRefunded.refundId | type: string | description: Refund GUID.
683
- - name: results[].item.activities[].receiptCreated | type: ReceiptCreated | description: Receipt was added for associated payment.
684
- - name: results[].item.activities[].receiptCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
685
- - ONE-OF:
686
- - name: results[].item.activities[].receiptCreated.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
687
- - name: results[].item.activities[].receiptCreated.externalReceipt.displayNumber | type: string | description: Display number of receipt
688
- - name: results[].item.activities[].receiptCreated.externalReceipt.receiptId | type: string | description: Receipt GUID
689
- - name: results[].item.activities[].receiptCreated.wixReceipt | type: WixReceipt | description: Receipt created by Wix
690
- - name: results[].item.activities[].receiptCreated.wixReceipt.displayNumber | type: string | description: Display number of receipt
691
- - name: results[].item.activities[].receiptCreated.wixReceipt.receiptId | type: string | description: Receipt GUID
692
- - name: results[].item.activities[].receiptSent | type: ReceiptSent | description: Receipt sent to customer.
693
- - name: results[].item.activities[].receiptSent.paymentId | type: string | description: Payment GUID of payment associated with this activity
694
- - ONE-OF:
695
- - name: results[].item.activities[].receiptSent.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
696
- - name: results[].item.activities[].receiptSent.wixReceipt | type: WixReceipt | description: Receipt created by Wix
697
- - name: results[].item.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.
698
- - name: results[].item.activities[].refundInitiated.amount | type: Price | description: Refund amount.
699
- - name: results[].item.activities[].refundInitiated.payments | type: Array<RefundedPayment> | description: Details about the payments being refunded.
700
- - name: results[].item.activities[].refundInitiated.reason | type: string | description: Reason for refund.
701
- - name: results[].item.activities[].refundInitiated.refundId | type: string | description: Refund GUID.
702
- - name: results[].item.activities[].refundedAsStoreCredit | type: RefundedAsStoreCredit | description: Details of refund to store credit.
703
- - name: results[].item.activities[].refundedAsStoreCredit.amount | type: Price | description: Refund amount
704
- - name: results[].item.activities[].refundedAsStoreCredit.reason | type: string | description: Reason for refund
705
- - name: results[].item.activities[].savedPaymentMethod | type: SavedPaymentMethod | description: Details of the payment method saved for order
706
- - name: results[].item.activities[].savedPaymentMethod.description | type: string | description: Payment method description
707
- - name: results[].item.activities[].savedPaymentMethod.name | type: string | description: Payment method name
708
- - name: results[].item.additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
709
- - name: results[].item.additionalFees[]._id | type: string | description: Additional fee's id.
710
- - name: results[].item.additionalFees[].code | type: string | description: Additional fee's unique code for future processing.
711
- - name: results[].item.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.
712
- - name: results[].item.additionalFees[].name | type: string | description: Name of additional fee.
713
- - name: results[].item.additionalFees[].price | type: Price | description: Additional fee's price.
714
- - name: results[].item.additionalFees[].priceAfterTax | type: Price | description: Additional fee's price after tax.
715
- - name: results[].item.additionalFees[].priceBeforeTax | type: Price | description: Additional fee's price before tax.
716
- - name: results[].item.additionalFees[].providerAppId | type: string | description: SPI implementer's `appId`.
717
- - name: results[].item.additionalFees[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
718
- - name: results[].item.additionalFees[].taxInfo.taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
719
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
720
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
721
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
581
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.diff | type: number | description: Difference between original and new quantity. Absolute value.
582
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.newQuantity | type: number | description: Item quantity after update.
583
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemChanged.quantity.originalQuantity | type: number | description: Item quantity before update.
584
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].lineItemRemoved | type: ManagedLineItem | description: none
585
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged | type: ShippingInformationChange | description: none
586
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. After update
587
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.shippingTitle | type: string | description: Order’s shipping title.
588
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.newShippingInfo.total | type: Price | description: Order’s shipping price.
589
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].shippingInformationChanged.originalShippingInfo | type: ShippingInformation | description: Order’s Shipping Information. Before update
590
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged | type: TotalPriceChange | description: none
591
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged.newTotal | type: Price | description: Order’s total price after discounts and tax. After update
592
+ - name: results[].item.activities[].draftOrderChangesApplied.changes[].totalPriceChanged.originalTotal | type: Price | description: Order’s total price after discounts and tax. Before update
593
+ - name: results[].item.activities[].draftOrderChangesApplied.draftOrderId | type: string | description: Draft order id.
594
+ - name: results[].item.activities[].draftOrderChangesApplied.reason | type: string | description: Reason for edit, given by user (optional).
595
+ - name: results[].item.activities[].merchantComment | type: MerchantComment | description: Merchant comment details (optional). `activity.type` must be `MERCHANT_COMMENT`.
596
+ - name: results[].item.activities[].merchantComment.message | type: string | description: Merchant comment message.
597
+ - name: results[].item.activities[].orderRefunded | type: OrderRefunded | description: Additional info about order refunded activity (optional). `activity.type` must be `ORDER_REFUNDED`.
598
+ - name: results[].item.activities[].orderRefunded.amount | type: Price | description: Refund amount.
599
+ - name: results[].item.activities[].orderRefunded.manual | type: boolean | description: Whether order was refunded manually. For example, via payment provider or using cash.
600
+ - name: results[].item.activities[].orderRefunded.reason | type: string | description: Reason for refund.
601
+ - name: results[].item.activities[].paymentCanceled | type: PaymentCanceled | description: Details of a canceled payment.
602
+ - name: results[].item.activities[].paymentCanceled.paymentId | type: string | description: Payment GUID of payment associated with this activity
603
+ - ONE-OF:
604
+ - name: results[].item.activities[].paymentCanceled.regular | type: RegularPayment | description: Regular payment.
605
+ - name: results[].item.activities[].paymentDeclined | type: PaymentDeclined | description: Details of a declined payment.
606
+ - name: results[].item.activities[].paymentDeclined.paymentId | type: string | description: Payment GUID of payment associated with this activity
607
+ - ONE-OF:
608
+ - name: results[].item.activities[].paymentDeclined.regular | type: RegularPayment | description: Regular payment.
609
+ - name: results[].item.activities[].paymentPending | type: PaymentPending | description: Details of a pending payment.
610
+ - name: results[].item.activities[].paymentPending.paymentId | type: string | description: Payment GUID of payment associated with this activity
611
+ - ONE-OF:
612
+ - name: results[].item.activities[].paymentPending.regular | type: RegularPayment | description: Regular payment.
613
+ - name: results[].item.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.
614
+ - name: results[].item.activities[].paymentRefundFailed.payment | type: RefundedPayment | description: Details about the failed payment refund.
615
+ - name: results[].item.activities[].paymentRefundFailed.payment.externalRefund | type: boolean | description: Whether refund was made externally and manually on the payment provider's side.
616
+ - name: results[].item.activities[].paymentRefundFailed.payment.paymentId | type: string | description: Payment GUID.
617
+ - ONE-OF:
618
+ - name: results[].item.activities[].paymentRefundFailed.payment.giftCard | type: GiftCardPaymentRefund | description: Gift card payment refund.
619
+ - name: results[].item.activities[].paymentRefundFailed.payment.giftCard.amount | type: Price | description: Refund amount
620
+ - name: results[].item.activities[].paymentRefundFailed.payment.giftCard.giftCardPaymentId | type: string | description: Gift card payment GUID
621
+ - name: results[].item.activities[].paymentRefundFailed.payment.membership | type: MembershipPaymentRefund | description: Membership payment refund.
622
+ - name: results[].item.activities[].paymentRefundFailed.payment.membership.membershipId | type: string | description: Membership GUID
623
+ - name: results[].item.activities[].paymentRefundFailed.payment.regular | type: RegularPaymentRefund | description: Regular payment refund.
624
+ - name: results[].item.activities[].paymentRefundFailed.payment.regular.amount | type: Price | description: Refund amount
625
+ - name: results[].item.activities[].paymentRefundFailed.payment.regular.brand | type: string | description: Card issuer's brand.
626
+ - name: results[].item.activities[].paymentRefundFailed.payment.regular.lastFourDigits | type: string | description: The last 4 digits of the card number.
627
+ - name: results[].item.activities[].paymentRefundFailed.refundId | type: string | description: Refund GUID.
628
+ - name: results[].item.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.
629
+ - name: results[].item.activities[].paymentRefunded.payment | type: RefundedPayment | description: Details about the refunded payment.
630
+ - name: results[].item.activities[].paymentRefunded.refundId | type: string | description: Refund GUID.
631
+ - name: results[].item.activities[].receiptCreated | type: ReceiptCreated | description: Receipt was added for associated payment.
632
+ - name: results[].item.activities[].receiptCreated.paymentId | type: string | description: Payment GUID of payment associated with this activity
633
+ - ONE-OF:
634
+ - name: results[].item.activities[].receiptCreated.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
635
+ - name: results[].item.activities[].receiptCreated.externalReceipt.displayNumber | type: string | description: Display number of receipt
636
+ - name: results[].item.activities[].receiptCreated.externalReceipt.receiptId | type: string | description: Receipt GUID
637
+ - name: results[].item.activities[].receiptCreated.wixReceipt | type: WixReceipt | description: Receipt created by Wix
638
+ - name: results[].item.activities[].receiptCreated.wixReceipt.displayNumber | type: string | description: Display number of receipt
639
+ - name: results[].item.activities[].receiptCreated.wixReceipt.receiptId | type: string | description: Receipt GUID
640
+ - name: results[].item.activities[].receiptSent | type: ReceiptSent | description: Receipt sent to customer.
641
+ - name: results[].item.activities[].receiptSent.paymentId | type: string | description: Payment GUID of payment associated with this activity
642
+ - ONE-OF:
643
+ - name: results[].item.activities[].receiptSent.externalReceipt | type: ExternalReceipt | description: Receipt created by an external system.
644
+ - name: results[].item.activities[].receiptSent.wixReceipt | type: WixReceipt | description: Receipt created by Wix
645
+ - name: results[].item.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.
646
+ - name: results[].item.activities[].refundInitiated.amount | type: Price | description: Refund amount.
647
+ - name: results[].item.activities[].refundInitiated.payments | type: Array<RefundedPayment> | description: Details about the payments being refunded.
648
+ - name: results[].item.activities[].refundInitiated.reason | type: string | description: Reason for refund.
649
+ - name: results[].item.activities[].refundInitiated.refundId | type: string | description: Refund GUID.
650
+ - name: results[].item.activities[].refundedAsStoreCredit | type: RefundedAsStoreCredit | description: Details of refund to store credit.
651
+ - name: results[].item.activities[].refundedAsStoreCredit.amount | type: Price | description: Refund amount
652
+ - name: results[].item.activities[].refundedAsStoreCredit.reason | type: string | description: Reason for refund
653
+ - name: results[].item.activities[].savedPaymentMethod | type: SavedPaymentMethod | description: Details of the payment method saved for order
654
+ - name: results[].item.activities[].savedPaymentMethod.description | type: string | description: Payment method description
655
+ - name: results[].item.activities[].savedPaymentMethod.name | type: string | description: Payment method name
656
+ - name: results[].item.additionalFees | type: Array<AdditionalFee> | description: Additional fees applied to the order.
657
+ - name: results[].item.additionalFees[]._id | type: string | description: Additional fee's id.
658
+ - name: results[].item.additionalFees[].code | type: string | description: Additional fee's unique code for future processing.
659
+ - name: results[].item.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.
660
+ - name: results[].item.additionalFees[].name | type: string | description: Name of additional fee.
661
+ - name: results[].item.additionalFees[].price | type: Price | description: Additional fee's price.
662
+ - name: results[].item.additionalFees[].priceAfterTax | type: Price | description: Additional fee's price after tax.
663
+ - name: results[].item.additionalFees[].priceBeforeTax | type: Price | description: Additional fee's price before tax.
664
+ - name: results[].item.additionalFees[].providerAppId | type: string | description: SPI implementer's `appId`.
665
+ - name: results[].item.additionalFees[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for additional fee.
666
+ - name: results[].item.additionalFees[].taxInfo.taxAmount | type: Price | description: Calculated tax, based on `taxable_amount` and `tax_rate`.
667
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown | type: Array<LineItemTaxBreakdown> | description: Tax information for a line item.
668
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].jurisdiction | type: string | description: Jurisdiction that taxes were calculated for. For example, "New York", or "Quebec".
669
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: Type of jurisdiction that taxes were calculated for.
722
670
  enum: CITY, COUNTRY, COUNTY, SPECIAL, STATE, UNDEFINED
723
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
724
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
725
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxAmount | type: Price | description: Amount of tax calculated for this line item.
726
- - name: results[].item.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.
727
- - name: results[].item.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.
728
- - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxableAmount | type: Price | description: Taxable amount of the line item price.
729
- - name: results[].item.additionalFees[].taxInfo.taxGroupId | type: string | description: Tax group GUID.
730
- - name: results[].item.additionalFees[].taxInfo.taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
731
- - name: results[].item.additionalFees[].taxInfo.taxRate | type: string | description: Tax rate %, as a decimal point.
732
- - name: results[].item.additionalFees[].taxInfo.taxableAmount | type: Price | description: Amount for which tax is calculated.
733
- - name: results[].item.appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
734
- - name: results[].item.appliedDiscounts[]._id | type: string | description: Discount id.
735
- - name: results[].item.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.
671
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].nonTaxableAmount | type: Price | description: Non-taxable amount of the line item price.
672
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].rate | type: string | description: Tax rate used for this jurisdiction, as a decimal. For example, 10% tax is 0.1000.
673
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxAmount | type: Price | description: Amount of tax calculated for this line item.
674
+ - name: results[].item.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.
675
+ - name: results[].item.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.
676
+ - name: results[].item.additionalFees[].taxInfo.taxBreakdown[].taxableAmount | type: Price | description: Taxable amount of the line item price.
677
+ - name: results[].item.additionalFees[].taxInfo.taxGroupId | type: string | description: Tax group GUID.
678
+ - name: results[].item.additionalFees[].taxInfo.taxIncludedInPrice | type: boolean | description: Indicates whether the price already includes tax.
679
+ - name: results[].item.additionalFees[].taxInfo.taxRate | type: string | description: Tax rate %, as a decimal point.
680
+ - name: results[].item.additionalFees[].taxInfo.taxableAmount | type: Price | description: Amount for which tax is calculated.
681
+ - name: results[].item.appliedDiscounts | type: Array<AppliedDiscount> | description: Applied discounts.
682
+ - name: results[].item.appliedDiscounts[]._id | type: string | description: Discount id.
683
+ - name: results[].item.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.
736
684
  enum: GLOBAL, SHIPPING, SPECIFIC_ITEMS
737
- - ONE-OF:
738
- - name: results[].item.appliedDiscounts[].coupon | type: Coupon | description: Applied coupon info.
739
- - name: results[].item.appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
740
- - name: results[].item.appliedDiscounts[].coupon.amount | type: Price | description: Coupon value.
741
- - name: results[].item.appliedDiscounts[].coupon.code | type: string | description: Coupon code.
742
- - name: results[].item.appliedDiscounts[].coupon.name | type: string | description: Coupon name.
743
- - name: results[].item.appliedDiscounts[].discountRule | type: DiscountRule | description: Automatic Discount
744
- - name: results[].item.appliedDiscounts[].discountRule._id | type: string | description: Discount rule GUID
745
- - name: results[].item.appliedDiscounts[].discountRule.amount | type: Price | description: Discount value.
746
- - name: results[].item.appliedDiscounts[].discountRule.name | type: DiscountRuleName | description: Discount rule name
747
- - name: results[].item.appliedDiscounts[].discountRule.name.original | type: string | description: Original discount rule name (in site's default language).
748
- - name: results[].item.appliedDiscounts[].discountRule.name.translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
749
- - name: results[].item.appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
750
- - name: results[].item.appliedDiscounts[].merchantDiscount.amount | type: Price | description: Discount amount.
751
- - ONE-OF:
752
- - name: results[].item.appliedDiscounts[].merchantDiscount.description | type: string | description: Discount description as free text (optional).
753
- - name: results[].item.appliedDiscounts[].merchantDiscount.discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
685
+ - ONE-OF:
686
+ - name: results[].item.appliedDiscounts[].coupon | type: Coupon | description: Applied coupon info.
687
+ - name: results[].item.appliedDiscounts[].coupon._id | type: string | description: Coupon GUID.
688
+ - name: results[].item.appliedDiscounts[].coupon.amount | type: Price | description: Coupon value.
689
+ - name: results[].item.appliedDiscounts[].coupon.code | type: string | description: Coupon code.
690
+ - name: results[].item.appliedDiscounts[].coupon.name | type: string | description: Coupon name.
691
+ - name: results[].item.appliedDiscounts[].discountRule | type: DiscountRule | description: Automatic Discount
692
+ - name: results[].item.appliedDiscounts[].discountRule._id | type: string | description: Discount rule GUID
693
+ - name: results[].item.appliedDiscounts[].discountRule.amount | type: Price | description: Discount value.
694
+ - name: results[].item.appliedDiscounts[].discountRule.name | type: DiscountRuleName | description: Discount rule name
695
+ - name: results[].item.appliedDiscounts[].discountRule.name.original | type: string | description: Original discount rule name (in site's default language).
696
+ - name: results[].item.appliedDiscounts[].discountRule.name.translated | type: string | description: Translated discount rule name according to buyer language. Defaults to `original` when not provided.
697
+ - name: results[].item.appliedDiscounts[].merchantDiscount | type: MerchantDiscount | description: Merchant discount.
698
+ - name: results[].item.appliedDiscounts[].merchantDiscount.amount | type: Price | description: Discount amount.
699
+ - ONE-OF:
700
+ - name: results[].item.appliedDiscounts[].merchantDiscount.description | type: string | description: Discount description as free text (optional).
701
+ - name: results[].item.appliedDiscounts[].merchantDiscount.discountReason | type: DiscountReason | description: Pre-defined discount reason (optional). * `"ITEMS_EXCHANGE"` - exchange balance acquired as a result of items exchange.
754
702
  enum: BILLING_ADJUSTMENT, EXCHANGED_ITEMS, UNSPECIFIED
755
- - name: results[].item.archived | type: boolean | description: Whether order is archived.
756
- - name: results[].item.attributionSource | type: AttributionSource | description: Order attribution source.
703
+ - name: results[].item.archived | type: boolean | description: Whether order is archived.
704
+ - name: results[].item.attributionSource | type: AttributionSource | description: Order attribution source.
757
705
  enum: FACEBOOK_ADS, UNSPECIFIED
758
- - name: results[].item.balanceSummary | type: BalanceSummary | description: Balance summary.
759
- - name: results[].item.balanceSummary.authorized | type: Price | description: Sum of all authorized payments.
760
- - name: results[].item.balanceSummary.balance | type: Balance | description: Current amount left to pay.
761
- - name: results[].item.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.
762
- - name: results[].item.balanceSummary.balance.formattedAmount | type: string | description: Amount formatted with currency symbol.
763
- - name: results[].item.balanceSummary.chargeback | type: Price | description: Sum of all transaction chargebacks.
764
- - name: results[].item.balanceSummary.chargebackReversal | type: Price | description: Sum of all chargeback reversals.
765
- - name: results[].item.balanceSummary.paid | type: Price | description: Sum of all approved and successful payments. The value includes payments that have subsequently been fully or partially refunded.
766
- - name: results[].item.balanceSummary.pending | type: Price | description: Sum of all pending transactions.
767
- - name: results[].item.balanceSummary.pendingRefund | type: Price | description: Sum of all pending refund transactions.
768
- - name: results[].item.balanceSummary.refunded | type: Price | description: Sum of all successfully refunded payments.
769
- - name: results[].item.billingInfo | type: AddressWithContact | description: Billing address and contact details.
770
- - name: results[].item.billingInfo.address | type: Address | description: Address.
771
- - name: results[].item.billingInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
772
- - name: results[].item.billingInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
773
- - name: results[].item.billingInfo.address.city | type: string | description: City name.
774
- - name: results[].item.billingInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
775
- - name: results[].item.billingInfo.address.countryFullname | type: string | description: Country's full name.
776
- - name: results[].item.billingInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
777
- - name: results[].item.billingInfo.address.location.latitude | type: number | description: Address latitude.
778
- - name: results[].item.billingInfo.address.location.longitude | type: number | description: Address longitude.
779
- - name: results[].item.billingInfo.address.postalCode | type: string | description: Postal or zip code.
780
- - name: results[].item.billingInfo.address.streetAddress | type: StreetAddress | description: Street address.
781
- - name: results[].item.billingInfo.address.streetAddress.name | type: string | description: Street name.
782
- - name: results[].item.billingInfo.address.streetAddress.number | type: string | description: Street number.
783
- - name: results[].item.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.
784
- - name: results[].item.billingInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
785
- - name: results[].item.billingInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
786
- - name: results[].item.billingInfo.contactDetails.company | type: string | description: Company name.
787
- - name: results[].item.billingInfo.contactDetails.firstName | type: string | description: First name.
788
- - name: results[].item.billingInfo.contactDetails.lastName | type: string | description: Last name.
789
- - name: results[].item.billingInfo.contactDetails.phone | type: string | description: Phone number.
790
- - name: results[].item.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.
791
- - name: results[].item.billingInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
792
- - name: results[].item.billingInfo.contactDetails.vatId.type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
793
- enum:
706
+ - name: results[].item.balanceSummary | type: BalanceSummary | description: Balance summary.
707
+ - name: results[].item.balanceSummary.authorized | type: Price | description: Sum of all authorized payments.
708
+ - name: results[].item.balanceSummary.balance | type: Balance | description: Current amount left to pay.
709
+ - name: results[].item.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.
710
+ - name: results[].item.balanceSummary.balance.formattedAmount | type: string | description: Amount formatted with currency symbol.
711
+ - name: results[].item.balanceSummary.chargeback | type: Price | description: Sum of all transaction chargebacks.
712
+ - name: results[].item.balanceSummary.chargebackReversal | type: Price | description: Sum of all chargeback reversals.
713
+ - name: results[].item.balanceSummary.paid | type: Price | description: Sum of all approved and successful payments. The value includes payments that have subsequently been fully or partially refunded.
714
+ - name: results[].item.balanceSummary.pending | type: Price | description: Sum of all pending transactions.
715
+ - name: results[].item.balanceSummary.pendingRefund | type: Price | description: Sum of all pending refund transactions.
716
+ - name: results[].item.balanceSummary.refunded | type: Price | description: Sum of all successfully refunded payments.
717
+ - name: results[].item.billingInfo | type: AddressWithContact | description: Billing address and contact details.
718
+ - name: results[].item.billingInfo.address | type: Address | description: Address.
719
+ - name: results[].item.billingInfo.address.addressLine1 | type: string | description: Main address line (usually street name and number).
720
+ - name: results[].item.billingInfo.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
721
+ - name: results[].item.billingInfo.address.city | type: string | description: City name.
722
+ - name: results[].item.billingInfo.address.country | type: string | description: Two-letter country code in [ISO-3166 alpha-2](https://www.iso.org/obp/ui/#search/code/) format.
723
+ - name: results[].item.billingInfo.address.countryFullname | type: string | description: Country's full name.
724
+ - name: results[].item.billingInfo.address.location | type: AddressLocation | description: Geocode object containing latitude and longitude coordinates.
725
+ - name: results[].item.billingInfo.address.location.latitude | type: number | description: Address latitude.
726
+ - name: results[].item.billingInfo.address.location.longitude | type: number | description: Address longitude.
727
+ - name: results[].item.billingInfo.address.postalCode | type: string | description: Postal or zip code.
728
+ - name: results[].item.billingInfo.address.streetAddress | type: StreetAddress | description: Street address.
729
+ - name: results[].item.billingInfo.address.streetAddress.name | type: string | description: Street name.
730
+ - name: results[].item.billingInfo.address.streetAddress.number | type: string | description: Street number.
731
+ - name: results[].item.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.
732
+ - name: results[].item.billingInfo.address.subdivisionFullname | type: string | description: Subdivision full-name.
733
+ - name: results[].item.billingInfo.contactDetails | type: FullAddressContactDetails | description: Contact details.
734
+ - name: results[].item.billingInfo.contactDetails.company | type: string | description: Company name.
735
+ - name: results[].item.billingInfo.contactDetails.firstName | type: string | description: First name.
736
+ - name: results[].item.billingInfo.contactDetails.lastName | type: string | description: Last name.
737
+ - name: results[].item.billingInfo.contactDetails.phone | type: string | description: Phone number.
738
+ - name: results[].item.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.
739
+ - name: results[].item.billingInfo.contactDetails.vatId._id | type: string | description: Customer's tax GUID.
740
+ - name: results[].item.billingInfo.contactDetails.vatId.type | type: VatType | description: Tax type. Supported values: + `CPF`: for individual tax payers + `CNPJ`: for corporations
741
+ enum:
794
742
  CNPJ: CNPJ - for corporations
795
743
  CPF: CPF - for individual tax payers.
796
744
  UNSPECIFIED
797
- - name: results[].item.businessLocation | type: Location | description: Order Location
798
- - name: results[].item.businessLocation._id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
799
- - name: results[].item.businessLocation.name | type: string | description: Location name.
800
- - name: results[].item.buyerInfo | type: BuyerInfo | description: Buyer information.
801
- - name: results[].item.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).
802
- - name: results[].item.buyerInfo.email | type: string | description: Buyer email address.
803
- - ONE-OF:
804
- - name: results[].item.buyerInfo.memberId | type: string | description: Member GUID (if site visitor is a site member).
805
- - name: results[].item.buyerInfo.visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
806
- - name: results[].item.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.
807
- - name: results[].item.buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
808
- - name: results[].item.channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
809
- - name: results[].item.channelInfo.externalOrderId | type: string | description: Reference to an order GUID from an external system.
810
- - name: results[].item.channelInfo.externalOrderUrl | type: string | description: URL to the order in the external system.
811
- - name: results[].item.channelInfo.type | type: ChannelType | description: Sales channel that submitted the order.
812
- enum:
745
+ - name: results[].item.businessLocation | type: Location | description: Order Location
746
+ - name: results[].item.businessLocation._id | type: string | description: Location GUID. Learn more about the [Wix Locations API](https://dev.wix.com/docs/rest/business-management/locations/introduction).
747
+ - name: results[].item.businessLocation.name | type: string | description: Location name.
748
+ - name: results[].item.buyerInfo | type: BuyerInfo | description: Buyer information.
749
+ - name: results[].item.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).
750
+ - name: results[].item.buyerInfo.email | type: string | description: Buyer email address.
751
+ - ONE-OF:
752
+ - name: results[].item.buyerInfo.memberId | type: string | description: Member GUID (if site visitor is a site member).
753
+ - name: results[].item.buyerInfo.visitorId | type: string | description: Visitor GUID (if site visitor is not a member).
754
+ - name: results[].item.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.
755
+ - name: results[].item.buyerNote | type: string | description: [Buyer note](https://support.wix.com/en/article/wix-stores-viewing-buyer-notes) left by the customer.
756
+ - name: results[].item.channelInfo | type: ChannelInfo | description: Information about the sales channel that submitted this order.
757
+ - name: results[].item.channelInfo.externalOrderId | type: string | description: Reference to an order GUID from an external system.
758
+ - name: results[].item.channelInfo.externalOrderUrl | type: string | description: URL to the order in the external system.
759
+ - name: results[].item.channelInfo.type | type: ChannelType | description: Sales channel that submitted the order.
760
+ enum:
813
761
  AMAZON: [Amazon shop](https://support.wix.com/en/article/wix-stores-connecting-and-setting-up-an-amazon-shop).
814
762
  BACKOFFICE_MERCHANT: Wix merchant backoffice.
815
763
  CLASS_PASS: [ClassPass sales channel](https://support.wix.com/en/article/wix-bookings-letting-clients-book-your-services-with-classpass).
@@ -827,129 +775,129 @@ Return type: PROMISE<BulkUpdateOrdersResponse>
827
775
  WISH: Wish sales channel.
828
776
  WIX_APP_STORE: [Wix Owner app](https://support.wix.com/article/wix-owner-app-an-overview).
829
777
  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)
830
- - name: results[].item.checkoutId | type: string | description: Checkout GUID.
831
- - name: results[].item.createdBy | type: CreatedBy | description: GUID of the order's initiator.
832
- - ONE-OF:
833
- - name: results[].item.createdBy.appId | type: string | description: App GUID - when the order was created by an external application.
834
- - name: results[].item.createdBy.memberId | type: string | description: Member GUID - when the order was created by a **logged in** site visitor.
835
- - name: results[].item.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).
836
- - name: results[].item.createdBy.visitorId | type: string | description: Visitor GUID - when the order was created by a site visitor that was **not** logged in.
837
- - name: results[].item.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.
838
- - name: results[].item.currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
839
- - name: results[].item.currencyConversionDetails.conversionRate | type: string | description: The rate used for converting the original currency to the currency used for payment.
840
- - name: results[].item.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.
841
- - name: results[].item.customFields | type: Array<CustomField> | description: Custom fields.
842
- - name: results[].item.customFields[].title | type: string | description: Custom field title.
843
- - name: results[].item.customFields[].translatedTitle | type: string | description: Translated custom field title.
844
- - name: results[].item.customFields[].value | type: any | description: Custom field value.
845
- - name: results[].item.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.
846
- - name: results[].item.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).
847
- - name: results[].item.fulfillmentStatus | type: FulfillmentStatus | description: Order fulfillment status.
848
- enum:
778
+ - name: results[].item.checkoutId | type: string | description: Checkout GUID.
779
+ - name: results[].item.createdBy | type: CreatedBy | description: GUID of the order's initiator.
780
+ - ONE-OF:
781
+ - name: results[].item.createdBy.appId | type: string | description: App GUID - when the order was created by an external application.
782
+ - name: results[].item.createdBy.memberId | type: string | description: Member GUID - when the order was created by a **logged in** site visitor.
783
+ - name: results[].item.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).
784
+ - name: results[].item.createdBy.visitorId | type: string | description: Visitor GUID - when the order was created by a site visitor that was **not** logged in.
785
+ - name: results[].item.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.
786
+ - name: results[].item.currencyConversionDetails | type: CurrencyConversionDetails | description: Currency conversion details. For use with multi-currency sites.
787
+ - name: results[].item.currencyConversionDetails.conversionRate | type: string | description: The rate used for converting the original currency to the currency used for payment.
788
+ - name: results[].item.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.
789
+ - name: results[].item.customFields | type: Array<CustomField> | description: Custom fields.
790
+ - name: results[].item.customFields[].title | type: string | description: Custom field title.
791
+ - name: results[].item.customFields[].translatedTitle | type: string | description: Translated custom field title.
792
+ - name: results[].item.customFields[].value | type: any | description: Custom field value.
793
+ - name: results[].item.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.
794
+ - name: results[].item.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).
795
+ - name: results[].item.fulfillmentStatus | type: FulfillmentStatus | description: Order fulfillment status.
796
+ enum:
849
797
  FULFILLED: All of the order items are fulfilled or the order was manually marked as fulfilled. Orders without shipping info are fulfilled automatically.
850
798
  NOT_FULFILLED: None of the order items are fulfilled or the order was manually marked as unfulfilled.
851
799
  PARTIALLY_FULFILLED: Some, but not all, of the order items are fulfilled.
852
- - name: results[].item.lineItems | type: Array<OrderLineItem> | description: Order line items.
853
- - name: results[].item.lineItems[]._id | type: string | description: Line item GUID.
854
- - name: results[].item.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.
855
- - name: results[].item.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"`
856
- - name: results[].item.lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
857
- - name: results[].item.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).
858
- - name: results[].item.lineItems[].depositAmount | type: Price | description: Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
859
- - name: results[].item.lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for display purposes for the cart, checkout and order.
860
- - name: results[].item.lineItems[].descriptionLines[].name | type: DescriptionLineName | description: Description line name.
861
- - name: results[].item.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).
862
- - name: results[].item.lineItems[].descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
863
- - ONE-OF:
864
- - name: results[].item.lineItems[].descriptionLines[].colorInfo | type: Color | description: Description line color value.
865
- - name: results[].item.lineItems[].descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
866
- - name: results[].item.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).
867
- - name: results[].item.lineItems[].descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
868
- - name: results[].item.lineItems[].descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
869
- - name: results[].item.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).
870
- - name: results[].item.lineItems[].descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
871
- - ONE-OF:
872
- - name: results[].item.lineItems[].digitalFile | type: DigitalFile | description: Digital file identifier, relevant only for items with type DIGITAL.
873
- - name: results[].item.lineItems[].digitalFile.expirationDate | type: Date | description: Link expiration time and date.
874
- - name: results[].item.lineItems[].digitalFile.fileId | type: string | description: GUID of the secure file in media.
875
- - name: results[].item.lineItems[].digitalFile.link | type: string | description: Link will exist after the digital links have been generated on the order.
876
- - name: results[].item.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.
877
- - name: results[].item.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).
878
- - name: results[].item.lineItems[].image | type: string | description: Line item image.
879
- - name: results[].item.lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
880
- - ONE-OF:
881
- - name: results[].item.lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
882
- - name: results[].item.lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
800
+ - name: results[].item.lineItems | type: Array<OrderLineItem> | description: Order line items.
801
+ - name: results[].item.lineItems[]._id | type: string | description: Line item GUID.
802
+ - name: results[].item.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.
803
+ - name: results[].item.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"`
804
+ - name: results[].item.lineItems[].catalogReference.catalogItemId | type: string | description: GUID of the item within the catalog it belongs to.
805
+ - name: results[].item.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).
806
+ - name: results[].item.lineItems[].depositAmount | type: Price | description: Item's price amount to be charged during checkout. Relevant for items with a `paymentOption` value of `"DEPOSIT_ONLINE"`.
807
+ - name: results[].item.lineItems[].descriptionLines | type: Array<DescriptionLine> | description: Line item description lines. Used for display purposes for the cart, checkout and order.
808
+ - name: results[].item.lineItems[].descriptionLines[].name | type: DescriptionLineName | description: Description line name.
809
+ - name: results[].item.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).
810
+ - name: results[].item.lineItems[].descriptionLines[].name.translated | type: string | description: Description line name translated into the buyer's language. Default: Same as `original`.
811
+ - ONE-OF:
812
+ - name: results[].item.lineItems[].descriptionLines[].colorInfo | type: Color | description: Description line color value.
813
+ - name: results[].item.lineItems[].descriptionLines[].colorInfo.code | type: string | description: HEX or RGB color code for display.
814
+ - name: results[].item.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).
815
+ - name: results[].item.lineItems[].descriptionLines[].colorInfo.translated | type: string | description: Description line color name translated into the buyer's language. Default: Same as `original`.
816
+ - name: results[].item.lineItems[].descriptionLines[].plainText | type: PlainTextValue | description: Description line plain text value.
817
+ - name: results[].item.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).
818
+ - name: results[].item.lineItems[].descriptionLines[].plainText.translated | type: string | description: Description line plain text value translated into the buyer's language. Default: Same as `original`.
819
+ - ONE-OF:
820
+ - name: results[].item.lineItems[].digitalFile | type: DigitalFile | description: Digital file identifier, relevant only for items with type DIGITAL.
821
+ - name: results[].item.lineItems[].digitalFile.expirationDate | type: Date | description: Link expiration time and date.
822
+ - name: results[].item.lineItems[].digitalFile.fileId | type: string | description: GUID of the secure file in media.
823
+ - name: results[].item.lineItems[].digitalFile.link | type: string | description: Link will exist after the digital links have been generated on the order.
824
+ - name: results[].item.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.
825
+ - name: results[].item.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).
826
+ - name: results[].item.lineItems[].image | type: string | description: Line item image.
827
+ - name: results[].item.lineItems[].itemType | type: ItemType | description: Item type. Either a preset type or custom.
828
+ - ONE-OF:
829
+ - name: results[].item.lineItems[].itemType.custom | type: string | description: Custom item type. When none of the preset types are suitable, specifies the custom type.
830
+ - name: results[].item.lineItems[].itemType.preset | type: ItemTypePreset | description: Preset item type.
883
831
  enum: DIGITAL, GIFT_CARD, PHYSICAL, SERVICE, UNRECOGNISED
884
- - name: results[].item.lineItems[].locations | type: Array<LocationAndQuantity> | description: Line item locations. The location's total quantity must not exceed the line item quantity.
885
- - name: results[].item.lineItems[].locations[]._id | type: string | description: Location id in the associated owner app.
886
- - name: results[].item.lineItems[].locations[].name | type: string | description: Location name.
887
- - name: results[].item.lineItems[].locations[].quantity | type: number | description: Quantity for specific location.
888
- - name: results[].item.lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
889
- - name: results[].item.lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
890
- - name: results[].item.lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
891
- - name: results[].item.lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
892
- - name: results[].item.lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
893
- - name: results[].item.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.
894
- - name: results[].item.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`.
895
- - name: results[].item.lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
896
- - name: results[].item.lineItems[].modifierGroups[].modifiers[].price | type: Price | description: The price of the modifier.
897
- - name: results[].item.lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
898
- - name: results[].item.lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
899
- - name: results[].item.lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
900
- enum:
832
+ - name: results[].item.lineItems[].locations | type: Array<LocationAndQuantity> | description: Line item locations. The location's total quantity must not exceed the line item quantity.
833
+ - name: results[].item.lineItems[].locations[]._id | type: string | description: Location id in the associated owner app.
834
+ - name: results[].item.lineItems[].locations[].name | type: string | description: Location name.
835
+ - name: results[].item.lineItems[].locations[].quantity | type: number | description: Quantity for specific location.
836
+ - name: results[].item.lineItems[].modifierGroups | type: Array<ModifierGroup> | description: Modifier groups that were added to the item.
837
+ - name: results[].item.lineItems[].modifierGroups[]._id | type: string | description: Modifier group GUID.
838
+ - name: results[].item.lineItems[].modifierGroups[].modifiers | type: Array<ItemModifier> | description: List of modifiers in this group.
839
+ - name: results[].item.lineItems[].modifierGroups[].modifiers[]._id | type: string | description: Modifier GUID.
840
+ - name: results[].item.lineItems[].modifierGroups[].modifiers[].details | type: TranslatableString | description: Additional details.
841
+ - name: results[].item.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.
842
+ - name: results[].item.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`.
843
+ - name: results[].item.lineItems[].modifierGroups[].modifiers[].label | type: TranslatableString | description: Primary display label for the modifier.
844
+ - name: results[].item.lineItems[].modifierGroups[].modifiers[].price | type: Price | description: The price of the modifier.
845
+ - name: results[].item.lineItems[].modifierGroups[].modifiers[].quantity | type: number | description: The quantity of this modifier.
846
+ - name: results[].item.lineItems[].modifierGroups[].name | type: TranslatableString | description: Modifier group name.
847
+ - name: results[].item.lineItems[].paymentOption | type: PaymentOptionType | description: Type of selected payment option for current item. Default: `FULL_PAYMENT_ONLINE`
848
+ enum:
901
849
  DEPOSIT_ONLINE: Partial payment to be paid upfront during checkout. The initial amount to be paid for each line item is specified in `depositAmount`.
902
850
  FULL_PAYMENT_OFFLINE: The entire payment for this item happens after checkout. For example, when using cash, check, or other offline payment methods.
903
851
  FULL_PAYMENT_ONLINE: The entire payment for this item happens as part of the checkout.
904
852
  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.
905
853
  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`.
906
854
  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.
907
- - name: results[].item.lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU and item weight.
908
- - name: results[].item.lineItems[].physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
909
- - name: results[].item.lineItems[].physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
910
- - name: results[].item.lineItems[].physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
911
- - name: results[].item.lineItems[].price | type: Price | description: Line item price after line item discounts for display purposes.
912
- - name: results[].item.lineItems[].priceBeforeDiscounts | type: Price | description: Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
913
- - name: results[].item.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".
914
- - name: results[].item.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).
915
- - name: results[].item.lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
916
- - name: results[].item.lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
917
- - name: results[].item.lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
918
- - name: results[].item.lineItems[].quantity | type: number | description: Line item quantity.
919
- - name: results[].item.lineItems[].refundQuantity | type: number | description: Number of items that were refunded.
920
- - name: results[].item.lineItems[].restockQuantity | type: number | description: Number of items restocked.
921
- - name: results[].item.lineItems[].subscriptionInfo | type: SubscriptionInfo | description: Subscription info.
922
- - name: results[].item.lineItems[].subscriptionInfo._id | type: string | description: Subscription GUID.
923
- - name: results[].item.lineItems[].subscriptionInfo.chargesDescription | type: string | description: Description of the charges that will be applied for subscription.
924
- - name: results[].item.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`.
925
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription detailed information.
926
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
927
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
928
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription.
929
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If None => no free trial
930
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
855
+ - name: results[].item.lineItems[].physicalProperties | type: PhysicalProperties | description: Physical properties of the item. When relevant, contains information such as SKU and item weight.
856
+ - name: results[].item.lineItems[].physicalProperties.shippable | type: boolean | description: Whether this line item is shippable.
857
+ - name: results[].item.lineItems[].physicalProperties.sku | type: string | description: Stock-keeping unit. Learn more about [SKUs](https://www.wix.com/encyclopedia/definition/stock-keeping-unit-sku).
858
+ - name: results[].item.lineItems[].physicalProperties.weight | type: number | description: Line item weight. Measurement unit matches the weight unit specified in `weightUnit` in the request.
859
+ - name: results[].item.lineItems[].price | type: Price | description: Line item price after line item discounts for display purposes.
860
+ - name: results[].item.lineItems[].priceBeforeDiscounts | type: Price | description: Line item price before line item discounts for display purposes. Defaults to `price` when not provided.
861
+ - name: results[].item.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".
862
+ - name: results[].item.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).
863
+ - name: results[].item.lineItems[].priceDescription.translated | type: string | description: Price description translated into the buyer's language. Default: Same as `original`.
864
+ - name: results[].item.lineItems[].priceUndetermined | type: boolean | description: Whether the price is not yet defined, and will be updated after the order is created. Default: `false`
865
+ - name: results[].item.lineItems[].productName | type: ProductName | description: Item name. + Stores - `product.name` + Bookings - `service.info.name` + Events - `ticket.name`
866
+ - name: results[].item.lineItems[].quantity | type: number | description: Line item quantity.
867
+ - name: results[].item.lineItems[].refundQuantity | type: number | description: Number of items that were refunded.
868
+ - name: results[].item.lineItems[].restockQuantity | type: number | description: Number of items restocked.
869
+ - name: results[].item.lineItems[].subscriptionInfo | type: SubscriptionInfo | description: Subscription info.
870
+ - name: results[].item.lineItems[].subscriptionInfo._id | type: string | description: Subscription GUID.
871
+ - name: results[].item.lineItems[].subscriptionInfo.chargesDescription | type: string | description: Description of the charges that will be applied for subscription.
872
+ - name: results[].item.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`.
873
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings | type: SubscriptionSettings | description: Subscription detailed information.
874
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.autoRenewal | type: boolean | description: Whether subscription is renewed automatically at the end of each period.
875
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.billingCycles | type: number | description: Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
876
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.enableCustomerCancellation | type: boolean | description: Whether to allow the customer to cancel the subscription.
877
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod | type: FreeTrialPeriod | description: Period until first cycle starts. If None => no free trial
878
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.frequency | type: SubscriptionFrequency | description: Frequency of period. Values: DAY, WEEK, MONTH, YEAR
931
879
  enum: DAY, MONTH, UNDEFINED, WEEK, YEAR
932
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
933
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
934
- - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment.
935
- - name: results[].item.lineItems[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a specific line item.
936
- - name: results[].item.lineItems[].taxableAddress | type: TaxableAddress | description: Address used for tax calculation.
937
- - ONE-OF:
938
- - name: results[].item.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.
880
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.freeTrialPeriod.interval | type: number | description: interval of period
881
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.frequency | type: SubscriptionFrequency | description: Frequency of recurring payment.
882
+ - name: results[].item.lineItems[].subscriptionInfo.subscriptionSettings.interval | type: number | description: Interval of recurring payment.
883
+ - name: results[].item.lineItems[].taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a specific line item.
884
+ - name: results[].item.lineItems[].taxableAddress | type: TaxableAddress | description: Address used for tax calculation.
885
+ - ONE-OF:
886
+ - name: results[].item.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.
939
887
  enum: BILLING, BUSINESS, SHIPPING, UNKNOWN_TAXABLE_ADDRESS
940
- - name: results[].item.lineItems[].totalDiscount | type: Price | description: Total discount for this line item's entire quantity.
941
- - name: results[].item.lineItems[].totalPriceAfterTax | type: Price | description: Total price after all discounts and tax.
942
- - name: results[].item.lineItems[].totalPriceBeforeTax | type: Price | description: Total price after discounts, and before tax.
943
- - name: results[].item.number | type: string | description: Order number displayed in the site owner's dashboard (auto-generated).
944
- - name: results[].item.payAfterFreeTrial | type: PriceSummary | description: Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
945
- - name: results[].item.payAfterFreeTrial.discount | type: Price | description: Total calculated discount value.
946
- - name: results[].item.payAfterFreeTrial.shipping | type: Price | description: Total shipping price, before discounts and before tax.
947
- - name: results[].item.payAfterFreeTrial.subtotal | type: Price | description: Subtotal of all the line items, before discounts and before tax.
948
- - name: results[].item.payAfterFreeTrial.tax | type: Price | description: Total tax on this order.
949
- - name: results[].item.payAfterFreeTrial.total | type: Price | description: Order’s total price after discounts and tax.
950
- - name: results[].item.payAfterFreeTrial.totalAdditionalFees | type: Price | description: Total price of additional fees before tax.
951
- - name: results[].item.paymentStatus | type: PaymentStatus | description: Order payment status.
952
- enum:
888
+ - name: results[].item.lineItems[].totalDiscount | type: Price | description: Total discount for this line item's entire quantity.
889
+ - name: results[].item.lineItems[].totalPriceAfterTax | type: Price | description: Total price after all discounts and tax.
890
+ - name: results[].item.lineItems[].totalPriceBeforeTax | type: Price | description: Total price after discounts, and before tax.
891
+ - name: results[].item.number | type: string | description: Order number displayed in the site owner's dashboard (auto-generated).
892
+ - name: results[].item.payAfterFreeTrial | type: PriceSummary | description: Pay after free trial price summary. Price summary that should be paid for subscriptions after free trial period.
893
+ - name: results[].item.payAfterFreeTrial.discount | type: Price | description: Total calculated discount value.
894
+ - name: results[].item.payAfterFreeTrial.shipping | type: Price | description: Total shipping price, before discounts and before tax.
895
+ - name: results[].item.payAfterFreeTrial.subtotal | type: Price | description: Subtotal of all the line items, before discounts and before tax.
896
+ - name: results[].item.payAfterFreeTrial.tax | type: Price | description: Total tax on this order.
897
+ - name: results[].item.payAfterFreeTrial.total | type: Price | description: Order’s total price after discounts and tax.
898
+ - name: results[].item.payAfterFreeTrial.totalAdditionalFees | type: Price | description: Total price of additional fees before tax.
899
+ - name: results[].item.paymentStatus | type: PaymentStatus | description: Order payment status.
900
+ enum:
953
901
  CANCELED: One or more payments canceled.
954
902
  DECLINED: One or more payments declined.
955
903
  FULLY_REFUNDED: Order fully refunded. Refund amount equals total price. See `order.balanceSummary` for more details.
@@ -960,81 +908,81 @@ Return type: PROMISE<BulkUpdateOrdersResponse>
960
908
  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).
961
909
  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.
962
910
  UNSPECIFIED
963
- - name: results[].item.priceSummary | type: PriceSummary | description: Order price summary.
964
- - name: results[].item.purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
965
- - name: results[].item.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.
966
- - name: results[].item.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.
967
- - name: results[].item.seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
968
- - name: results[].item.shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
969
- - name: results[].item.shippingInfo.carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
970
- - name: results[].item.shippingInfo.code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
971
- - name: results[].item.shippingInfo.cost | type: ShippingPrice | description: Shipping costs.
972
- - name: results[].item.shippingInfo.cost.discount | type: Price | description: Shipping discount before tax.
973
- - name: results[].item.shippingInfo.cost.price | type: Price | description: Shipping price for display purposes.
974
- - name: results[].item.shippingInfo.cost.taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
975
- - name: results[].item.shippingInfo.cost.totalPriceAfterTax | type: Price | description: Shipping price after all discounts (if any exist), and after tax.
976
- - name: results[].item.shippingInfo.cost.totalPriceBeforeTax | type: Price | description: Total price of shipping after discounts (when relevant), and before tax.
977
- - name: results[].item.shippingInfo.logistics | type: DeliveryLogistics | description: Shipping logistics.
978
- - name: results[].item.shippingInfo.logistics.deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
979
- - name: results[].item.shippingInfo.logistics.deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
980
- - name: results[].item.shippingInfo.logistics.deliveryTimeSlot.from | type: Date | description: Delivery slot starting time.
981
- - name: results[].item.shippingInfo.logistics.deliveryTimeSlot.to | type: Date | description: Delivery slot ending time.
982
- - name: results[].item.shippingInfo.logistics.instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
983
- - ONE-OF:
984
- - name: results[].item.shippingInfo.logistics.pickupDetails | type: PickupDetails | description: Pickup details.
985
- - name: results[].item.shippingInfo.logistics.pickupDetails.address | type: PickupAddress | description: Pickup address.
986
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.addressLine1 | type: string | description: Main address line (usually street name and number).
987
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
988
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.city | type: string | description: City name.
989
- - name: results[].item.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.
990
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.countryFullname | type: string | description: Country's full name.
991
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.postalCode | type: string | description: Postal or zip code.
992
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
993
- - name: results[].item.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.
994
- - name: results[].item.shippingInfo.logistics.pickupDetails.address.subdivisionFullname | type: string | description: Subdivision full-name.
995
- - name: results[].item.shippingInfo.logistics.pickupDetails.pickupMethod | type: PickupMethod | description: Pickup method
911
+ - name: results[].item.priceSummary | type: PriceSummary | description: Order price summary.
912
+ - name: results[].item.purchaseFlowId | type: string | description: Persistent GUID that correlates between the various eCommerce elements: cart, checkout, and order.
913
+ - name: results[].item.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.
914
+ - name: results[].item.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.
915
+ - name: results[].item.seenByAHuman | type: boolean | description: Whether a human has seen the order. Set when an order is clicked on in the dashboard.
916
+ - name: results[].item.shippingInfo | type: V1ShippingInformation | description: Shipping info and selected shipping option details.
917
+ - name: results[].item.shippingInfo.carrierId | type: string | description: App Def Id of external provider which was a source of shipping info
918
+ - name: results[].item.shippingInfo.code | type: string | description: Unique code (or GUID) of selected shipping option. For example, `"usps_std_overnight"`.
919
+ - name: results[].item.shippingInfo.cost | type: ShippingPrice | description: Shipping costs.
920
+ - name: results[].item.shippingInfo.cost.discount | type: Price | description: Shipping discount before tax.
921
+ - name: results[].item.shippingInfo.cost.price | type: Price | description: Shipping price for display purposes.
922
+ - name: results[].item.shippingInfo.cost.taxInfo | type: LineItemTaxInfo | description: Represents all the relevant tax details for a shipping.
923
+ - name: results[].item.shippingInfo.cost.totalPriceAfterTax | type: Price | description: Shipping price after all discounts (if any exist), and after tax.
924
+ - name: results[].item.shippingInfo.cost.totalPriceBeforeTax | type: Price | description: Total price of shipping after discounts (when relevant), and before tax.
925
+ - name: results[].item.shippingInfo.logistics | type: DeliveryLogistics | description: Shipping logistics.
926
+ - name: results[].item.shippingInfo.logistics.deliveryTime | type: string | description: Expected delivery time in free text. For example, `"3-5 business days"`.
927
+ - name: results[].item.shippingInfo.logistics.deliveryTimeSlot | type: DeliveryTimeSlot | description: Expected delivery time.
928
+ - name: results[].item.shippingInfo.logistics.deliveryTimeSlot.from | type: Date | description: Delivery slot starting time.
929
+ - name: results[].item.shippingInfo.logistics.deliveryTimeSlot.to | type: Date | description: Delivery slot ending time.
930
+ - name: results[].item.shippingInfo.logistics.instructions | type: string | description: Instructions for carrier. For example, `"Please knock on the door. If unanswered, please call contact number. Thanks."`.
931
+ - ONE-OF:
932
+ - name: results[].item.shippingInfo.logistics.pickupDetails | type: PickupDetails | description: Pickup details.
933
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address | type: PickupAddress | description: Pickup address.
934
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.addressLine1 | type: string | description: Main address line (usually street name and number).
935
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.addressLine2 | type: string | description: Free text providing more detailed address info. Usually contains apt, suite, floor.
936
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.city | type: string | description: City name.
937
+ - name: results[].item.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.
938
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.countryFullname | type: string | description: Country's full name.
939
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.postalCode | type: string | description: Postal or zip code.
940
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.streetAddress | type: StreetAddress | description: Street address object, with number, name, and apartment number in separate fields.
941
+ - name: results[].item.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.
942
+ - name: results[].item.shippingInfo.logistics.pickupDetails.address.subdivisionFullname | type: string | description: Subdivision full-name.
943
+ - name: results[].item.shippingInfo.logistics.pickupDetails.pickupMethod | type: PickupMethod | description: Pickup method
996
944
  enum: PICKUP_POINT, STORE_PICKUP, UNKNOWN_METHOD
997
- - name: results[].item.shippingInfo.logistics.shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
998
- - name: results[].item.shippingInfo.region | type: ShippingRegion | description: Shipping region.
999
- - name: results[].item.shippingInfo.region.name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
1000
- - name: results[].item.shippingInfo.title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
1001
- - name: results[].item.siteLanguage | type: string | description: Site language in which original values are shown.
1002
- - name: results[].item.status | type: OrderStatus | description: Order status.
1003
- enum:
945
+ - name: results[].item.shippingInfo.logistics.shippingDestination | type: AddressWithContact | description: Shipping address and contact details.
946
+ - name: results[].item.shippingInfo.region | type: ShippingRegion | description: Shipping region.
947
+ - name: results[].item.shippingInfo.region.name | type: string | description: Name of shipping region. For example, `"Metropolitan London"`, or `"Outer Melbourne suburbs"`.
948
+ - name: results[].item.shippingInfo.title | type: string | description: Shipping option title. For example, `"USPS Standard Overnight Delivery"`, `"Standard"` or `"First-Class Package International"`.
949
+ - name: results[].item.siteLanguage | type: string | description: Site language in which original values are shown.
950
+ - name: results[].item.status | type: OrderStatus | description: Order status.
951
+ enum:
1004
952
  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.
1005
953
  CANCELED: Order canceled by the user.
1006
954
  INITIALIZED: Order created, but not yet approved or canceled.
1007
955
  PENDING: Order pending.
1008
956
  REJECTED: Order rejected. This happens when pending payments fail.
1009
- - name: results[].item.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.
1010
- - name: results[].item.tags.privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
1011
- - name: results[].item.tags.privateTags.tagIds | type: Array<string> | description: List of tag GUIDs
1012
- - name: results[].item.tags.tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
1013
- - name: results[].item.taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
1014
- - name: results[].item.taxInfo | type: OrderTaxInfo | description: Tax information.
1015
- - name: results[].item.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.
1016
- - name: results[].item.taxInfo.taxBreakdown[].aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
1017
- - name: results[].item.taxInfo.taxBreakdown[].jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
1018
- - name: results[].item.taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
1019
- - name: results[].item.taxInfo.taxBreakdown[].rate | type: string | description: The rate at which this tax detail was calculated.
1020
- - name: results[].item.taxInfo.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated.
1021
- - name: results[].item.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.
1022
- - name: results[].item.taxInfo.taxExempt | type: boolean | description: Whether the order is exempt from tax calculations. Default: `false`
1023
- - name: results[].item.taxInfo.totalTax | type: Price | description: Calculated tax, added from line items.
1024
- - name: results[].item.weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
1025
- enum:
957
+ - name: results[].item.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.
958
+ - name: results[].item.tags.privateTags | type: TagList | description: Tags that require an additional permission in order to access them, normally not given to site members or visitors.
959
+ - name: results[].item.tags.privateTags.tagIds | type: Array<string> | description: List of tag GUIDs
960
+ - name: results[].item.tags.tags | type: TagList | description: Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors.
961
+ - name: results[].item.taxIncludedInPrices | type: boolean | description: Whether tax is included in line item prices.
962
+ - name: results[].item.taxInfo | type: OrderTaxInfo | description: Tax information.
963
+ - name: results[].item.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.
964
+ - name: results[].item.taxInfo.taxBreakdown[].aggregatedTaxAmount | type: Price | description: The sum of all the tax from line items that calculated by the tax identifiers.
965
+ - name: results[].item.taxInfo.taxBreakdown[].jurisdiction | type: string | description: The name of the jurisdiction in which this tax detail applies.
966
+ - name: results[].item.taxInfo.taxBreakdown[].jurisdictionType | type: JurisdictionType | description: The type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special).
967
+ - name: results[].item.taxInfo.taxBreakdown[].rate | type: string | description: The rate at which this tax detail was calculated.
968
+ - name: results[].item.taxInfo.taxBreakdown[].taxName | type: string | description: The name of the tax against which this tax amount was calculated.
969
+ - name: results[].item.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.
970
+ - name: results[].item.taxInfo.taxExempt | type: boolean | description: Whether the order is exempt from tax calculations. Default: `false`
971
+ - name: results[].item.taxInfo.totalTax | type: Price | description: Calculated tax, added from line items.
972
+ - name: results[].item.weightUnit | type: WeightUnit | description: Weight measurement unit - defaults to site's weight unit.
973
+ enum:
1026
974
  KG: Kilograms.
1027
975
  LB: Pounds.
1028
976
  UNSPECIFIED_WEIGHT_UNIT: Weight unit can't be classified due to an error.
1029
- - name: results[].itemMetadata | type: ItemMetadata | description: Item metadata.
1030
- - name: results[].itemMetadata._id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item).
1031
- - name: results[].itemMetadata.error | type: ApplicationError | description: Details about the error in case of failure.
1032
- - name: results[].itemMetadata.error.code | type: string | description: Error code.
1033
- - name: results[].itemMetadata.error.data | type: Record<string, any> | description: Data related to the error.
1034
- - name: results[].itemMetadata.error.description | type: string | description: Description of the error.
1035
- - name: results[].itemMetadata.originalIndex | type: number | description: Index of the item within the request array. Allows for correlation between request and response items.
1036
- - name: results[].itemMetadata.success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated.
977
+ - name: results[].itemMetadata | type: ItemMetadata | description: Item metadata.
978
+ - name: results[].itemMetadata._id | type: string | description: Item GUID. Should always be available, unless it's impossible (for example, when failing to create an item).
979
+ - name: results[].itemMetadata.error | type: ApplicationError | description: Details about the error in case of failure.
980
+ - name: results[].itemMetadata.error.code | type: string | description: Error code.
981
+ - name: results[].itemMetadata.error.data | type: Record<string, any> | description: Data related to the error.
982
+ - name: results[].itemMetadata.error.description | type: string | description: Description of the error.
983
+ - name: results[].itemMetadata.originalIndex | type: number | description: Index of the item within the request array. Allows for correlation between request and response items.
984
+ - name: results[].itemMetadata.success | type: boolean | description: Whether the requested action was successful for this item. When `false`, the `error` field is populated.
1037
985
 
1038
986
  ```
1039
987
  </type_definition>
1040
- </ecom_orders_bulkUpdateOrders>
988
+ </ecom_orders_bulkUpdateOrders>